doc/0.9.14/libguac/socket-wsa_8h.html - guacamole-website - Git at Google

 <!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.13"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>libguac: guacamole/socket-wsa.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/searchdata.js"></script>
 <script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">libguac
    &#160;<span id="projectnumber">0.9.14</span>
    </div>
   </td>
  </tr>
  </tbody>
 </table>
 </div>
 <!-- end header part -->
 <!-- Generated by Doxygen 1.8.13 -->
 <script type="text/javascript">
 var searchBox = new SearchBox("searchBox", "search",false,'Search');
 </script>
 <script type="text/javascript" src="menudata.js"></script>
 <script type="text/javascript" src="menu.js"></script>
 <script type="text/javascript">
 $(function() {
   initMenu('',true,false,'search.php','Search');
   $(document).ready(function() { init_search(); });
 });
 </script>
 <div id="main-nav"></div>
 <!-- window showing the filter options -->
 <div id="MSearchSelectWindow"
      onmouseover="return searchBox.OnSearchSelectShow()"
      onmouseout="return searchBox.OnSearchSelectHide()"
      onkeydown="return searchBox.OnSearchSelectKey(event)">
 </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_6bb9fad85c98b48a11165f494b9f53ce.html">guacamole</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">socket-wsa.h File Reference</div>  </div>
 </div><!--header-->
 <div class="contents">

 <p>Provides an implementation of <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole. ">guac_socket</a> specific to the Windows Socket API (aka WSA or "winsock").
 <a href="#details">More...</a></p>

 <p><a href="socket-wsa_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:ac020ae320548582cd76d18baca0ba3be"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structguac__socket.html">guac_socket</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="socket-wsa_8h.html#ac020ae320548582cd76d18baca0ba3be">guac_socket_open_wsa</a> (SOCKET sock)</td></tr>
 <tr class="memdesc:ac020ae320548582cd76d18baca0ba3be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole. ">guac_socket</a> which will use the Windows Socket API (aka WSA or "winsock") for all communication.  <a href="#ac020ae320548582cd76d18baca0ba3be">More...</a><br /></td></tr>
 <tr class="separator:ac020ae320548582cd76d18baca0ba3be"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>Provides an implementation of <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole. ">guac_socket</a> specific to the Windows Socket API (aka WSA or "winsock"). </p>
 <p>This header will only be available if libguac was built with WSA support. </p>
 </div><h2 class="groupheader">Function Documentation</h2>
 <a id="ac020ae320548582cd76d18baca0ba3be"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#ac020ae320548582cd76d18baca0ba3be">&#9670;&nbsp;</a></span>guac_socket_open_wsa()</h2>

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname"><a class="el" href="structguac__socket.html">guac_socket</a>* guac_socket_open_wsa </td>
           <td>(</td>
           <td class="paramtype">SOCKET&#160;</td>
           <td class="paramname"><em>sock</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Creates a new <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole. ">guac_socket</a> which will use the Windows Socket API (aka WSA or "winsock") for all communication. </p>
 <p>Freeing this <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole. ">guac_socket</a> will automatically close the associated SOCKET handle.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">sock</td><td>The WSA SOCKET handle to use for the connection underlying the created <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole. ">guac_socket</a>.</td></tr>
   </table>
   </dd>
 </dl>
 <dl class="section return"><dt>Returns</dt><dd>A newly-allocated <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole. ">guac_socket</a> which will transparently use the Windows Socket API for all communication. </dd></dl>

 </div>
 </div>
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/>
 </a> 1.8.13
 </small></address>
 </body>
 </html>
	<!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.13"/>
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<title>libguac: guacamole/socket-wsa.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/searchdata.js"></script>
	<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;">
	<div id="projectname">libguac
	<span id="projectnumber">0.9.14</span>
	</div>
	</td>
	</tr>
	</tbody>
	</table>
	</div>
	<!-- end header part -->
	<!-- Generated by Doxygen 1.8.13 -->
	<script type="text/javascript">
	var searchBox = new SearchBox("searchBox", "search",false,'Search');
	</script>
	<script type="text/javascript" src="menudata.js"></script>
	<script type="text/javascript" src="menu.js"></script>
	<script type="text/javascript">
	$(function() {
	initMenu('',true,false,'search.php','Search');
	$(document).ready(function() { init_search(); });
	});
	</script>
	<div id="main-nav"></div>
	<!-- window showing the filter options -->
	<div id="MSearchSelectWindow"
	onmouseover="return searchBox.OnSearchSelectShow()"
	onmouseout="return searchBox.OnSearchSelectHide()"
	onkeydown="return searchBox.OnSearchSelectKey(event)">
	</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_6bb9fad85c98b48a11165f494b9f53ce.html">guacamole</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">socket-wsa.h File Reference</div> </div>
	</div><!--header-->
	<div class="contents">

	<p>Provides an implementation of <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole. ">guac_socket</a> specific to the Windows Socket API (aka WSA or "winsock").
	<a href="#details">More...</a></p>

	<p><a href="socket-wsa_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:ac020ae320548582cd76d18baca0ba3be"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structguac__socket.html">guac_socket</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="socket-wsa_8h.html#ac020ae320548582cd76d18baca0ba3be">guac_socket_open_wsa</a> (SOCKET sock)</td></tr>
	<tr class="memdesc:ac020ae320548582cd76d18baca0ba3be"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole. ">guac_socket</a> which will use the Windows Socket API (aka WSA or "winsock") for all communication. <a href="#ac020ae320548582cd76d18baca0ba3be">More...</a><br /></td></tr>
	<tr class="separator:ac020ae320548582cd76d18baca0ba3be"><td class="memSeparator" colspan="2"> </td></tr>
	</table>
	<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
	<div class="textblock"><p>Provides an implementation of <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole. ">guac_socket</a> specific to the Windows Socket API (aka WSA or "winsock"). </p>
	<p>This header will only be available if libguac was built with WSA support. </p>
	</div><h2 class="groupheader">Function Documentation</h2>
	<a id="ac020ae320548582cd76d18baca0ba3be"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#ac020ae320548582cd76d18baca0ba3be">◆ </a></span>guac_socket_open_wsa()</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname"><a class="el" href="structguac__socket.html">guac_socket</a>* guac_socket_open_wsa </td>
	<td>(</td>
	<td class="paramtype">SOCKET </td>
	<td class="paramname"><em>sock</em></td><td>)</td>
	<td></td>
	</tr>
	</table>
	</div><div class="memdoc">

	<p>Creates a new <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole. ">guac_socket</a> which will use the Windows Socket API (aka WSA or "winsock") for all communication. </p>
	<p>Freeing this <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole. ">guac_socket</a> will automatically close the associated SOCKET handle.</p>
	<dl class="params"><dt>Parameters</dt><dd>
	<table class="params">
	<tr><td class="paramname">sock</td><td>The WSA SOCKET handle to use for the connection underlying the created <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole. ">guac_socket</a>.</td></tr>
	</table>
	</dd>
	</dl>
	<dl class="section return"><dt>Returns</dt><dd>A newly-allocated <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole. ">guac_socket</a> which will transparently use the Windows Socket API for all communication. </dd></dl>

	</div>
	</div>
	</div><!-- contents -->
	<!-- start footer part -->
	<hr class="footer"/><address class="footer"><small>
	Generated by  <a href="http://www.doxygen.org/index.html">
	<img class="footer" src="doxygen.png" alt="doxygen"/>
	</a> 1.8.13
	</small></address>
	</body>
	</html>