git-svn-id: svn://10.65.10.50/branches/R_10_00@23289 c028cbd2-c16b-5b4b-a496-9718f37d4682
		
			
				
	
	
		
			838 lines
		
	
	
		
			22 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			838 lines
		
	
	
		
			22 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
 | 
						|
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
 | 
						|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
 | 
						|
<head>
 | 
						|
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
 | 
						|
<meta name="generator" content="AsciiDoc 8.6.3" />
 | 
						|
<title>zmq_ctx_socket_monitor(3)</title>
 | 
						|
<style type="text/css">
 | 
						|
/* Sans-serif font. */
 | 
						|
h1, h2, h3, h4, h5, h6,
 | 
						|
div.title, caption.title,
 | 
						|
thead, p.table.header,
 | 
						|
div#toctitle,
 | 
						|
span#author, span#revnumber, span#revdate, span#revremark,
 | 
						|
div#footer {
 | 
						|
  font-family: Arial,Helvetica,sans-serif;
 | 
						|
}
 | 
						|
 | 
						|
/* Serif font. */
 | 
						|
div.sectionbody {
 | 
						|
  font-family: Georgia,"Times New Roman",Times,serif;
 | 
						|
}
 | 
						|
 | 
						|
/* Monospace font. */
 | 
						|
tt {
 | 
						|
  font-size: inherit;
 | 
						|
}
 | 
						|
 | 
						|
body {
 | 
						|
  margin: 1em 5% 1em 5%;
 | 
						|
}
 | 
						|
 | 
						|
a {
 | 
						|
  color: blue;
 | 
						|
  text-decoration: underline;
 | 
						|
}
 | 
						|
a:visited {
 | 
						|
  color: fuchsia;
 | 
						|
}
 | 
						|
 | 
						|
em {
 | 
						|
  font-style: italic;
 | 
						|
  color: navy;
 | 
						|
}
 | 
						|
 | 
						|
strong {
 | 
						|
  font-weight: bold;
 | 
						|
  color: #083194;
 | 
						|
}
 | 
						|
 | 
						|
tt {
 | 
						|
  font-size: inherit;
 | 
						|
  color: navy;
 | 
						|
}
 | 
						|
 | 
						|
h1, h2, h3, h4, h5, h6 {
 | 
						|
  color: #527bbd;
 | 
						|
  margin-top: 1.2em;
 | 
						|
  margin-bottom: 0.5em;
 | 
						|
  line-height: 1.3;
 | 
						|
}
 | 
						|
 | 
						|
h1, h2, h3 {
 | 
						|
  border-bottom: 2px solid silver;
 | 
						|
}
 | 
						|
h2 {
 | 
						|
  padding-top: 0.5em;
 | 
						|
}
 | 
						|
h3 {
 | 
						|
  float: left;
 | 
						|
}
 | 
						|
h3 + * {
 | 
						|
  clear: left;
 | 
						|
}
 | 
						|
 | 
						|
div.sectionbody {
 | 
						|
  margin-left: 0;
 | 
						|
}
 | 
						|
 | 
						|
hr {
 | 
						|
  border: 1px solid silver;
 | 
						|
}
 | 
						|
 | 
						|
p {
 | 
						|
  margin-top: 0.5em;
 | 
						|
  margin-bottom: 0.5em;
 | 
						|
}
 | 
						|
 | 
						|
ul, ol, li > p {
 | 
						|
  margin-top: 0;
 | 
						|
}
 | 
						|
ul > li     { color: #aaa; }
 | 
						|
ul > li > * { color: black; }
 | 
						|
 | 
						|
pre {
 | 
						|
  padding: 0;
 | 
						|
  margin: 0;
 | 
						|
}
 | 
						|
 | 
						|
span#author {
 | 
						|
  color: #527bbd;
 | 
						|
  font-weight: bold;
 | 
						|
  font-size: 1.1em;
 | 
						|
}
 | 
						|
span#email {
 | 
						|
}
 | 
						|
span#revnumber, span#revdate, span#revremark {
 | 
						|
}
 | 
						|
 | 
						|
div#footer {
 | 
						|
  font-size: small;
 | 
						|
  border-top: 2px solid silver;
 | 
						|
  padding-top: 0.5em;
 | 
						|
  margin-top: 4.0em;
 | 
						|
}
 | 
						|
div#footer-text {
 | 
						|
  float: left;
 | 
						|
  padding-bottom: 0.5em;
 | 
						|
}
 | 
						|
div#footer-badges {
 | 
						|
  float: right;
 | 
						|
  padding-bottom: 0.5em;
 | 
						|
}
 | 
						|
 | 
						|
