Host library for controlling a WiConnect enabled Wi-Fi module.
Dependents: wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more
doc/html/group__types__socket.html
- Committer:
- dan_ackme
- Date:
- 2014-08-12
- Revision:
- 11:ea484e1b7fc4
File content as of revision 11:ea484e1b7fc4:
<!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.7"/> <title>WiConnect Library: Socket API</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">WiConnect Library </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.7 --> <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="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</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><!-- 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__types__socket.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>Namespaces</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>Groups</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 class="header"> <div class="summary"> <a href="#nested-classes">Classes</a> | <a href="#enum-members">Enumerations</a> </div> <div class="headertitle"> <div class="title">Socket API<div class="ingroups"><a class="el" href="group__types.html">Types</a></div></div> </div> </div><!--header--> <div class="contents"> <p>Socket API Types. <a href="#details">More...</a></p> <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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The provides an interface for creating TCP/UDP/TLS/HTTP client sockets. A client socket connects to a remote server. <a href="classwiconnect_1_1_socket_interface.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structwiconnect_1_1_http_socket_args.html">wiconnect::HttpSocketArgs</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Struct for hold HTTP socket configuration. <a href="structwiconnect_1_1_http_socket_args.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_socket.html">wiconnect::Socket</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Connection object to remote server. <a href="classwiconnect_1_1_socket.html#details">More...</a><br /></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="enum-members"></a> Enumerations</h2></td></tr> <tr class="memitem:ga69dc55558df4c81599c5fb3dff98756d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__socket.html#ga69dc55558df4c81599c5fb3dff98756d">wiconnect::SocketType</a> { <br />   <a class="el" href="group__types__socket.html#gga69dc55558df4c81599c5fb3dff98756da6469a1b9d8fa6448c0f6f13e0028a60e">wiconnect::SOCKET_TYPE_UNKNOWN</a>, <a class="el" href="group__types__socket.html#gga69dc55558df4c81599c5fb3dff98756daece967eb28f8913c30bc70fa1e0e5ff9">wiconnect::SOCKET_TYPE_TCP</a>, <a class="el" href="group__types__socket.html#gga69dc55558df4c81599c5fb3dff98756da0c365c200e62d61bf22798c25ccb96b4">wiconnect::SOCKET_TYPE_TLS</a>, <a class="el" href="group__types__socket.html#gga69dc55558df4c81599c5fb3dff98756dab1b41b1c4daf8d171414b68e9033cfbc">wiconnect::SOCKET_TYPE_UDP</a>, <br />   <a class="el" href="group__types__socket.html#gga69dc55558df4c81599c5fb3dff98756da3d433f1b569dc48077861cde0e464751">wiconnect::SOCKET_TYPE_HTTP</a> <br /> }</td></tr> <tr class="memdesc:ga69dc55558df4c81599c5fb3dff98756d"><td class="mdescLeft"> </td><td class="mdescRight">Socket type. <a href="group__types__socket.html#ga69dc55558df4c81599c5fb3dff98756d">More...</a><br /></td></tr> <tr class="separator:ga69dc55558df4c81599c5fb3dff98756d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gadc1d6e26d4138c536bd5dce7ed4569d6"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__socket.html#gadc1d6e26d4138c536bd5dce7ed4569d6">wiconnect::HttpSocketType</a> { <a class="el" href="group__types__socket.html#ggadc1d6e26d4138c536bd5dce7ed4569d6afc257aa28936e9fa8a332995b5449685">wiconnect::SOCKET_HTTP_GET</a>, <a class="el" href="group__types__socket.html#ggadc1d6e26d4138c536bd5dce7ed4569d6ab271a5cd1775076aeb8c25fc14da12cb">wiconnect::SOCKET_HTTP_POST</a>, <a class="el" href="group__types__socket.html#ggadc1d6e26d4138c536bd5dce7ed4569d6a6d256a218aac67dffe66ae6c49a61236">wiconnect::SOCKET_HTTP_HEAD</a> }</td></tr> <tr class="memdesc:gadc1d6e26d4138c536bd5dce7ed4569d6"><td class="mdescLeft"> </td><td class="mdescRight">HTTP Socket sub-type. <a href="group__types__socket.html#gadc1d6e26d4138c536bd5dce7ed4569d6">More...</a><br /></td></tr> <tr class="separator:gadc1d6e26d4138c536bd5dce7ed4569d6"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>Socket API Types. </p> <h2 class="groupheader">Enumeration Type Documentation</h2> <a class="anchor" id="gadc1d6e26d4138c536bd5dce7ed4569d6"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="group__types__socket.html#gadc1d6e26d4138c536bd5dce7ed4569d6">wiconnect::HttpSocketType</a></td> </tr> </table> </div><div class="memdoc"> <p>HTTP <a class="el" href="classwiconnect_1_1_socket.html" title="Connection object to remote server. ">Socket</a> sub-type. </p> <table class="fieldtable"> <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggadc1d6e26d4138c536bd5dce7ed4569d6afc257aa28936e9fa8a332995b5449685"></a>SOCKET_HTTP_GET </td><td class="fielddoc"> <p>HTTP GET Request socket type. </p> </td></tr> <tr><td class="fieldname"><a class="anchor" id="ggadc1d6e26d4138c536bd5dce7ed4569d6ab271a5cd1775076aeb8c25fc14da12cb"></a>SOCKET_HTTP_POST </td><td class="fielddoc"> <p>HTTP POST Request socket type. </p> </td></tr> <tr><td class="fieldname"><a class="anchor" id="ggadc1d6e26d4138c536bd5dce7ed4569d6a6d256a218aac67dffe66ae6c49a61236"></a>SOCKET_HTTP_HEAD </td><td class="fielddoc"> <p>HTTP HEAD Request socket type. </p> </td></tr> </table> </div> </div> <a class="anchor" id="ga69dc55558df4c81599c5fb3dff98756d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="group__types__socket.html#ga69dc55558df4c81599c5fb3dff98756d">wiconnect::SocketType</a></td> </tr> </table> </div><div class="memdoc"> <p><a class="el" href="classwiconnect_1_1_socket.html" title="Connection object to remote server. ">Socket</a> type. </p> <table class="fieldtable"> <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga69dc55558df4c81599c5fb3dff98756da6469a1b9d8fa6448c0f6f13e0028a60e"></a>SOCKET_TYPE_UNKNOWN </td><td class="fielddoc"> <p><a class="el" href="classwiconnect_1_1_socket.html" title="Connection object to remote server. ">Socket</a> type not known. </p> </td></tr> <tr><td class="fieldname"><a class="anchor" id="gga69dc55558df4c81599c5fb3dff98756daece967eb28f8913c30bc70fa1e0e5ff9"></a>SOCKET_TYPE_TCP </td><td class="fielddoc"> <p>TCP <a class="el" href="classwiconnect_1_1_socket.html" title="Connection object to remote server. ">Socket</a> type. </p> </td></tr> <tr><td class="fieldname"><a class="anchor" id="gga69dc55558df4c81599c5fb3dff98756da0c365c200e62d61bf22798c25ccb96b4"></a>SOCKET_TYPE_TLS </td><td class="fielddoc"> <p>TLS <a class="el" href="classwiconnect_1_1_socket.html" title="Connection object to remote server. ">Socket</a> type. </p> </td></tr> <tr><td class="fieldname"><a class="anchor" id="gga69dc55558df4c81599c5fb3dff98756dab1b41b1c4daf8d171414b68e9033cfbc"></a>SOCKET_TYPE_UDP </td><td class="fielddoc"> <p>UDP <a class="el" href="classwiconnect_1_1_socket.html" title="Connection object to remote server. ">Socket</a> type. </p> </td></tr> <tr><td class="fieldname"><a class="anchor" id="gga69dc55558df4c81599c5fb3dff98756da3d433f1b569dc48077861cde0e464751"></a>SOCKET_TYPE_HTTP </td><td class="fielddoc"> <p>HTTP <a class="el" href="classwiconnect_1_1_socket.html" title="Connection object to remote server. ">Socket</a> type. </p> </td></tr> </table> </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 on Tue Aug 12 2014 02:15:23 for WiConnect Library by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li> </ul> </div> </body> </html>