diff options
Diffstat (limited to 'Doc/doxygen/html/_net_sock_8h_source.html')
| -rw-r--r-- | Doc/doxygen/html/_net_sock_8h_source.html | 190 |
1 files changed, 190 insertions, 0 deletions
diff --git a/Doc/doxygen/html/_net_sock_8h_source.html b/Doc/doxygen/html/_net_sock_8h_source.html new file mode 100644 index 0000000..63f750b --- /dev/null +++ b/Doc/doxygen/html/_net_sock_8h_source.html @@ -0,0 +1,190 @@ +<!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"/> +<title>Starshatter_Open: D:/SRC/StarshatterSVN/NetEx/NetSock.h Source File</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); +</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">Starshatter_Open + </div> + <div id="projectbrief">Open source Starshatter engine</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.1 --> +<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="annotated.html"><span>Classes</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>File Members</span></a></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> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('_net_sock_8h.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: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>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</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="headertitle"> +<div class="title">NetSock.h</div> </div> +</div><!--header--> +<div class="contents"> +<a href="_net_sock_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* Project nGenEx</span></div> +<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> Destroyer Studios LLC</span></div> +<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> Copyright © 1997-2004. All Rights Reserved.</span></div> +<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span></div> +<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> SUBSYSTEM: NetEx.lib</span></div> +<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> FILE: NetSock.h</span></div> +<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> AUTHOR: John DiCamillo</span></div> +<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"></span></div> +<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span></div> +<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> OVERVIEW</span></div> +<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> ========</span></div> +<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> Network (IP) Socket</span></div> +<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">*/</span></div> +<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div> +<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#ifndef NetSock_h</span></div> +<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor"></span><span class="preprocessor">#define NetSock_h</span></div> +<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor"></span></div> +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <windows.h></span></div> +<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "<a class="code" href="_net_addr_8h.html">NetAddr.h</a>"</span></div> +<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "<a class="code" href="_text_8h.html">Text.h</a>"</span></div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div> +<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// +-------------------------------------------------------------------+</span></div> +<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div> +<div class="line"><a name="l00024"></a><span class="lineno"><a class="code" href="_net_sock_8h.html#af8b4aca75d6469f2a99d2442ec29680a"> 24</a></span> <span class="preprocessor">#define NET_MAX_TIMEOUT 1e9</span></div> +<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span></div> +<div class="line"><a name="l00026"></a><span class="lineno"><a class="code" href="class_net_sock.html"> 26</a></span> <span class="keyword">class </span><a class="code" href="class_net_sock.html">NetSock</a></div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> {</div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">public</span>:</div> +<div class="line"><a name="l00029"></a><span class="lineno"><a class="code" href="class_net_sock.html#a99cc7c8b7e015edf20bf1defaab8f667"> 29</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="class_net_sock.html#a99cc7c8b7e015edf20bf1defaab8f667">TYPENAME</a>() { <span class="keywordflow">return</span> <span class="stringliteral">"NetSock"</span>; }</div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div> +<div class="line"><a name="l00031"></a><span class="lineno"><a class="code" href="class_net_sock.html#a70fc60483e62e35e8de2454e5c784e94"> 31</a></span>  <span class="keyword">enum</span> <a class="code" href="class_net_sock.html#a70fc60483e62e35e8de2454e5c784e94">SELECT_TYPE</a> {</div> +<div class="line"><a name="l00032"></a><span class="lineno"><a class="code" href="class_net_sock.html#a70fc60483e62e35e8de2454e5c784e94adf2d4ad8c99b3c5cf7ef3f51831abae6"> 32</a></span>  <a class="code" href="class_net_sock.html#a70fc60483e62e35e8de2454e5c784e94adf2d4ad8c99b3c5cf7ef3f51831abae6">SELECT_READ</a> = 1,</div> +<div class="line"><a name="l00033"></a><span class="lineno"><a class="code" href="class_net_sock.html#a70fc60483e62e35e8de2454e5c784e94ad87f007fc5c613b359329218ed720c9c"> 33</a></span>  <a class="code" href="class_net_sock.html#a70fc60483e62e35e8de2454e5c784e94ad87f007fc5c613b359329218ed720c9c">SELECT_WRITE</a> = 2</div> +<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  };</div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <a class="code" href="class_net_sock.html#a3d9d58ef333d84cf0d7a4309ad7d06d7">NetSock</a>(<span class="keywordtype">bool</span> stream=<span class="keyword">false</span>);</div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <a class="code" href="class_net_sock.html#a3d9d58ef333d84cf0d7a4309ad7d06d7">NetSock</a>(<span class="keyword">const</span> <a class="code" href="class_net_addr.html">NetAddr</a>& addr, <span class="keywordtype">bool</span> stream=<span class="keyword">false</span>);</div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="class_net_sock.html#a1b22f121608028b31157e8c97cf588ef">~NetSock</a>();</div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">int</span> <a class="code" href="class_net_sock.html#a8d495768f9be5c8441b919550be04a9f">bind</a>(<span class="keyword">const</span> <a class="code" href="class_net_addr.html">NetAddr</a>& addr);</div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">int</span> <a class="code" href="class_net_sock.html#aa2dae8534377020bb89509c9eff5cf65">connect</a>(<span class="keyword">const</span> <a class="code" href="class_net_addr.html">NetAddr</a>& addr);</div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">int</span> <a class="code" href="class_net_sock.html#a04eb7961647c09f52faac33660dbf31c">listen</a>(<span class="keywordtype">int</span> max_connections=5);</div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="class_net_sock.html">NetSock</a>* <a class="code" href="class_net_sock.html#ad6afb507802fc004df911e88b9cd9968">accept</a>(<a class="code" href="class_net_addr.html">NetAddr</a>* addr=0);</div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordtype">int</span> <a class="code" href="class_net_sock.html#a56e6a5933a3320aba9ff145e1c7a18cf">available</a>();</div> +<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordtype">int</span> <a class="code" href="class_net_sock.html#a96395c1ea5052e58626b3dd2dcf7e5a9">send</a>(<a class="code" href="class_text.html">Text</a> msg);</div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="class_text.html">Text</a> <a class="code" href="class_net_sock.html#a694d78850eeea856e71a6472ac4610c0">recv</a>();</div> +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">int</span> <a class="code" href="class_net_sock.html#a0fe46d79c00ced2b4c5647102a0efe6b">sendto</a>(<a class="code" href="class_text.html">Text</a> msg, <span class="keyword">const</span> <a class="code" href="class_net_addr.html">NetAddr</a>& dest);</div> +<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="class_text.html">Text</a> <a class="code" href="class_net_sock.html#abcb105e2a8b1f2919bb0ef026ccb8252">recvfrom</a>(<a class="code" href="class_net_addr.html">NetAddr</a>* a=0);</div> +<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">int</span> <a class="code" href="class_net_sock.html#a958e61f364111c518ef11dff87d8dc4a">select</a>(<a class="code" href="class_net_sock.html#a70fc60483e62e35e8de2454e5c784e94">SELECT_TYPE</a> t=<a class="code" href="class_net_sock.html#a70fc60483e62e35e8de2454e5c784e94adf2d4ad8c99b3c5cf7ef3f51831abae6">SELECT_READ</a>,</div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">long</span> seconds=0, <span class="keywordtype">long</span> microseconds=0);</div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div> +<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">int</span> <a class="code" href="class_net_sock.html#ade92b7c993acd58f0aae7d379ab51d7e">shutdown_input</a>();</div> +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">int</span> <a class="code" href="class_net_sock.html#ac9a2c1d53c9faf63fe326fe6b652702a">shutdown_output</a>();</div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">int</span> <a class="code" href="class_net_sock.html#af395a5ee4e64562a1cb8538b90f1804a">set_timeout</a>(<span class="keywordtype">int</span> msecs);</div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">int</span> <a class="code" href="class_net_sock.html#a1549467d08acae07694e71aecbb36b19">close</a>();</div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  DWORD <a class="code" href="class_net_sock.html#a54f06ea06d55b0884e146d33d5e6e115">max_packet_size</a>() <span class="keyword">const</span>;</div> +<div class="line"><a name="l00058"></a><span class="lineno"><a class="code" href="class_net_sock.html#a9803ec8e159719cf11b9e3c87e7ec753"> 58</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_net_sock.html#a9803ec8e159719cf11b9e3c87e7ec753">is_stream</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> stream; }</div> +<div class="line"><a name="l00059"></a><span class="lineno"><a class="code" href="class_net_sock.html#abf9bb0055afc739a8c7449ff60d6551a"> 59</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_net_sock.html#abf9bb0055afc739a8c7449ff60d6551a">is_closed</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> closed; }</div> +<div class="line"><a name="l00060"></a><span class="lineno"><a class="code" href="class_net_sock.html#ad7bc5351ba926386e48c92d15fd90693"> 60</a></span>  <span class="keywordtype">int</span> <a class="code" href="class_net_sock.html#ad7bc5351ba926386e48c92d15fd90693">status</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> stat; }</div> +<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div> +<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="keyword">private</span>:</div> +<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="class_net_sock.html#a3d9d58ef333d84cf0d7a4309ad7d06d7">NetSock</a>(SOCKET s, <span class="keywordtype">bool</span> stream);</div> +<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div> +<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  SOCKET s;</div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">bool</span> stream;</div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">bool</span> closed;</div> +<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">int</span> stat;</div> +<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">int</span> current_timeout;</div> +<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> };</div> +<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div> +<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div> +<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor">#endif NetSock_h</span></div> +</div><!-- fragment --></div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="dir_abfa74b17cedb79c09123abbf53b6754.html">NetEx</a></li><li class="navelem"><a class="el" href="_net_sock_8h.html">NetSock.h</a></li> + <li class="footer">Generated on Tue Jun 5 2012 20:46:18 for Starshatter_Open by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1 </li> + </ul> +</div> +</body> +</html> |