div#preamble {
 | 
						|
  margin-top: 1.5em;
 | 
						|
  margin-bottom: 1.5em;
 | 
						|
}
 | 
						|
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 | 
						|
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 | 
						|
div.admonitionblock {
 | 
						|
  margin-top: 1.0em;
 | 
						|
  margin-bottom: 1.5em;
 | 
						|
}
 | 
						|
div.admonitionblock {
 | 
						|
  margin-top: 2.0em;
 | 
						|
  margin-bottom: 2.0em;
 | 
						|
  margin-right: 10%;
 | 
						|
  color: #606060;
 | 
						|
}
 | 
						|
 | 
						|
div.content { /* Block element content. */
 | 
						|
  padding: 0;
 | 
						|
}
 | 
						|
 | 
						|
/* Block element titles. */
 | 
						|
div.title, caption.title {
 | 
						|
  color: #527bbd;
 | 
						|
  font-weight: bold;
 | 
						|
  text-align: left;
 | 
						|
  margin-top: 1.0em;
 | 
						|
  margin-bottom: 0.5em;
 | 
						|
}
 | 
						|
div.title + * {
 | 
						|
  margin-top: 0;
 | 
						|
}
 | 
						|
 | 
						|
td div.title:first-child {
 | 
						|
  margin-top: 0.0em;
 | 
						|
}
 | 
						|
div.content div.title:first-child {
 | 
						|
  margin-top: 0.0em;
 | 
						|
}
 | 
						|
div.content + div.title {
 | 
						|
  margin-top: 0.0em;
 | 
						|
}
 | 
						|
 | 
						|
div.sidebarblock > div.content {
 | 
						|
  background: #ffffee;
 | 
						|
  border: 1px solid #dddddd;
 | 
						|
  border-left: 4px solid #f0f0f0;
 | 
						|
  padding: 0.5em;
 | 
						|
}
 | 
						|
 | 
						|
div.listingblock > div.content {
 | 
						|
  border: 1px solid #dddddd;
 | 
						|
  border-left: 5px solid #f0f0f0;
 | 
						|
  background: #f8f8f8;
 | 
						|
  padding: 0.5em;
 | 
						|
}
 | 
						|
 | 
						|
div.quoteblock, div.verseblock {
 | 
						|
  padding-left: 1.0em;
 | 
						|
  margin-left: 1.0em;
 | 
						|
  margin-right: 10%;
 | 
						|
  border-left: 5px solid #f0f0f0;
 | 
						|
  color: #777777;
 | 
						|
}
 | 
						|
 | 
						|
div.quoteblock > div.attribution {
 | 
						|
  padding-top: 0.5em;
 | 
						|
  text-align: right;
 | 
						|
}
 | 
						|
 | 
						|
div.verseblock > pre.content {
 | 
						|
  font-family: inherit;
 | 
						|
  font-size: inherit;
 | 
						|
}
 | 
						|
div.verseblock > div.attribution {
 | 
						|
  padding-top: 0.75em;
 | 
						|
  text-align: left;
 | 
						|
}
 | 
						|
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 | 
						|
div.verseblock + div.attribution {
 | 
						|
  text-align: left;
 | 
						|
}
 | 
						|
 | 
						|
div.admonitionblock .icon {
 | 
						|
  vertical-align: top;
 | 
						|
  font-size: 1.1em;
 | 
						|
  font-weight: bold;
 | 
						|
  text-decoration: underline;
 | 
						|
  color: #527bbd;
 | 
						|
  padding-right: 0.5em;
 | 
						|
}
 | 
						|
div.admonitionblock td.content {
 | 
						|
  padding-left: 0.5em;
 | 
						|
  border-left: 3px solid #dddddd;
 | 
						|
}
 | 
						|
 | 
						|
div.exampleblock > div.content {
 | 
						|
  border-left: 3px solid #dddddd;
 | 
						|
  padding-left: 0.5em;
 | 
						|
}
 | 
						|
 | 
						|
div.imageblock div.content { padding-left: 0; }
 | 
						|
span.image img { border-style: none; }
 | 
						|
a.image:visited { color: white; }
 | 
						|
 | 
						|
dl {
 | 
						|
  margin-top: 0.8em;
 | 
						|
  margin-bottom: 0.8em;
 | 
						|
}
 | 
						|
dt {
 | 
						|
  margin-top: 0.5em;
 | 
						|
  margin-bottom: 0;
 | 
						|
  font-style: normal;
 | 
						|
  color: navy;
 | 
						|
}
 | 
						|
