http://git-wip-us.apache.org/repos/asf/qpid-site/blob/fb1899b6/content/releases/qpid-dispatch-0.3/api/group__server__connection.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-dispatch-0.3/api/group__server__connection.html b/content/releases/qpid-dispatch-0.3/api/group__server__connection.html deleted file mode 100644 index edfe872..0000000 --- a/content/releases/qpid-dispatch-0.3/api/group__server__connection.html +++ /dev/null @@ -1,684 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<html xmlns="http://www.w3.org/1999/xhtml";> -<head> -<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> -<meta http-equiv="X-UA-Compatible" content="IE=9"/> -<meta name="generator" content="Doxygen 1.8.6"/> -<title>Qpid Dispatch Library API: Server Connection</title> -<link href="tabs.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="jquery.js"></script> -<script type="text/javascript" src="dynsections.js"></script> -<link href="navtree.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="resize.js"></script> -<script type="text/javascript" src="navtree.js"></script> -<script type="text/javascript"> - $(document).ready(initResizable); - $(window).load(resizeHeight); -</script> -<link href="search/search.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="search/search.js"></script> -<script type="text/javascript"> - $(document).ready(function() { searchBox.OnSelectItem(0); }); -</script> -<link href="doxygen.css" rel="stylesheet" type="text/css" /> -</head> -<body> -<div id="top"><!-- do not remove this div, it is closed by doxygen! --> -<div id="titlearea"> -<table cellspacing="0" cellpadding="0"> - <tbody> - <tr style="height: 56px;"> - <td style="padding-left: 0.5em;"> - <div id="projectname">Qpid Dispatch Library API -  <span id="projectnumber">0.3</span> - </div> - </td> - <td> <div id="MSearchBox" class="MSearchBoxInactive"> - <span class="left"> - <img id="MSearchSelect" src="search/mag_sel.png" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - alt=""/> - <input type="text" id="MSearchField" value="Search" accesskey="S" - onfocus="searchBox.OnSearchFieldFocus(true)" - onblur="searchBox.OnSearchFieldFocus(false)" - onkeyup="searchBox.OnSearchFieldChange(event)"/> - </span><span class="right"> - <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> - </span> - </div> -</td> - </tr> - </tbody> -</table> -</div> -<!-- end header part --> -<!-- Generated by Doxygen 1.8.6 --> -<script type="text/javascript"> -var searchBox = new SearchBox("searchBox", "search",false,'Search'); -</script> -</div><!-- top --> -<div id="side-nav" class="ui-resizable side-nav-resizable"> - <div id="nav-tree"> - <div id="nav-tree-contents"> - <div id="nav-sync" class="sync"></div> - </div> - </div> - <div id="splitbar" style="-moz-user-select:none;" - class="ui-resizable-handle"> - </div> -</div> -<script type="text/javascript"> -$(document).ready(function(){initNavTree('group__server__connection.html','');}); -</script> -<div id="doc-content"> -<!-- window showing the filter options --> -<div id="MSearchSelectWindow" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - onkeydown="return searchBox.OnSearchSelectKey(event)"> -<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:vo id(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div> - -<!-- iframe showing the search results (closed by default) --> -<div id="MSearchResultsWindow"> -<iframe src="javascript:void(0)" frameborder="0" - name="MSearchResults" id="MSearchResults"> -</iframe> -</div> - -<div class="header"> - <div class="summary"> -<a href="#nested-classes">Classes</a> | -<a href="#typedef-members">Typedefs</a> | -<a href="#enum-members">Enumerations</a> | -<a href="#func-members">Functions</a> </div> - <div class="headertitle"> -<div class="title">Server Connection</div> </div> -</div><!--header--> -<div class="contents"> -<table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> -Classes</h2></td></tr> -<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structqd__server__config__t.html">qd_server_config_t</a></td></tr> -<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> -Typedefs</h2></td></tr> -<tr class="memitem:ga85e85e202d9437e86ac36b201f4aeb28"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__server__connection.html#ga85e85e202d9437e86ac36b201f4aeb28">qd_listener_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server__connection.html#ga85e85e202d9437e86ac36b201f4aeb28">qd_listener_t</a></td></tr> -<tr class="separator:ga85e85e202d9437e86ac36b201f4aeb28"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga772722c1885896e352cc6b841be1ffd9"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__server__connection.html#ga772722c1885896e352cc6b841be1ffd9">qd_connector_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server__connection.html#ga772722c1885896e352cc6b841be1ffd9">qd_connector_t</a></td></tr> -<tr class="separator:ga772722c1885896e352cc6b841be1ffd9"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaf96c9049b69572b655812ee8e54ce79e"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__server__connection.html#gaf96c9049b69572b655812ee8e54ce79e">qd_connection_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server__connection.html#gaf96c9049b69572b655812ee8e54ce79e">qd_connection_t</a></td></tr> -<tr class="separator:gaf96c9049b69572b655812ee8e54ce79e"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga4901e4ac2b1118bf486d5fcb7da781aa"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structqd__server__config__t.html">qd_server_config_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server__connection.html#ga4901e4ac2b1118bf486d5fcb7da781aa">qd_server_config_t</a></td></tr> -<tr class="separator:ga4901e4ac2b1118bf486d5fcb7da781aa"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga2dff0f64365e68a27028b224ffa4979d"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server__connection.html#ga2dff0f64365e68a27028b224ffa4979d">qd_conn_handler_cb_t</a> )(void *handler_context, void *conn_context, <a class="el" href="group__server__connection.html#ga8e039613b3caf4b4db9449a95f481bba">qd_conn_event_t</a> event, <a class="el" href="group__server__connection.html#gaf96c9049b69572b655812ee8e54ce79e">qd_connection_t</a> *conn)</td></tr> -<tr class="separator:ga2dff0f64365e68a27028b224ffa4979d"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> -Enumerations</h2></td></tr> -<tr class="memitem:ga8e039613b3caf4b4db9449a95f481bba"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server__connection.html#ga8e039613b3caf4b4db9449a95f481bba">qd_conn_event_t</a> { <a class="el" href="group__server__connection.html#gga8e039613b3caf4b4db9449a95f481bbaa5cad2e9d92ce4df7c303d0a4be4be3af">QD_CONN_EVENT_LISTENER_OPEN</a>, -<a class="el" href="group__server__connection.html#gga8e039613b3caf4b4db9449a95f481bbaa37b15513ced09c37bc7137548eac01f7">QD_CONN_EVENT_CONNECTOR_OPEN</a>, -<a class="el" href="group__server__connection.html#gga8e039613b3caf4b4db9449a95f481bbaa2ca61841629392964041e4f1ddd02104">QD_CONN_EVENT_CLOSE</a>, -<a class="el" href="group__server__connection.html#gga8e039613b3caf4b4db9449a95f481bbaa25769cd843665c1b9200393ae09f523b">QD_CONN_EVENT_PROCESS</a> - }</td></tr> -<tr class="separator:ga8e039613b3caf4b4db9449a95f481bba"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> -Functions</h2></td></tr> -<tr class="memitem:gaea7e342da86722c692bec3aca092b939"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server__connection.html#gaea7e342da86722c692bec3aca092b939">qd_server_set_conn_handler</a> (<a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> *qd, <a class="el" href="group__server__connection.html#ga2dff0f64365e68a27028b224ffa4979d">qd_conn_handler_cb_t</a> conn_handler, void *handler_context)</td></tr> -<tr class="separator:gaea7e342da86722c692bec3aca092b939"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga5d92400b6209102763f75d8d23da5d62"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server__connection.html#ga5d92400b6209102763f75d8d23da5d62">qd_connection_set_context</a> (<a class="el" href="group__server__connection.html#gaf96c9049b69572b655812ee8e54ce79e">qd_connection_t</a> *conn, void *context)</td></tr> -<tr class="separator:ga5d92400b6209102763f75d8d23da5d62"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga107b8dc0204c301305cfc9a7edc51d40"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server__connection.html#ga107b8dc0204c301305cfc9a7edc51d40">qd_connection_get_context</a> (<a class="el" href="group__server__connection.html#gaf96c9049b69572b655812ee8e54ce79e">qd_connection_t</a> *conn)</td></tr> -<tr class="separator:ga107b8dc0204c301305cfc9a7edc51d40"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga0fccc52fd8e44cadaf948f19f4cefdd2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server__connection.html#ga0fccc52fd8e44cadaf948f19f4cefdd2">qd_connection_set_link_context</a> (<a class="el" href="group__server__connection.html#gaf96c9049b69572b655812ee8e54ce79e">qd_connection_t</a> *conn, void *context)</td></tr> -<tr class="separator:ga0fccc52fd8e44cadaf948f19f4cefdd2"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga6f164a770f888593411284d9cae2ad30"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server__connection.html#ga6f164a770f888593411284d9cae2ad30">qd_connection_get_link_context</a> (<a class="el" href="group__server__connection.html#gaf96c9049b69572b655812ee8e54ce79e">qd_connection_t</a> *conn)</td></tr> -<tr class="separator:ga6f164a770f888593411284d9cae2ad30"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaf5b1f2a74c4152c84862f913c9aaece0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server__connection.html#gaf5b1f2a74c4152c84862f913c9aaece0">qd_server_activate</a> (<a class="el" href="group__server__connection.html#gaf96c9049b69572b655812ee8e54ce79e">qd_connection_t</a> *conn)</td></tr> -<tr class="separator:gaf5b1f2a74c4152c84862f913c9aaece0"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaab145ce6eacb1f1820dfaed00823d492"><td class="memItemLeft" align="right" valign="top">pn_connection_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server__connection.html#gaab145ce6eacb1f1820dfaed00823d492">qd_connection_pn</a> (<a class="el" href="group__server__connection.html#gaf96c9049b69572b655812ee8e54ce79e">qd_connection_t</a> *conn)</td></tr> -<tr class="separator:gaab145ce6eacb1f1820dfaed00823d492"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gad472a5ac753c1a1f7dad1df41d2754c3"><td class="memItemLeft" align="right" valign="top">pn_collector_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server__connection.html#gad472a5ac753c1a1f7dad1df41d2754c3">qd_connection_collector</a> (<a class="el" href="group__server__connection.html#gaf96c9049b69572b655812ee8e54ce79e">qd_connection_t</a> *conn)</td></tr> -<tr class="separator:gad472a5ac753c1a1f7dad1df41d2754c3"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga72e73f38f725365c8cac0ef032cb792f"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structqd__server__config__t.html">qd_server_config_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server__connection.html#ga72e73f38f725365c8cac0ef032cb792f">qd_connection_config</a> (const <a class="el" href="group__server__connection.html#gaf96c9049b69572b655812ee8e54ce79e">qd_connection_t</a> *conn)</td></tr> -<tr class="separator:ga72e73f38f725365c8cac0ef032cb792f"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga2b365e77e4f34a24232eb8cf2902e442"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__server__connection.html#ga85e85e202d9437e86ac36b201f4aeb28">qd_listener_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server__connection.html#ga2b365e77e4f34a24232eb8cf2902e442">qd_server_listen</a> (<a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> *qd, const <a class="el" href="structqd__server__config__t.html">qd_server_config_t</a> *config, void *context)</td></tr> -<tr class="separator:ga2b365e77e4f34a24232eb8cf2902e442"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga30b52672d5a3fcd96a75a7647e82cc57"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server__connection.html#ga30b52672d5a3fcd96a75a7647e82cc57">qd_server_listener_free</a> (<a class="el" href="group__server__connection.html#ga85e85e202d9437e86ac36b201f4aeb28">qd_listener_t</a> *li)</td></tr> -<tr class="separator:ga30b52672d5a3fcd96a75a7647e82cc57"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gac8e3406c4fbc0f17cc25fa2cb7a5bd15"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server__connection.html#gac8e3406c4fbc0f17cc25fa2cb7a5bd15">qd_server_listener_close</a> (<a class="el" href="group__server__connection.html#ga85e85e202d9437e86ac36b201f4aeb28">qd_listener_t</a> *li)</td></tr> -<tr class="separator:gac8e3406c4fbc0f17cc25fa2cb7a5bd15"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gad88726ffcecec2cc2125b3160384eea4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__server__connection.html#ga772722c1885896e352cc6b841be1ffd9">qd_connector_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server__connection.html#gad88726ffcecec2cc2125b3160384eea4">qd_server_connect</a> (<a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> *qd, const <a class="el" href="structqd__server__config__t.html">qd_server_config_t</a> *config, void *context)</td></tr> -<tr class="separator:gad88726ffcecec2cc2125b3160384eea4"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gae19f1945ab1df70424ce519e527ca29a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server__connection.html#gae19f1945ab1df70424ce519e527ca29a">qd_server_connector_free</a> (<a class="el" href="group__server__connection.html#ga772722c1885896e352cc6b841be1ffd9">qd_connector_t</a> *ct)</td></tr> -<tr class="separator:gae19f1945ab1df70424ce519e527ca29a"><td class="memSeparator" colspan="2"> </td></tr> -</table> -<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<p>Server AMQP Connection Handling</p> -<p>Handling listeners, connectors, connections and events. </p> -<h2 class="groupheader">Typedef Documentation</h2> -<a class="anchor" id="ga2dff0f64365e68a27028b224ffa4979d"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">typedef int(* qd_conn_handler_cb_t)(void *handler_context, void *conn_context, <a class="el" href="group__server__connection.html#ga8e039613b3caf4b4db9449a95f481bba">qd_conn_event_t</a> event, <a class="el" href="group__server__connection.html#gaf96c9049b69572b655812ee8e54ce79e">qd_connection_t</a> *conn)</td> - </tr> - </table> -</div><div class="memdoc"> -<p>Connection Event Handler</p> -<p>Callback invoked when processing is needed on a proton connection. This callback shall be invoked on one of the server's worker threads. The server guarantees that no two threads shall be allowed to process a single connection concurrently. The implementation of this handler may assume that it has exclusive access to the connection and its subservient components (sessions, links, deliveries, etc.).</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">handler_context</td><td>The handler context supplied in qd_server_set_conn_handler. </td></tr> - <tr><td class="paramname">conn_context</td><td>The handler context supplied in qd_server_{connect,listen}. </td></tr> - <tr><td class="paramname">event</td><td>The event/reason for the invocation of the handler. </td></tr> - <tr><td class="paramname">conn</td><td>The connection that requires processing by the handler. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>A value greater than zero if the handler did any proton processing for the connection. If no work was done, zero is returned. </dd></dl> - -</div> -</div> -<a class="anchor" id="gaf96c9049b69572b655812ee8e54ce79e"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">typedef struct <a class="el" href="group__server__connection.html#gaf96c9049b69572b655812ee8e54ce79e">qd_connection_t</a> <a class="el" href="group__server__connection.html#gaf96c9049b69572b655812ee8e54ce79e">qd_connection_t</a></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Connection objects wrap Proton connection objects. </p> - -</div> -</div> -<a class="anchor" id="ga772722c1885896e352cc6b841be1ffd9"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">typedef struct <a class="el" href="group__server__connection.html#ga772722c1885896e352cc6b841be1ffd9">qd_connector_t</a> <a class="el" href="group__server__connection.html#ga772722c1885896e352cc6b841be1ffd9">qd_connector_t</a></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Connector objects represent the desire to create and maintain an outgoing transport connection. </p> - -</div> -</div> -<a class="anchor" id="ga85e85e202d9437e86ac36b201f4aeb28"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">typedef struct <a class="el" href="group__server__connection.html#ga85e85e202d9437e86ac36b201f4aeb28">qd_listener_t</a> <a class="el" href="group__server__connection.html#ga85e85e202d9437e86ac36b201f4aeb28">qd_listener_t</a></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Listener objects represent the desire to accept incoming transport connections. </p> - -</div> -</div> -<a class="anchor" id="ga4901e4ac2b1118bf486d5fcb7da781aa"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">typedef struct <a class="el" href="structqd__server__config__t.html">qd_server_config_t</a> <a class="el" href="structqd__server__config__t.html">qd_server_config_t</a></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Configuration block for a connector or a listener. </p> - -</div> -</div> -<h2 class="groupheader">Enumeration Type Documentation</h2> -<a class="anchor" id="ga8e039613b3caf4b4db9449a95f481bba"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">enum <a class="el" href="group__server__connection.html#ga8e039613b3caf4b4db9449a95f481bba">qd_conn_event_t</a></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Event type for the connection callback. </p> -<table class="fieldtable"> -<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga8e039613b3caf4b4db9449a95f481bbaa5cad2e9d92ce4df7c303d0a4be4be3af"></a>QD_CONN_EVENT_LISTENER_OPEN</em> </td><td class="fielddoc"> -<p>The connection just opened via a listener (inbound). </p> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="gga8e039613b3caf4b4db9449a95f481bbaa37b15513ced09c37bc7137548eac01f7"></a>QD_CONN_EVENT_CONNECTOR_OPEN</em> </td><td class="fielddoc"> -<p>The connection just opened via a connector (outbound). </p> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="gga8e039613b3caf4b4db9449a95f481bbaa2ca61841629392964041e4f1ddd02104"></a>QD_CONN_EVENT_CLOSE</em> </td><td class="fielddoc"> -<p>The connection was closed at the transport level (not cleanly). </p> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="gga8e039613b3caf4b4db9449a95f481bbaa25769cd843665c1b9200393ae09f523b"></a>QD_CONN_EVENT_PROCESS</em> </td><td class="fielddoc"> -<p>The connection requires processing. </p> -</td></tr> -</table> - -</div> -</div> -<h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="gad472a5ac753c1a1f7dad1df41d2754c3"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">pn_collector_t* qd_connection_collector </td> - <td>(</td> - <td class="paramtype"><a class="el" href="group__server__connection.html#gaf96c9049b69572b655812ee8e54ce79e">qd_connection_t</a> * </td> - <td class="paramname"><em>conn</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Get the event collector for a connection.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">conn</td><td>Connection object supplied in QD_CONN_EVENT_{LISTENER,CONNETOR}_OPEN </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>The pn_collector associated with the connection. </dd></dl> - -</div> -</div> -<a class="anchor" id="ga72e73f38f725365c8cac0ef032cb792f"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">const <a class="el" href="structqd__server__config__t.html">qd_server_config_t</a>* qd_connection_config </td> - <td>(</td> - <td class="paramtype">const <a class="el" href="group__server__connection.html#gaf96c9049b69572b655812ee8e54ce79e">qd_connection_t</a> * </td> - <td class="paramname"><em>conn</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Get the configuration that was used in the setup of this connection.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">conn</td><td>Connection object supplied in QD_CONN_EVENT_{LISTENER,CONNETOR}_OPEN </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>A pointer to the server configuration used in the establishment of this connection. </dd></dl> - -</div> -</div> -<a class="anchor" id="ga107b8dc0204c301305cfc9a7edc51d40"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void* qd_connection_get_context </td> - <td>(</td> - <td class="paramtype"><a class="el" href="group__server__connection.html#gaf96c9049b69572b655812ee8e54ce79e">qd_connection_t</a> * </td> - <td class="paramname"><em>conn</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Get the user context from a connection.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">conn</td><td>Connection object supplied in QD_CONN_EVENT_{LISTENER,CONNETOR}_OPEN </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>The user context stored with the connection. </dd></dl> - -</div> -</div> -<a class="anchor" id="ga6f164a770f888593411284d9cae2ad30"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void* qd_connection_get_link_context </td> - <td>(</td> - <td class="paramtype"><a class="el" href="group__server__connection.html#gaf96c9049b69572b655812ee8e54ce79e">qd_connection_t</a> * </td> - <td class="paramname"><em>conn</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Get the link context from a connection.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">conn</td><td>Connection object supplied in QD_CONN_EVENT_{LISTENER,CONNETOR}_OPEN </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>The link context stored with the connection. </dd></dl> - -</div> -</div> -<a class="anchor" id="gaab145ce6eacb1f1820dfaed00823d492"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">pn_connection_t* qd_connection_pn </td> - <td>(</td> - <td class="paramtype"><a class="el" href="group__server__connection.html#gaf96c9049b69572b655812ee8e54ce79e">qd_connection_t</a> * </td> - <td class="paramname"><em>conn</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Get the wrapped proton-engine connection object.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">conn</td><td>Connection object supplied in QD_CONN_EVENT_{LISTENER,CONNETOR}_OPEN </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>The proton connection object. </dd></dl> - -</div> -</div> -<a class="anchor" id="ga5d92400b6209102763f75d8d23da5d62"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_connection_set_context </td> - <td>(</td> - <td class="paramtype"><a class="el" href="group__server__connection.html#gaf96c9049b69572b655812ee8e54ce79e">qd_connection_t</a> * </td> - <td class="paramname"><em>conn</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">void * </td> - <td class="paramname"><em>context</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Set the user context for a connection.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">conn</td><td>Connection object supplied in QD_CONN_EVENT_{LISTENER,CONNETOR}_OPEN </td></tr> - <tr><td class="paramname">context</td><td>User context to be stored with the connection. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a class="anchor" id="ga0fccc52fd8e44cadaf948f19f4cefdd2"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_connection_set_link_context </td> - <td>(</td> - <td class="paramtype"><a class="el" href="group__server__connection.html#gaf96c9049b69572b655812ee8e54ce79e">qd_connection_t</a> * </td> - <td class="paramname"><em>conn</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">void * </td> - <td class="paramname"><em>context</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Set the link context for a connection.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">conn</td><td>Connection object supplied in QD_CONN_EVENT_{LISTENER,CONNETOR}_OPEN </td></tr> - <tr><td class="paramname">context</td><td>Link context to be stored with the connection. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a class="anchor" id="gaf5b1f2a74c4152c84862f913c9aaece0"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_server_activate </td> - <td>(</td> - <td class="paramtype"><a class="el" href="group__server__connection.html#gaf96c9049b69572b655812ee8e54ce79e">qd_connection_t</a> * </td> - <td class="paramname"><em>conn</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Activate a connection for output.</p> -<p>This function is used to request that the server activate the indicated connection. It is assumed that the connection is one that the caller does not have permission to access (i.e. it may be owned by another thread currently). An activated connection will, when writable, appear in the internal work list and be invoked for processing by a worker thread.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">conn</td><td>The connection over which the application wishes to send data </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a class="anchor" id="gad88726ffcecec2cc2125b3160384eea4"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="group__server__connection.html#ga772722c1885896e352cc6b841be1ffd9">qd_connector_t</a>* qd_server_connect </td> - <td>(</td> - <td class="paramtype"><a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> * </td> - <td class="paramname"><em>qd</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const <a class="el" href="structqd__server__config__t.html">qd_server_config_t</a> * </td> - <td class="paramname"><em>config</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">void * </td> - <td class="paramname"><em>context</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Create a connector for an outgoing connection.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">qd</td><td>The dispatch handle returned by qd_dispatch. </td></tr> - <tr><td class="paramname">config</td><td>Pointer to a configuration block for this connector. This block will be referenced by the server, not copied. The referenced record must remain in-scope for the life of the connector.. </td></tr> - <tr><td class="paramname">context</td><td>User context passed back in the connection handler. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>A pointer to the new connector, or NULL in case of failure. </dd></dl> - -</div> -</div> -<a class="anchor" id="gae19f1945ab1df70424ce519e527ca29a"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_server_connector_free </td> - <td>(</td> - <td class="paramtype"><a class="el" href="group__server__connection.html#ga772722c1885896e352cc6b841be1ffd9">qd_connector_t</a> * </td> - <td class="paramname"><em>ct</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Free the resources associated with a connector.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">ct</td><td>A connector pointer returned by qd_connect. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a class="anchor" id="ga2b365e77e4f34a24232eb8cf2902e442"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="group__server__connection.html#ga85e85e202d9437e86ac36b201f4aeb28">qd_listener_t</a>* qd_server_listen </td> - <td>(</td> - <td class="paramtype"><a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> * </td> - <td class="paramname"><em>qd</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const <a class="el" href="structqd__server__config__t.html">qd_server_config_t</a> * </td> - <td class="paramname"><em>config</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">void * </td> - <td class="paramname"><em>context</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Create a listener for incoming connections.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">qd</td><td>The dispatch handle returned by qd_dispatch. </td></tr> - <tr><td class="paramname">config</td><td>Pointer to a configuration block for this listener. This block will be referenced by the server, not copied. The referenced record must remain in-scope for the life of the listener. </td></tr> - <tr><td class="paramname">context</td><td>User context passed back in the connection handler. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>A pointer to the new listener, or NULL in case of failure. </dd></dl> - -</div> -</div> -<a class="anchor" id="gac8e3406c4fbc0f17cc25fa2cb7a5bd15"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_server_listener_close </td> - <td>(</td> - <td class="paramtype"><a class="el" href="group__server__connection.html#ga85e85e202d9437e86ac36b201f4aeb28">qd_listener_t</a> * </td> - <td class="paramname"><em>li</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Close a listener so it will accept no more connections.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">li</td><td>A listener pointer returned by qd_listen. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a class="anchor" id="ga30b52672d5a3fcd96a75a7647e82cc57"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_server_listener_free </td> - <td>(</td> - <td class="paramtype"><a class="el" href="group__server__connection.html#ga85e85e202d9437e86ac36b201f4aeb28">qd_listener_t</a> * </td> - <td class="paramname"><em>li</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Free the resources associated with a listener.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">li</td><td>A listener pointer returned by qd_listen. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a class="anchor" id="gaea7e342da86722c692bec3aca092b939"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_server_set_conn_handler </td> - <td>(</td> - <td class="paramtype"><a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> * </td> - <td class="paramname"><em>qd</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="group__server__connection.html#ga2dff0f64365e68a27028b224ffa4979d">qd_conn_handler_cb_t</a> </td> - <td class="paramname"><em>conn_handler</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">void * </td> - <td class="paramname"><em>handler_context</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Set the connection event handler callback.</p> -<p>Set the connection handler callback for the server. This callback is mandatory and must be set prior to the invocation of qd_server_run.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">qd</td><td>The dispatch handle returned by qd_dispatch. </td></tr> - <tr><td class="paramname">conn_hander</td><td>The handler for processing connection-related events. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -</div><!-- contents --> -</div><!-- doc-content --> -<!-- start footer part --> -<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> - <ul> - <li class="footer">Generated by - <a href="http://www.doxygen.org/index.html";> - <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> - </ul> -</div> -</body> -</html>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/fb1899b6/content/releases/qpid-dispatch-0.3/api/group__server__connection.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-dispatch-0.3/api/group__server__connection.js b/content/releases/qpid-dispatch-0.3/api/group__server__connection.js deleted file mode 100644 index 6f43362..0000000 --- a/content/releases/qpid-dispatch-0.3/api/group__server__connection.js +++ /dev/null @@ -1,50 +0,0 @@ -var group__server__connection = -[ - [ "qd_server_config_t", "structqd__server__config__t.html", [ - [ "allow_no_sasl", "structqd__server__config__t.html#aa0e7cea7d72ffa66747c11f0e8ea4284", null ], - [ "allow_redirect", "structqd__server__config__t.html#a4ad78634be375e1ae3d4f1d46fe87db8", null ], - [ "host", "structqd__server__config__t.html#a0d6a7f92cdbcfc12c32e7e0a5b14a717", null ], - [ "max_frame_size", "structqd__server__config__t.html#a29e5967718878325184e9b05504a30ba", null ], - [ "port", "structqd__server__config__t.html#a1864e6754c35aacb104683772ae15886", null ], - [ "role", "structqd__server__config__t.html#a9c644c021f0873cb1b625d4dd38cd32f", null ], - [ "sasl_maxssf", "structqd__server__config__t.html#a42ee62f5e475686c953256a89ec86874", null ], - [ "sasl_mechanisms", "structqd__server__config__t.html#a472635940f59c08ffed94ae84fd132d2", null ], - [ "sasl_minssf", "structqd__server__config__t.html#a11ec26cf279f3ab0d63e24a1ed46115a", null ], - [ "sasl_password", "structqd__server__config__t.html#a71206ea5155034117058b290c6ee6a45", null ], - [ "sasl_username", "structqd__server__config__t.html#ac297f12b6f4d83e32811ed4988bf4754", null ], - [ "ssl_allow_unsecured_client", "structqd__server__config__t.html#aefbe71d2d544319249507c7f3a460ae7", null ], - [ "ssl_certificate_file", "structqd__server__config__t.html#ae90080060c778b98e1321284f890d763", null ], - [ "ssl_enabled", "structqd__server__config__t.html#ac0a6a1acaba3942143c55fc11d0e8f0d", null ], - [ "ssl_password", "structqd__server__config__t.html#adb620ebdae33c5147c1277cf7a9ffa33", null ], - [ "ssl_private_key_file", "structqd__server__config__t.html#a9cfd6bc0240a3646fa8e28e5fb9f6227", null ], - [ "ssl_require_peer_authentication", "structqd__server__config__t.html#ab3d8f17f6aee630ac4693275b028c1c6", null ], - [ "ssl_server", "structqd__server__config__t.html#a296e37b46e8bdc62ac9d8bd5d03b0c62", null ], - [ "ssl_trusted_certificate_db", "structqd__server__config__t.html#aeb088a79cf79981c7ada7018e7b49c83", null ], - [ "ssl_trusted_certificates", "structqd__server__config__t.html#ab145985f715f9d0e5f2d2c167aaab613", null ] - ] ], - [ "qd_conn_handler_cb_t", "group__server__connection.html#ga2dff0f64365e68a27028b224ffa4979d", null ], - [ "qd_connection_t", "group__server__connection.html#gaf96c9049b69572b655812ee8e54ce79e", null ], - [ "qd_connector_t", "group__server__connection.html#ga772722c1885896e352cc6b841be1ffd9", null ], - [ "qd_listener_t", "group__server__connection.html#ga85e85e202d9437e86ac36b201f4aeb28", null ], - [ "qd_server_config_t", "group__server__connection.html#ga4901e4ac2b1118bf486d5fcb7da781aa", null ], - [ "qd_conn_event_t", "group__server__connection.html#ga8e039613b3caf4b4db9449a95f481bba", [ - [ "QD_CONN_EVENT_LISTENER_OPEN", "group__server__connection.html#gga8e039613b3caf4b4db9449a95f481bbaa5cad2e9d92ce4df7c303d0a4be4be3af", null ], - [ "QD_CONN_EVENT_CONNECTOR_OPEN", "group__server__connection.html#gga8e039613b3caf4b4db9449a95f481bbaa37b15513ced09c37bc7137548eac01f7", null ], - [ "QD_CONN_EVENT_CLOSE", "group__server__connection.html#gga8e039613b3caf4b4db9449a95f481bbaa2ca61841629392964041e4f1ddd02104", null ], - [ "QD_CONN_EVENT_PROCESS", "group__server__connection.html#gga8e039613b3caf4b4db9449a95f481bbaa25769cd843665c1b9200393ae09f523b", null ] - ] ], - [ "qd_connection_collector", "group__server__connection.html#gad472a5ac753c1a1f7dad1df41d2754c3", null ], - [ "qd_connection_config", "group__server__connection.html#ga72e73f38f725365c8cac0ef032cb792f", null ], - [ "qd_connection_get_context", "group__server__connection.html#ga107b8dc0204c301305cfc9a7edc51d40", null ], - [ "qd_connection_get_link_context", "group__server__connection.html#ga6f164a770f888593411284d9cae2ad30", null ], - [ "qd_connection_pn", "group__server__connection.html#gaab145ce6eacb1f1820dfaed00823d492", null ], - [ "qd_connection_set_context", "group__server__connection.html#ga5d92400b6209102763f75d8d23da5d62", null ], - [ "qd_connection_set_link_context", "group__server__connection.html#ga0fccc52fd8e44cadaf948f19f4cefdd2", null ], - [ "qd_server_activate", "group__server__connection.html#gaf5b1f2a74c4152c84862f913c9aaece0", null ], - [ "qd_server_connect", "group__server__connection.html#gad88726ffcecec2cc2125b3160384eea4", null ], - [ "qd_server_connector_free", "group__server__connection.html#gae19f1945ab1df70424ce519e527ca29a", null ], - [ "qd_server_listen", "group__server__connection.html#ga2b365e77e4f34a24232eb8cf2902e442", null ], - [ "qd_server_listener_close", "group__server__connection.html#gac8e3406c4fbc0f17cc25fa2cb7a5bd15", null ], - [ "qd_server_listener_free", "group__server__connection.html#ga30b52672d5a3fcd96a75a7647e82cc57", null ], - [ "qd_server_set_conn_handler", "group__server__connection.html#gaea7e342da86722c692bec3aca092b939", null ] -]; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/qpid-site/blob/fb1899b6/content/releases/qpid-dispatch-0.3/api/group__server__signal.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-dispatch-0.3/api/group__server__signal.html b/content/releases/qpid-dispatch-0.3/api/group__server__signal.html deleted file mode 100644 index 98296b7..0000000 --- a/content/releases/qpid-dispatch-0.3/api/group__server__signal.html +++ /dev/null @@ -1,222 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<html xmlns="http://www.w3.org/1999/xhtml";> -<head> -<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> -<meta http-equiv="X-UA-Compatible" content="IE=9"/> -<meta name="generator" content="Doxygen 1.8.6"/> -<title>Qpid Dispatch Library API: Server Signal</title> -<link href="tabs.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="jquery.js"></script> -<script type="text/javascript" src="dynsections.js"></script> -<link href="navtree.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="resize.js"></script> -<script type="text/javascript" src="navtree.js"></script> -<script type="text/javascript"> - $(document).ready(initResizable); - $(window).load(resizeHeight); -</script> -<link href="search/search.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="search/search.js"></script> -<script type="text/javascript"> - $(document).ready(function() { searchBox.OnSelectItem(0); }); -</script> -<link href="doxygen.css" rel="stylesheet" type="text/css" /> -</head> -<body> -<div id="top"><!-- do not remove this div, it is closed by doxygen! --> -<div id="titlearea"> -<table cellspacing="0" cellpadding="0"> - <tbody> - <tr style="height: 56px;"> - <td style="padding-left: 0.5em;"> - <div id="projectname">Qpid Dispatch Library API -  <span id="projectnumber">0.3</span> - </div> - </td> - <td> <div id="MSearchBox" class="MSearchBoxInactive"> - <span class="left"> - <img id="MSearchSelect" src="search/mag_sel.png" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - alt=""/> - <input type="text" id="MSearchField" value="Search" accesskey="S" - onfocus="searchBox.OnSearchFieldFocus(true)" - onblur="searchBox.OnSearchFieldFocus(false)" - onkeyup="searchBox.OnSearchFieldChange(event)"/> - </span><span class="right"> - <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> - </span> - </div> -</td> - </tr> - </tbody> -</table> -</div> -<!-- end header part --> -<!-- Generated by Doxygen 1.8.6 --> -<script type="text/javascript"> -var searchBox = new SearchBox("searchBox", "search",false,'Search'); -</script> -</div><!-- top --> -<div id="side-nav" class="ui-resizable side-nav-resizable"> - <div id="nav-tree"> - <div id="nav-tree-contents"> - <div id="nav-sync" class="sync"></div> - </div> - </div> - <div id="splitbar" style="-moz-user-select:none;" - class="ui-resizable-handle"> - </div> -</div> -<script type="text/javascript"> -$(document).ready(function(){initNavTree('group__server__signal.html','');}); -</script> -<div id="doc-content"> -<!-- window showing the filter options --> -<div id="MSearchSelectWindow" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - onkeydown="return searchBox.OnSearchSelectKey(event)"> -<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:vo id(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div> - -<!-- iframe showing the search results (closed by default) --> -<div id="MSearchResultsWindow"> -<iframe src="javascript:void(0)" frameborder="0" - name="MSearchResults" id="MSearchResults"> -</iframe> -</div> - -<div class="header"> - <div class="summary"> -<a href="#typedef-members">Typedefs</a> | -<a href="#func-members">Functions</a> </div> - <div class="headertitle"> -<div class="title">Server Signal</div> </div> -</div><!--header--> -<div class="contents"> -<table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> -Typedefs</h2></td></tr> -<tr class="memitem:ga949fe73a9370b75fff4006171120b7dd"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server__signal.html#ga949fe73a9370b75fff4006171120b7dd">qd_signal_handler_cb_t</a> )(void *context, int signum)</td></tr> -<tr class="separator:ga949fe73a9370b75fff4006171120b7dd"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> -Functions</h2></td></tr> -<tr class="memitem:ga70795e9085df344553018c487e84f900"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server__signal.html#ga70795e9085df344553018c487e84f900">qd_server_set_signal_handler</a> (<a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> *qd, <a class="el" href="group__server__signal.html#ga949fe73a9370b75fff4006171120b7dd">qd_signal_handler_cb_t</a> signal_handler, void *context)</td></tr> -<tr class="separator:ga70795e9085df344553018c487e84f900"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaa008d11aaa43e3f9c8327e8f0483170c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server__signal.html#gaa008d11aaa43e3f9c8327e8f0483170c">qd_server_signal</a> (<a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> *qd, int signum)</td></tr> -<tr class="separator:gaa008d11aaa43e3f9c8327e8f0483170c"><td class="memSeparator" colspan="2"> </td></tr> -</table> -<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<p>Server Signal Handling </p> -<h2 class="groupheader">Typedef Documentation</h2> -<a class="anchor" id="ga949fe73a9370b75fff4006171120b7dd"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">typedef void(* qd_signal_handler_cb_t)(void *context, int signum)</td> - </tr> - </table> -</div><div class="memdoc"> -<p>Signal Handler</p> -<p>Callback for signal handling. This handler will be invoked on one of the worker threads in an orderly fashion. This callback is triggered by a call to qd_server_signal.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>The handler context supplied in qd_server_initialize. </td></tr> - <tr><td class="paramname">signum</td><td>The signal number that was passed into qd_server_signal. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="ga70795e9085df344553018c487e84f900"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_server_set_signal_handler </td> - <td>(</td> - <td class="paramtype"><a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> * </td> - <td class="paramname"><em>qd</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="group__server__signal.html#ga949fe73a9370b75fff4006171120b7dd">qd_signal_handler_cb_t</a> </td> - <td class="paramname"><em>signal_handler</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">void * </td> - <td class="paramname"><em>context</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Set the signal handler for the server. The signal handler is invoked cleanly on a worker thread after a call is made to qd_server_signal. The signal handler is optional and need not be set.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">qd</td><td>The dispatch handle returned by qd_dispatch. </td></tr> - <tr><td class="paramname">signal_handler</td><td>The signal handler called when a registered signal is caught. </td></tr> - <tr><td class="paramname">context</td><td>Opaque context to be passed back in the callback function. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a class="anchor" id="gaa008d11aaa43e3f9c8327e8f0483170c"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_server_signal </td> - <td>(</td> - <td class="paramtype"><a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> * </td> - <td class="paramname"><em>qd</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">int </td> - <td class="paramname"><em>signum</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Schedule the invocation of the Server's signal handler.</p> -<p>This function is safe to call from any context, including an OS signal handler or an Interrupt Service Routine. It schedules the orderly invocation of the Server's signal handler on one of the worker threads.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">qd</td><td>The dispatch handle returned by qd_dispatch. </td></tr> - <tr><td class="paramname">signum</td><td>The signal number... TODO </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -</div><!-- contents --> -</div><!-- doc-content --> -<!-- start footer part --> -<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> - <ul> - <li class="footer">Generated by - <a href="http://www.doxygen.org/index.html";> - <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> - </ul> -</div> -</body> -</html> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/fb1899b6/content/releases/qpid-dispatch-0.3/api/group__server__signal.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-dispatch-0.3/api/group__server__signal.js b/content/releases/qpid-dispatch-0.3/api/group__server__signal.js deleted file mode 100644 index 8723126..0000000 --- a/content/releases/qpid-dispatch-0.3/api/group__server__signal.js +++ /dev/null @@ -1,6 +0,0 @@ -var group__server__signal = -[ - [ "qd_signal_handler_cb_t", "group__server__signal.html#ga949fe73a9370b75fff4006171120b7dd", null ], - [ "qd_server_set_signal_handler", "group__server__signal.html#ga70795e9085df344553018c487e84f900", null ], - [ "qd_server_signal", "group__server__signal.html#gaa008d11aaa43e3f9c8327e8f0483170c", null ] -]; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/qpid-site/blob/fb1899b6/content/releases/qpid-dispatch-0.3/api/group__timer.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-dispatch-0.3/api/group__timer.html b/content/releases/qpid-dispatch-0.3/api/group__timer.html deleted file mode 100644 index 21cc923..0000000 --- a/content/releases/qpid-dispatch-0.3/api/group__timer.html +++ /dev/null @@ -1,285 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<html xmlns="http://www.w3.org/1999/xhtml";> -<head> -<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> -<meta http-equiv="X-UA-Compatible" content="IE=9"/> -<meta name="generator" content="Doxygen 1.8.6"/> -<title>Qpid Dispatch Library API: Timer</title> -<link href="tabs.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="jquery.js"></script> -<script type="text/javascript" src="dynsections.js"></script> -<link href="navtree.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="resize.js"></script> -<script type="text/javascript" src="navtree.js"></script> -<script type="text/javascript"> - $(document).ready(initResizable); - $(window).load(resizeHeight); -</script> -<link href="search/search.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="search/search.js"></script> -<script type="text/javascript"> - $(document).ready(function() { searchBox.OnSelectItem(0); }); -</script> -<link href="doxygen.css" rel="stylesheet" type="text/css" /> -</head> -<body> -<div id="top"><!-- do not remove this div, it is closed by doxygen! --> -<div id="titlearea"> -<table cellspacing="0" cellpadding="0"> - <tbody> - <tr style="height: 56px;"> - <td style="padding-left: 0.5em;"> - <div id="projectname">Qpid Dispatch Library API -  <span id="projectnumber">0.3</span> - </div> - </td> - <td> <div id="MSearchBox" class="MSearchBoxInactive"> - <span class="left"> - <img id="MSearchSelect" src="search/mag_sel.png" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - alt=""/> - <input type="text" id="MSearchField" value="Search" accesskey="S" - onfocus="searchBox.OnSearchFieldFocus(true)" - onblur="searchBox.OnSearchFieldFocus(false)" - onkeyup="searchBox.OnSearchFieldChange(event)"/> - </span><span class="right"> - <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> - </span> - </div> -</td> - </tr> - </tbody> -</table> -</div> -<!-- end header part --> -<!-- Generated by Doxygen 1.8.6 --> -<script type="text/javascript"> -var searchBox = new SearchBox("searchBox", "search",false,'Search'); -</script> -</div><!-- top --> -<div id="side-nav" class="ui-resizable side-nav-resizable"> - <div id="nav-tree"> - <div id="nav-tree-contents"> - <div id="nav-sync" class="sync"></div> - </div> - </div> - <div id="splitbar" style="-moz-user-select:none;" - class="ui-resizable-handle"> - </div> -</div> -<script type="text/javascript"> -$(document).ready(function(){initNavTree('group__timer.html','');}); -</script> -<div id="doc-content"> -<!-- window showing the filter options --> -<div id="MSearchSelectWindow" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - onkeydown="return searchBox.OnSearchSelectKey(event)"> -<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:vo id(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div> - -<!-- iframe showing the search results (closed by default) --> -<div id="MSearchResultsWindow"> -<iframe src="javascript:void(0)" frameborder="0" - name="MSearchResults" id="MSearchResults"> -</iframe> -</div> - -<div class="header"> - <div class="summary"> -<a href="#typedef-members">Typedefs</a> | -<a href="#func-members">Functions</a> </div> - <div class="headertitle"> -<div class="title">Timer</div> </div> -</div><!--header--> -<div class="contents"> -<table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> -Typedefs</h2></td></tr> -<tr class="memitem:ga9ac70b9bc9de2438d1699c130afeaf14"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__timer.html#ga9ac70b9bc9de2438d1699c130afeaf14">qd_timer_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__timer.html#ga9ac70b9bc9de2438d1699c130afeaf14">qd_timer_t</a></td></tr> -<tr class="separator:ga9ac70b9bc9de2438d1699c130afeaf14"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gabd4700f6ea01917bddedebb82666b865"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__timer.html#gabd4700f6ea01917bddedebb82666b865">qd_timer_cb_t</a> )(void *context)</td></tr> -<tr class="separator:gabd4700f6ea01917bddedebb82666b865"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> -Functions</h2></td></tr> -<tr class="memitem:gafc932a031e965b7c135b93d02243de02"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__timer.html#ga9ac70b9bc9de2438d1699c130afeaf14">qd_timer_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__timer.html#gafc932a031e965b7c135b93d02243de02">qd_timer</a> (<a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> *qd, <a class="el" href="group__timer.html#gabd4700f6ea01917bddedebb82666b865">qd_timer_cb_t</a> cb, void *context)</td></tr> -<tr class="separator:gafc932a031e965b7c135b93d02243de02"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga2094a4407fe6eb359f2ee5b272b46526"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__timer.html#ga2094a4407fe6eb359f2ee5b272b46526">qd_timer_free</a> (<a class="el" href="group__timer.html#ga9ac70b9bc9de2438d1699c130afeaf14">qd_timer_t</a> *timer)</td></tr> -<tr class="separator:ga2094a4407fe6eb359f2ee5b272b46526"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga56282961b88368e4490fdb0cfd72bb3d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__timer.html#ga56282961b88368e4490fdb0cfd72bb3d">qd_timer_schedule</a> (<a class="el" href="group__timer.html#ga9ac70b9bc9de2438d1699c130afeaf14">qd_timer_t</a> *timer, long msec)</td></tr> -<tr class="separator:ga56282961b88368e4490fdb0cfd72bb3d"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaf693e217ce24993fe04722237418e393"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__timer.html#gaf693e217ce24993fe04722237418e393">qd_timer_cancel</a> (<a class="el" href="group__timer.html#ga9ac70b9bc9de2438d1699c130afeaf14">qd_timer_t</a> *timer)</td></tr> -<tr class="separator:gaf693e217ce24993fe04722237418e393"><td class="memSeparator" colspan="2"> </td></tr> -</table> -<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<p>Server Timer Functions </p> -<h2 class="groupheader">Typedef Documentation</h2> -<a class="anchor" id="gabd4700f6ea01917bddedebb82666b865"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">typedef void(* qd_timer_cb_t)(void *context)</td> - </tr> - </table> -</div><div class="memdoc"> -<p>Timer Callback</p> -<p>Callback invoked after a timer's interval expires and the timer fires.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>The context supplied in qd_timer </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a class="anchor" id="ga9ac70b9bc9de2438d1699c130afeaf14"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">typedef struct <a class="el" href="group__timer.html#ga9ac70b9bc9de2438d1699c130afeaf14">qd_timer_t</a> <a class="el" href="group__timer.html#ga9ac70b9bc9de2438d1699c130afeaf14">qd_timer_t</a></td> - </tr> - </table> -</div><div class="memdoc"> - -</div> -</div> -<h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="gafc932a031e965b7c135b93d02243de02"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="group__timer.html#ga9ac70b9bc9de2438d1699c130afeaf14">qd_timer_t</a>* qd_timer </td> - <td>(</td> - <td class="paramtype"><a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> * </td> - <td class="paramname"><em>qd</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="group__timer.html#gabd4700f6ea01917bddedebb82666b865">qd_timer_cb_t</a> </td> - <td class="paramname"><em>cb</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">void * </td> - <td class="paramname"><em>context</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Create a new timer object.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">cb</td><td>The callback function to be invoked when the timer expires. </td></tr> - <tr><td class="paramname">context</td><td>An opaque, user-supplied context to be passed into the callback. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>A pointer to the new timer object or NULL if memory is exhausted. </dd></dl> - -</div> -</div> -<a class="anchor" id="gaf693e217ce24993fe04722237418e393"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_timer_cancel </td> - <td>(</td> - <td class="paramtype"><a class="el" href="group__timer.html#ga9ac70b9bc9de2438d1699c130afeaf14">qd_timer_t</a> * </td> - <td class="paramname"><em>timer</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Attempt to cancel a scheduled timer. Since the timer callback can be invoked on any server thread, it is always possible that a last-second cancel attempt may arrive too late to stop the timer from firing (i.e. the cancel is concurrent with the fire callback).</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">timer</td><td>Pointer to the timer object returned by qd_timer. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a class="anchor" id="ga2094a4407fe6eb359f2ee5b272b46526"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_timer_free </td> - <td>(</td> - <td class="paramtype"><a class="el" href="group__timer.html#ga9ac70b9bc9de2438d1699c130afeaf14">qd_timer_t</a> * </td> - <td class="paramname"><em>timer</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Free the resources for a timer object. If the timer was scheduled, it will be canceled prior to freeing. After this function returns, the callback will not be invoked for this timer.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">timer</td><td>Pointer to the timer object returned by qd_timer. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a class="anchor" id="ga56282961b88368e4490fdb0cfd72bb3d"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_timer_schedule </td> - <td>(</td> - <td class="paramtype"><a class="el" href="group__timer.html#ga9ac70b9bc9de2438d1699c130afeaf14">qd_timer_t</a> * </td> - <td class="paramname"><em>timer</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">long </td> - <td class="paramname"><em>msec</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Schedule a timer to fire in the future.</p> -<p>Note that the timer callback will never be invoked synchronously during the execution of qd_timer_schedule. Even if the interval is immediate (0), the callback invocation will be asynchronous and after the return of this function.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">timer</td><td>Pointer to the timer object returned by qd_timer. </td></tr> - <tr><td class="paramname">msec</td><td>The minimum number of milliseconds of delay until the timer fires. If 0 is supplied, the timer will be scheduled to fire immediately. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -</div><!-- contents --> -</div><!-- doc-content --> -<!-- start footer part --> -<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> - <ul> - <li class="footer">Generated by - <a href="http://www.doxygen.org/index.html";> - <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> - </ul> -</div> -</body> -</html> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/fb1899b6/content/releases/qpid-dispatch-0.3/api/group__timer.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-dispatch-0.3/api/group__timer.js b/content/releases/qpid-dispatch-0.3/api/group__timer.js deleted file mode 100644 index 88f6a45..0000000 --- a/content/releases/qpid-dispatch-0.3/api/group__timer.js +++ /dev/null @@ -1,9 +0,0 @@ -var group__timer = -[ - [ "qd_timer_cb_t", "group__timer.html#gabd4700f6ea01917bddedebb82666b865", null ], - [ "qd_timer_t", "group__timer.html#ga9ac70b9bc9de2438d1699c130afeaf14", null ], - [ "qd_timer", "group__timer.html#gafc932a031e965b7c135b93d02243de02", null ], - [ "qd_timer_cancel", "group__timer.html#gaf693e217ce24993fe04722237418e393", null ], - [ "qd_timer_free", "group__timer.html#ga2094a4407fe6eb359f2ee5b272b46526", null ], - [ "qd_timer_schedule", "group__timer.html#ga56282961b88368e4490fdb0cfd72bb3d", null ] -]; \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
