diff options
| author | Alan Antonuk <alan.antonuk@gmail.com> | 2016-04-09 22:01:19 -0700 |
|---|---|---|
| committer | Alan Antonuk <alan.antonuk@gmail.com> | 2016-04-09 22:01:19 -0700 |
| commit | 31504bffc771c063f42c8af01aa9afd83795529a (patch) | |
| tree | caab3279adeff64d5ac1ac70f2af510a4976932a /docs/0.8.0/amqp__tcp__socket_8h.html | |
| parent | c72a71494caef41985a89eb3df5cf15b4e1e7a63 (diff) | |
| download | rabbitmq-c-gh-pages.tar.gz | |
Add v0.8.0 documentation.gh-pages
Diffstat (limited to 'docs/0.8.0/amqp__tcp__socket_8h.html')
| -rw-r--r-- | docs/0.8.0/amqp__tcp__socket_8h.html | 175 |
1 files changed, 175 insertions, 0 deletions
diff --git a/docs/0.8.0/amqp__tcp__socket_8h.html b/docs/0.8.0/amqp__tcp__socket_8h.html new file mode 100644 index 0000000..2d0fcde --- /dev/null +++ b/docs/0.8.0/amqp__tcp__socket_8h.html @@ -0,0 +1,175 @@ +<!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>rabbitmq-c: amqp_tcp_socket.h File Reference</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="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">rabbitmq-c +  <span id="projectnumber">0.8.0</span> + </div> + <div id="projectbrief">C AMQP Client library for RabbitMQ</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 id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + <li> + <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> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +<!-- 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>Data Structures</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:void(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>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 id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="dir_df8d7e2f392872630f707837372814f7.html">librabbitmq</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">amqp_tcp_socket.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><a href="amqp__tcp__socket_8h_source.html">Go to the source code of this file.</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:a3276c8bfa7b263aa3c755517b4b97ac8"><td class="memItemLeft" align="right" valign="top">amqp_socket_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="amqp__tcp__socket_8h.html#a3276c8bfa7b263aa3c755517b4b97ac8">amqp_tcp_socket_new</a> (<a class="el" href="amqp_8h.html#a59cfdff3bfbf28aba201be5636365fa4">amqp_connection_state_t</a> state)</td></tr> +<tr class="memdesc:a3276c8bfa7b263aa3c755517b4b97ac8"><td class="mdescLeft"> </td><td class="mdescRight">A TCP socket connection. <a href="#a3276c8bfa7b263aa3c755517b4b97ac8">More...</a><br/></td></tr> +<tr class="separator:a3276c8bfa7b263aa3c755517b4b97ac8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac5a44bcd22e8c06a501465ef14d4f111"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="amqp__tcp__socket_8h.html#ac5a44bcd22e8c06a501465ef14d4f111">amqp_tcp_socket_set_sockfd</a> (amqp_socket_t *self, int sockfd)</td></tr> +<tr class="memdesc:ac5a44bcd22e8c06a501465ef14d4f111"><td class="mdescLeft"> </td><td class="mdescRight">Assign an open file descriptor to a socket object. <a href="#ac5a44bcd22e8c06a501465ef14d4f111">More...</a><br/></td></tr> +<tr class="separator:ac5a44bcd22e8c06a501465ef14d4f111"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="a3276c8bfa7b263aa3c755517b4b97ac8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">amqp_socket_t* amqp_tcp_socket_new </td> + <td>(</td> + <td class="paramtype"><a class="el" href="amqp_8h.html#a59cfdff3bfbf28aba201be5636365fa4">amqp_connection_state_t</a> </td> + <td class="paramname"><em>state</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>A TCP socket connection. </p> +<p>Create a new TCP socket.</p> +<p>Call <a class="el" href="amqp_8h.html#abe8a9640fd8363a4d803c59180f2c8a4" title="Closes the entire connection. ">amqp_connection_close()</a> to release socket resources.</p> +<dl class="section return"><dt>Returns</dt><dd>A new socket object or NULL if an error occurred.</dd></dl> +<dl class="section since"><dt>Since</dt><dd>v0.4.0 </dd></dl> + +</div> +</div> +<a class="anchor" id="ac5a44bcd22e8c06a501465ef14d4f111"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void amqp_tcp_socket_set_sockfd </td> + <td>(</td> + <td class="paramtype">amqp_socket_t * </td> + <td class="paramname"><em>self</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>sockfd</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Assign an open file descriptor to a socket object. </p> +<p>This function must not be used in conjunction with <a class="el" href="amqp_8h.html#aaa1a4f870da40120d8c544822bf63f51" title="Open a socket connection. ">amqp_socket_open()</a>, i.e. the socket connection should already be open(2) when this function is called.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in,out]</td><td class="paramname">self</td><td>A TCP socket object. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">sockfd</td><td>An open socket descriptor.</td></tr> + </table> + </dd> +</dl> +<dl class="section since"><dt>Since</dt><dd>v0.4.0 </dd></dl> + +</div> +</div> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Sat Apr 9 2016 21:59:28 for rabbitmq-c by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.6 +</small></address> +</body> +</html> |