dd > *:first-child {
 | 
						|
  margin-top: 0.1em;
 | 
						|
}
 | 
						|
 | 
						|
ul, ol {
 | 
						|
    list-style-position: outside;
 | 
						|
}
 | 
						|
ol.arabic {
 | 
						|
  list-style-type: decimal;
 | 
						|
}
 | 
						|
ol.loweralpha {
 | 
						|
  list-style-type: lower-alpha;
 | 
						|
}
 | 
						|
ol.upperalpha {
 | 
						|
  list-style-type: upper-alpha;
 | 
						|
}
 | 
						|
ol.lowerroman {
 | 
						|
  list-style-type: lower-roman;
 | 
						|
}
 | 
						|
ol.upperroman {
 | 
						|
  list-style-type: upper-roman;
 | 
						|
}
 | 
						|
 | 
						|
div.compact ul, div.compact ol,
 | 
						|
div.compact p, div.compact p,
 | 
						|
div.compact div, div.compact div {
 | 
						|
  margin-top: 0.1em;
 | 
						|
  margin-bottom: 0.1em;
 | 
						|
}
 | 
						|
 | 
						|
div.tableblock > table {
 | 
						|
  border: 3px solid #527bbd;
 | 
						|
}
 | 
						|
thead, p.table.header {
 | 
						|
  font-weight: bold;
 | 
						|
  color: #527bbd;
 | 
						|
}
 | 
						|
tfoot {
 | 
						|
  font-weight: bold;
 | 
						|
}
 | 
						|
td > div.verse {
 | 
						|
  white-space: pre;
 | 
						|
}
 | 
						|
p.table {
 | 
						|
  margin-top: 0;
 | 
						|
}
 | 
						|
/* Because the table frame attribute is overriden by CSS in most browsers. */
 | 
						|
div.tableblock > table[frame="void"] {
 | 
						|
  border-style: none;
 | 
						|
}
 | 
						|
div.tableblock > table[frame="hsides"] {
 | 
						|
  border-left-style: none;
 | 
						|
  border-right-style: none;
 | 
						|
}
 | 
						|
div.tableblock > table[frame="vsides"] {
 | 
						|
  border-top-style: none;
 | 
						|
  border-bottom-style: none;
 | 
						|
}
 | 
						|
 | 
						|
 | 
						|
div.hdlist {
 | 
						|
  margin-top: 0.8em;
 | 
						|
  margin-bottom: 0.8em;
 | 
						|
}
 | 
						|
div.hdlist tr {
 | 
						|
  padding-bottom: 15px;
 | 
						|
}
 | 
						|
dt.hdlist1.strong, td.hdlist1.strong {
 | 
						|
  font-weight: bold;
 | 
						|
}
 | 
						|
td.hdlist1 {
 | 
						|
  vertical-align: top;
 | 
						|
  font-style: normal;
 | 
						|
  padding-right: 0.8em;
 | 
						|
  color: navy;
 | 
						|
}
 | 
						|
td.hdlist2 {
 | 
						|
  vertical-align: top;
 | 
						|
}
 | 
						|
div.hdlist.compact tr {
 | 
						|
  margin: 0;
 | 
						|
  padding-bottom: 0;
 | 
						|
}
 | 
						|
 | 
						|
.comment {
 | 
						|
  background: yellow;
 | 
						|
}
 | 
						|
 | 
						|
.footnote, .footnoteref {
 | 
						|
  font-size: 0.8em;
 | 
						|
}
 | 
						|
 | 
						|
span.footnote, span.footnoteref {
 | 
						|
  vertical-align: super;
 | 
						|
}
 | 
						|
 | 
						|
#footnotes {
 | 
						|
  margin: 20px 0 20px 0;
 | 
						|
  padding: 7px 0 0 0;
 | 
						|
}
 | 
						|
 | 
						|
#footnotes div.footnote {
 | 
						|
  margin: 0 0 5px 0;
 | 
						|
}
 | 
						|
 | 
						|
#footnotes hr {
 | 
						|
  border: none;
 | 
						|
  border-top: 1px solid silver;
 | 
						|
  height: 1px;
 | 
						|
  text-align: left;
 | 
						|
  margin-left: 0;
 | 
						|
  width: 20%;
 | 
						|
  min-width: 100px;
 | 
						|
}
 | 
						|
 | 
						|
div.colist td {
 | 
						|
  padding-right: 0.5em;
 | 
						|
  padding-bottom: 0.3em;
 | 
						|
  vertical-align: top;
 | 
						|
}
 | 
						|
div.colist td img {
 | 
						|
  margin-top: 0.3em;
 | 
						|
}
 | 
						|
 | 
						|
@media print {
 | 
						|
  div#footer-badges { display: none; }
 | 
						|
}
 | 
						|
 | 
						|
div#toc {
 | 
						|
  margin-bottom: 2.5em;
 | 
						|
}
 | 
						|
 | 
						|
div#toctitle {
 | 
						|
  color: #527bbd;
 | 
						|
  font-size: 1.1em;
 | 
						|
  font-weight: bold;
 | 
						|
  margin-top: 1.0em;
 | 
						|
  margin-bottom: 0.1em;
 | 
						|
}
 | 
						|
 | 
						|
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 | 
						|
  margin-top: 0;
 | 
						|
  margin-bottom: 0;
 | 
						|
}
 | 
						|
div.toclevel2 {
 | 
						|
  margin-left: 2em;
 | 
						|
  font-size: 0.9em;
 | 
						|
}
 | 
						|
div.toclevel3 {
 | 
						|
  margin-left: 4em;
 | 
						|
  font-size: 0.9em;
 | 
						|
}
 | 
						|
div.toclevel4 {
 | 
						|
  margin-left: 6em;
 | 
						|
  font-size: 0.9em;
 | 
						|
}
 | 
						|
 | 
						|
/* Overrides for manpage documents */
 | 
						|
h1 {
 | 
						|
  padding-top: 0.5em;
 | 
						|
  padding-bottom: 0.5em;
 | 
						|
  border-top: 2px solid silver;
 | 
						|
  border-bottom: 2px solid silver;
 | 
						|
}
 | 
						|
h2 {
 | 
						|
  border-style: none;
 | 
						|
}
 | 
						|
div.sectionbody {
 | 
						|
  margin-left: 5%;
 | 
						|
}
 | 
						|
 | 
						|
@media print {
 | 
						|
  div#toc { display: none; }
 | 
						|
}
 | 
						|
 | 
						|
</style>
 | 
						|
<script type="text/javascript">
 | 
						|
/*<+'])');
 | 
						|
    // Function that scans the DOM tree for header elements (the DOM2
 | 
						|
    // nodeIterator API would be a better technique but not supported by all
 | 
						|
    // browsers).
 | 
						|
    var iterate = function (el) {
 | 
						|
      for (var i = el.firstChild; i != null; i = i.nextSibling) {
 | 
						|
        if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
 | 
						|
          var mo = re.exec(i.tagName);
 | 
						|
          if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
 | 
						|
            result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
 | 
						|
          }
 | 
						|
          iterate(i);
 | 
						|
        }
 | 
						|
      }
 | 
						|
    }
 | 
						|
    iterate(el);
 | 
						|
    return result;
 | 
						|
  }
 | 
						|
 | 
						|
  var toc = document.getElementById("toc");
 | 
						|
  var entries = tocEntries(document.getElementById("content"), toclevels);
 | 
						|
  for (var i = 0; i < entries.length; ++i) {
 | 
						|
    var entry = entries[i];
 | 
						|
    if (entry.element.id == "")
 | 
						|
      entry.element.id = "_toc_" + i;
 | 
						|
    var a = document.createElement("a");
 | 
						|
    a.href = "#" + entry.element.id;
 | 
						|
    a.appendChild(document.createTextNode(entry.text));
 | 
						|
    var div = document.createElement("div");
 | 
						|
    div.appendChild(a);
 | 
						|
    div.className = "toclevel" + entry.toclevel;
 | 
						|
    toc.appendChild(div);
 | 
						|
  }
 | 
						|
  if (entries.length == 0)
 | 
						|
    toc.parentNode.removeChild(toc);
 | 
						|
},
 | 
						|
 | 
						|
 | 
						|
/////////////////////////////////////////////////////////////////////
 | 
						|
// Footnotes generator
 | 
						|
/////////////////////////////////////////////////////////////////////
 | 
						|
 | 
						|
/* Based on footnote generation code from:
 | 
						|
 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 | 
						|
 */
 | 
						|
 | 
						|
footnotes: function () {
 | 
						|
  var cont = document.getElementById("content");
 | 
						|
  var noteholder = document.getElementById("footnotes");
 | 
						|
  var spans = cont.getElementsByTagName("span");
 | 
						|
  var refs = {};
 | 
						|
  var n = 0;
 | 
						|
  for (i=0; i<spans.length; i++) {
 | 
						|
    if (spans[i].className == "footnote") {
 | 
						|
      n++;
 | 
						|
      // Use [\s\S] in place of . so multi-line matches work.
 | 
						|
      // Because JavaScript has no s (dotall) regex flag.
 | 
						|
      note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
 | 
						|
      noteholder.innerHTML +=
 | 
						|
        "<div class='footnote' id='_footnote_" + n + "'>" +
 | 
						|
        "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
 | 
						|
        n + "</a>. " + note + "</div>";
 | 
						|
      spans[i].innerHTML =
 | 
						|
        "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
 | 
						|
        "' title='View footnote' class='footnote'>" + n + "</a>]";
 | 
						|
      var id =spans[i].getAttribute("id");
 | 
						|
      if (id != null) refs["#"+id] = n;
 | 
						|
    }
 | 
						|
  }
 | 
						|
  if (n == 0)
 | 
						|
    noteholder.parentNode.removeChild(noteholder);
 | 
						|
  else {
 | 
						|
    // Process footnoterefs.
 | 
						|
    for (i=0; i<spans.length; i++) {
 | 
						|
      if (spans[i].className == "footnoteref") {
 | 
						|
        var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
 | 
						|
        href = href.match(/#.*/)[0];  // Because IE return full URL.
 | 
						|
        n = refs[href];
 | 
						|
        spans[i].innerHTML =
 | 
						|
          "[<a href='#_footnote_" + n +
 | 
						|
          "' title='View footnote' class='footnote'>" + n + "</a>]";
 | 
						|
      }
 | 
						|
    }
 | 
						|
  }
 | 
						|
}
 | 
						|
 | 
						|
}
 | 
						|
/*]]>*/
 | 
						|
</script>
 | 
						|
</head>
 | 
						|
<body class="manpage">
 | 
						|
<div id="header">
 | 
						|
<h1>
 | 
						|
zmq_ctx_socket_monitor(3) Manual Page
 | 
						|
</h1>
 | 
						|
<h2>NAME</h2>
 | 
						|
<div class="sectionbody">
 | 
						|
<p>zmq_socket_monitor -
 | 
						|
   register a monitoring callback
 | 
						|
</p>
 | 
						|
</div>
 | 
						|
</div>
 | 
						|
<div id="content">
 | 
						|
<div class="sect1">
 | 
						|
<h2 id="_synopsis">SYNOPSIS</h2>
 | 
						|
<div class="sectionbody">
 | 
						|
<div class="paragraph"><p><strong>int zmq_socket_monitor (void <em>*socket</em>, char * <em>*addr</em>, int <em>events</em>);</strong></p></div>
 | 
						|
</div>
 | 
						|
</div>
 | 
						|
<div class="sect1">
 | 
						|
<h2 id="_description">DESCRIPTION</h2>
 | 
						|
<div class="sectionbody">
 | 
						|
<div class="paragraph"><p>The <em>zmq_socket_monitor()</em> function shall spawn a <em>PAIR</em> socket that publishes
 | 
						|
socket state changes (events) over the inproc:// transport to a given endpoint.</p></div>
 | 
						|
<div class="paragraph"><p>Messages consist of 2 Frames, the first containing the event-id and the
 | 
						|
associated value. The second frame holds the affected endpoint as string.</p></div>
 | 
						|
<div class="paragraph"><p>The layout of the first Frame is:
 | 
						|
  16 bit event id
 | 
						|
  32 bit event value</p></div>
 | 
						|
<div class="paragraph"><p>event id and value are in the native byte order (for the machine the
 | 
						|
application is running on). There is no padding between the fields.</p></div>
 | 
						|
<div class="paragraph"><p>The event value has to be interpreted in the context of the event id.
 | 
						|
See <em>Supported events</em> below for details.</p></div>
 | 
						|
<div class="listingblock">
 | 
						|
<div class="content">
 | 
						|
<pre><tt>Only connection oriented (tcp and ipc) transports are supported in this initial
 | 
						|
implementation.</tt></pre>
 | 
						|
</div></div>
 | 
						|
</div>
 | 
						|
</div>
 | 
						|
<div class="sect1">
 | 
						|
<h2 id="_supported_events">Supported events</h2>
 | 
						|
<div class="sectionbody">
 | 
						|
<div class="sect2">
 | 
						|
<h3 id="_zmq_event_connected_connection_established">ZMQ_EVENT_CONNECTED: connection established</h3>
 | 
						|
<div class="paragraph"><p>The <em>ZMQ_EVENT_CONNECTED</em> event triggers when a connection has been established
 | 
						|
to a remote peer. This can happen either synchronous or asynchronous.
 | 
						|
Value is the FD of the newly connected socket.</p></div>
 | 
						|
</div>
 | 
						|
<div class="sect2">
 | 
						|
<h3 id="_zmq_event_connect_delayed_synchronous_connect_failed_it_8217_s_being_polled">ZMQ_EVENT_CONNECT_DELAYED: synchronous connect failed, it’s being polled</h3>
 | 
						|
<div class="paragraph"><p>The <em>ZMQ_EVENT_CONNECT_DELAYED</em> event triggers when an immediate connection
 | 
						|
attempt is delayed and its completion is being polled for.
 | 
						|
Value has no meaning.</p></div>
 | 
						|
</div>
 | 
						|
<div class="sect2">
 | 
						|
<h3 id="_zmq_event_connect_retried_asynchronous_connect_reconnection_attempt">ZMQ_EVENT_CONNECT_RETRIED: asynchronous connect / reconnection attempt</h3>
 | 
						|
<div class="paragraph"><p>The <em>ZMQ_EVENT_CONNECT_RETRIED</em> event triggers when a connection attempt
 | 
						|
is being handled by reconnect timer. The reconnect interval’s recomputed
 | 
						|
for each attempt.
 | 
						|
Value is the reconnect interval.</p></div>
 | 
						|
</div>
 | 
						|
<div class="sect2">
 | 
						|
<h3 id="_zmq_event_listening_socket_bound_to_an_address_ready_to_accept_connections">ZMQ_EVENT_LISTENING: socket bound to an address, ready to accept connections</h3>
 | 
						|
<div class="paragraph"><p>The <em>ZMQ_EVENT_LISTENING</em> event triggers when a socket’s successfully bound
 | 
						|
to a an interface.
 | 
						|
Value is the FD of the newly bound socket.</p></div>
 | 
						|
</div>
 | 
						|
<div class="sect2">
 | 
						|
<h3 id="_zmq_event_bind_failed_socket_could_not_bind_to_an_address">ZMQ_EVENT_BIND_FAILED: socket could not bind to an address</h3>
 | 
						|
<div class="paragraph"><p>The <em>ZMQ_EVENT_BIND_FAILED</em> event triggers when a socket could not bind to
 | 
						|
a given interface.
 | 
						|
Value is the errno generated by the bind call.</p></div>
 | 
						|
</div>
 | 
						|
<div class="sect2">
 | 
						|
<h3 id="_zmq_event_accepted_connection_accepted_to_bound_interface">ZMQ_EVENT_ACCEPTED: connection accepted to bound interface</h3>
 | 
						|
<div class="paragraph"><p>The <em>ZMQ_EVENT_ACCEPTED</em> event triggers when a connection from a remote peer
 | 
						|
has been established with a socket’s listen address.
 | 
						|
Value is the FD of the accepted socket.</p></div>
 | 
						|
</div>
 | 
						|
<div class="sect2">
 | 
						|
<h3 id="_zmq_event_accept_failed_could_not_accept_client_connection">ZMQ_EVENT_ACCEPT_FAILED: could not accept client connection</h3>
 | 
						|
<div class="paragraph"><p>The <em>ZMQ_EVENT_ACCEPT_FAILED</em> event triggers when a connection attempt to
 | 
						|
a socket’s bound address fails.
 | 
						|
Value is the errno generated by accept.</p></div>
 | 
						|
</div>
 | 
						|
<div class="sect2">
 | 
						|
<h3 id="_zmq_event_closed_connection_closed">ZMQ_EVENT_CLOSED: connection closed</h3>
 | 
						|
<div class="paragraph"><p>The <em>ZMQ_EVENT_CLOSED</em> event triggers when a connection’s underlying descriptor
 | 
						|
has been closed.
 | 
						|
Value is the former FD of the for the closed socket. FD has been closed already!</p></div>
 | 
						|
</div>
 | 
						|
<div class="sect2">
 | 
						|
<h3 id="_zmq_event_close_failed_connection_couldn_8217_t_be_closed">ZMQ_EVENT_CLOSE_FAILED: connection couldn’t be closed</h3>
 | 
						|
<div class="paragraph"><p>The <em>ZMQ_EVENT_CLOSE_FAILED</em> event triggers when a descriptor could not be
 | 
						|
released back to the OS. Implementation note: ONLY FOR IPC SOCKETS.
 | 
						|
Value is the errno generated by unlink.</p></div>
 | 
						|
</div>
 | 
						|
<div class="sect2">
 | 
						|
<h3 id="_zmq_event_disconnected_broken_session">ZMQ_EVENT_DISCONNECTED: broken session</h3>
 | 
						|
<div class="paragraph"><p>The <em>ZMQ_EVENT_DISCONNECTED</em> event triggers when the stream engine (tcp and ipc
 | 
						|
specific) detects a corrupted / broken session.
 | 
						|
Value is the FD of the socket.</p></div>
 | 
						|
</div>
 | 
						|
</div>
 | 
						|
</div>
 | 
						|
<div class="sect1">
 | 
						|
<h2 id="_return_value">RETURN VALUE</h2>
 | 
						|
<div class="sectionbody">
 | 
						|
<div class="paragraph"><p>The <em>zmq_socket_monitor()</em> function returns a value of 0 or greater if
 | 
						|
successful. Otherwise it returns <tt>-1</tt> and sets <em>errno</em> to one of the values
 | 
						|
defined below.</p></div>
 | 
						|
</div>
 | 
						|
</div>
 | 
						|
<div class="sect1">
 | 
						|
<h2 id="_errors">ERRORS</h2>
 | 
						|
<div class="sectionbody">
 | 
						|
<div class="dlist"><dl>
 | 
						|
<dt class="hdlist1">
 | 
						|
<strong>ETERM</strong>
 | 
						|
</dt>
 | 
						|
<dd>
 | 
						|
<p>
 | 
						|
The ØMQ <em>context</em> associated with the specified <em>socket</em> was terminated.
 | 
						|
</p>
 | 
						|
</dd>
 | 
						|
<dt class="hdlist1">
 | 
						|
<strong>EPROTONOSUPPORT</strong>
 | 
						|
</dt>
 | 
						|
<dd>
 | 
						|
<p>
 | 
						|
The requested <em>transport</em> protocol is not supported. Monitor sockets are
 | 
						|
required to use the inproc:// transport.
 | 
						|
</p>
 | 
						|
</dd>
 | 
						|
<dt class="hdlist1">
 | 
						|
<strong>EINVAL</strong>
 | 
						|
</dt>
 | 
						|
<dd>
 | 
						|
<p>
 | 
						|
The endpoint supplied is invalid.
 | 
						|
</p>
 | 
						|
</dd>
 | 
						|
</dl></div>
 | 
						|
</div>
 | 
						|
</div>
 | 
						|
<div class="sect1">
 | 
						|
<h2 id="_example">EXAMPLE</h2>
 | 
						|
<div class="sectionbody">
 | 
						|
<div class="listingblock">
 | 
						|
<div class="title">Observing a <em>REP</em> socket’s connection state</div>
 | 
						|
<div class="content">
 | 
						|
<pre><tt>#include <stdio.h>
 | 
						|
#include <zmq.h>
 | 
						|
#include <pthread.h>
 | 
						|
#include <string.h>
 | 
						|
#include <assert.h>
 | 
						|
 | 
						|
static int read_msg(void* s, zmq_event_t* event, char* ep)
 | 
						|
{
 | 
						|
    int rc ;
 | 
						|
    zmq_msg_t msg1;  // binary part
 | 
						|
    zmq_msg_init (&msg1);
 | 
						|
    zmq_msg_t msg2;  //  address part
 | 
						|
    zmq_msg_init (&msg2);
 | 
						|
    rc = zmq_msg_recv (&msg1, s, 0);
 | 
						|
    if (rc == -1 && zmq_errno() == ETERM)
 | 
						|
        return 1 ;
 | 
						|
    assert (rc != -1);
 | 
						|
    assert (zmq_msg_more(&msg1) != 0);
 | 
						|
    rc = zmq_msg_recv (&msg2, s, 0);
 | 
						|
    if (rc == -1 && zmq_errno() == ETERM)
 | 
						|
        return 1;
 | 
						|
    assert (rc != -1);
 | 
						|
    assert (zmq_msg_more(&msg2) == 0);
 | 
						|
    // copy binary data to event struct
 | 
						|
    const char* data = (char*)zmq_msg_data(&msg1);
 | 
						|
    memcpy(&(event->event), data, sizeof(event->event));
 | 
						|
    memcpy(&(event->value), data+sizeof(event->event), sizeof(event->value));
 | 
						|
    // copy address part
 | 
						|
    const size_t len = zmq_msg_size(&msg2) ;
 | 
						|
    ep = memcpy(ep, zmq_msg_data(&msg2), len);
 | 
						|
    *(ep + len) = 0 ;
 | 
						|
    return 0 ;
 | 
						|
}
 | 
						|
 | 
						|
// REP socket monitor thread
 | 
						|
static void *rep_socket_monitor (void *ctx)
 | 
						|
{
 | 
						|
    zmq_event_t event;
 | 
						|
    static char addr[1025] ;
 | 
						|
    int rc;
 | 
						|
 | 
						|
    printf("starting monitor...\n");
 | 
						|
 | 
						|
    void *s = zmq_socket (ctx, ZMQ_PAIR);
 | 
						|
    assert (s);
 | 
						|
 | 
						|
    rc = zmq_connect (s, "inproc://monitor.rep");
 | 
						|
    assert (rc == 0);
 | 
						|
    while (!read_msg(s, &event, addr)) {
 | 
						|
        switch (event.event) {
 | 
						|
        case ZMQ_EVENT_LISTENING:
 | 
						|
            printf ("listening socket descriptor %d\n", event.value);
 | 
						|
            printf ("listening socket address %s\n", addr);
 | 
						|
            break;
 | 
						|
        case ZMQ_EVENT_ACCEPTED:
 | 
						|
            printf ("accepted socket descriptor %d\n", event.value);
 | 
						|
            printf ("accepted socket address %s\n", addr);
 | 
						|
            break;
 | 
						|
        case ZMQ_EVENT_CLOSE_FAILED:
 | 
						|
            printf ("socket close failure error code %d\n", event.value);
 | 
						|
            printf ("socket address %s\n", addr);
 | 
						|
            break;
 | 
						|
        case ZMQ_EVENT_CLOSED:
 | 
						|
            printf ("closed socket descriptor %d\n", event.value);
 | 
						|
            printf ("closed socket address %s\n", addr);
 | 
						|
            break;
 | 
						|
        case ZMQ_EVENT_DISCONNECTED:
 | 
						|
            printf ("disconnected socket descriptor %d\n", event.value);
 | 
						|
            printf ("disconnected socket address %s\n", addr);
 | 
						|
            break;
 | 
						|
        }
 | 
						|
    }
 | 
						|
    zmq_close (s);
 | 
						|
    return NULL;
 | 
						|
}
 | 
						|
 | 
						|
 | 
						|
int main()
 | 
						|
{
 | 
						|
    const char* addr = "tcp://127.0.0.1:6666" ;
 | 
						|
    pthread_t thread ;
 | 
						|
 | 
						|
    //  Create the infrastructure
 | 
						|
    void *ctx = zmq_init (1);
 | 
						|
    assert (ctx);
 | 
						|
 | 
						|
    // REP socket
 | 
						|
    void* rep = zmq_socket (ctx, ZMQ_REP);
 | 
						|
    assert (rep);
 | 
						|
 | 
						|
    // REP socket monitor, all events
 | 
						|
    int rc = zmq_socket_monitor (rep, "inproc://monitor.rep", ZMQ_EVENT_ALL);
 | 
						|
    assert (rc == 0);
 | 
						|
    rc = pthread_create (&thread, NULL, rep_socket_monitor, ctx);
 | 
						|
    assert (rc == 0);
 | 
						|
 | 
						|
    rc = zmq_bind (rep, addr);
 | 
						|
    assert (rc == 0);
 | 
						|
 | 
						|
    // Allow some time for event detection
 | 
						|
    zmq_sleep (1);
 | 
						|
 | 
						|
    // Close the REP socket
 | 
						|
    rc = zmq_close (rep);
 | 
						|
    assert (rc == 0);
 | 
						|
 | 
						|
    zmq_term (ctx);
 | 
						|
 | 
						|
    return 0 ;
 | 
						|
}</tt></pre>
 | 
						|
</div></div>
 | 
						|
</div>
 | 
						|
</div>
 | 
						|
<div class="sect1">
 | 
						|
<h2 id="_see_also">SEE ALSO</h2>
 | 
						|
<div class="sectionbody">
 | 
						|
<div class="paragraph"><p><a href="zmq.html">zmq(7)</a></p></div>
 | 
						|
</div>
 | 
						|
</div>
 | 
						|
<div class="sect1">
 | 
						|
<h2 id="_authors">AUTHORS</h2>
 | 
						|
<div class="sectionbody">
 | 
						|
<div class="paragraph"><p>This page was written by the ØMQ community. To make a change please
 | 
						|
read the ØMQ Contribution Policy at <a href="http://www.zeromq.org/docs:contributing">http://www.zeromq.org/docs:contributing</a>.</p></div>
 | 
						|
</div>
 | 
						|
</div>
 | 
						|
</div>
 | 
						|
<div id="footnotes"><hr /></div>
 | 
						|
<div id="footer">
 | 
						|
<div id="footer-text">
 | 
						|
ØMQ 4.0.4<br />
 | 
						|
Last updated 2013-11-13 12:57:50 EST
 | 
						|
</div>
 | 
						|
</div>
 | 
						|
</body>
 | 
						|
</html>
 |