146 lines
14 KiB
HTML
146 lines
14 KiB
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.3.1"/>
|
|
<title>NetSocket++: NetSocket.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="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">NetSocket++
|
|
 <span id="projectnumber">0.1</span>
|
|
</div>
|
|
<div id="projectbrief">A library designed to simplify working with UNIX sockets in C++, written in OOP methodology.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.3.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="namespaces.html"><span>Namespaces</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 -->
|
|
<!-- 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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</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">NetSocket.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="_net_socket_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="preprocessor">#ifndef _NETSOCKET_H</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor"></span><span class="preprocessor">#define _NETSOCKET_H</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor"></span><span class="preprocessor">#include <sys/socket.h></span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <sys/types.h></span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <arpa/inet.h></span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include <netdb.h></span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <unistd.h></span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <sys/wait.h></span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <signal.h></span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <cerrno></span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <cstring></span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">namespace </span>NetSocketPP {</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"><a class="code" href="namespace_net_socket_p_p.html#a1878dd84aabcae2aa92e6de381150e73"> 26</a></span> <span class="keyword">inline</span> std::string <a class="code" href="namespace_net_socket_p_p.html#a1878dd84aabcae2aa92e6de381150e73" title="A function, that converts table of chars (a C-style string) into std::string.">CStrToString</a>(<span class="keywordtype">char</span>* cstr) {</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> std::string str = <span class="stringliteral">""</span>;</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keywordflow">for</span>(<span class="keywordtype">int</span> i = 0; cstr[i] != <span class="charliteral">'\000'</span>; i++) {</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> str += cstr[i]; </div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> }</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keywordflow">return</span> str;</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> }</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"><a class="code" href="class_net_socket_p_p_1_1_net_socket.html"> 35</a></span> <span class="keyword">class </span><a class="code" href="class_net_socket_p_p_1_1_net_socket.html" title="A class, that represents network connection - socket.">NetSocket</a> {</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">protected</span>:</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="code" href="class_net_socket_p_p_1_1_net_socket.html#aae1d9340cd9bacb68f789a86e4d2fe45"> 37</a></span> <span class="keywordtype">int</span> <a class="code" href="class_net_socket_p_p_1_1_net_socket.html#aae1d9340cd9bacb68f789a86e4d2fe45" title="Socket descriptor.">_descriptor</a>; </div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"><a class="code" href="class_net_socket_p_p_1_1_net_socket.html#a4bbe227dc4bd377397ea684d0d6a501a"> 38</a></span> <span class="keywordtype">int</span> <a class="code" href="class_net_socket_p_p_1_1_net_socket.html#a4bbe227dc4bd377397ea684d0d6a501a" title="Needed for implementation purposes.">_yes</a>; </div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"><a class="code" href="class_net_socket_p_p_1_1_net_socket.html#a3ca9404bfc910697ce6a40afdb2a5d8d"> 39</a></span> <span class="keywordtype">int</span> <a class="code" href="class_net_socket_p_p_1_1_net_socket.html#a3ca9404bfc910697ce6a40afdb2a5d8d" title="Needed for implementation purposes.">_status</a>; </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"><a class="code" href="class_net_socket_p_p_1_1_net_socket.html#a412939af9ba30f042f13621592c59c9f"> 40</a></span> <span class="keywordtype">char</span> <a class="code" href="class_net_socket_p_p_1_1_net_socket.html#a412939af9ba30f042f13621592c59c9f" title="A structure that stores IP address.">_caddr</a>[INET6_ADDRSTRLEN]; </div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"><a class="code" href="class_net_socket_p_p_1_1_net_socket.html#a51849e8e7d23aa11c9b09eb526656ad1"> 41</a></span> addrinfo <a class="code" href="class_net_socket_p_p_1_1_net_socket.html#a51849e8e7d23aa11c9b09eb526656ad1" title="Needed for implementation purposes.">_hints</a>; </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"><a class="code" href="class_net_socket_p_p_1_1_net_socket.html#a000735c5be93aefd3297cd2eb3e55ec0"> 42</a></span> addrinfo *<a class="code" href="class_net_socket_p_p_1_1_net_socket.html#a000735c5be93aefd3297cd2eb3e55ec0" title="Needed for implementation purposes.">_servinfo</a>; </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"><a class="code" href="class_net_socket_p_p_1_1_net_socket.html#aa608f4ab4af1be3c36831f4c0dd386cf"> 43</a></span> sockaddr_storage <a class="code" href="class_net_socket_p_p_1_1_net_socket.html#aa608f4ab4af1be3c36831f4c0dd386cf" title="Needed for implementation purposes.">_their_addr</a>; </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"><a class="code" href="class_net_socket_p_p_1_1_net_socket.html#a8a19d20260ef37d1adbb7439a55b2b6a"> 44</a></span> socklen_t <a class="code" href="class_net_socket_p_p_1_1_net_socket.html#a8a19d20260ef37d1adbb7439a55b2b6a" title="Needed for implementation purposes.">_addr_size</a>; </div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"><a class="code" href="class_net_socket_p_p_1_1_net_socket.html#ad22749418d441f69226894af0f8467c5"> 45</a></span> std::string <a class="code" href="class_net_socket_p_p_1_1_net_socket.html#ad22749418d441f69226894af0f8467c5" title="A host to which a socket is connecting to/on which a server socket is opened.">_host</a>; </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"><a class="code" href="class_net_socket_p_p_1_1_net_socket.html#a2db5c2f404edb3282384529e19ebe173"> 46</a></span> std::string <a class="code" href="class_net_socket_p_p_1_1_net_socket.html#a2db5c2f404edb3282384529e19ebe173" title="A port or a string identyfing service that socket is connecting to/which server is being opened...">_service</a>; </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"><a class="code" href="class_net_socket_p_p_1_1_net_socket.html#a69be87c77c9cdd187ec59e071cbbd431"> 47</a></span> std::string <a class="code" href="class_net_socket_p_p_1_1_net_socket.html#a69be87c77c9cdd187ec59e071cbbd431" title="A protocol of the socket: TCP/UDP.">_protocol</a>; </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keywordtype">void</span> *<a class="code" href="class_net_socket_p_p_1_1_net_socket.html#a240ac4d2e384549b5757a79d0e2146bf" title="Needed for implementation purposes.">get_in_addr</a>(sockaddr* sa); </div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="class_net_socket_p_p_1_1_net_socket.html#abae69a67be7881bbb2fdf605fdd145e5" title="A constructor with parameters, that creates a socket.">NetSocket</a>(std::string host, std::string service, std::string protocol); </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> </div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  std::string <a class="code" href="class_net_socket_p_p_1_1_net_socket.html#a3e44de8e02caba69d0763bf7e42c9972" title="A function that returns IP of a host.">getIP</a>(); </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">int</span> <a class="code" href="class_net_socket_p_p_1_1_net_socket.html#a932cf37dd25b45aeb9d07439f3fae5a5" title="A function that returns socket descriptor.">getDesc</a>(); </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="class_net_socket_p_p_1_1_net_socket.html#a3ebe4e1d8db6978255f48e1034d638a4" title="A destructor, that frees the memory.">~NetSocket</a>(); </div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> }; </div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> }</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Wed Feb 27 2013 00:04:34 for NetSocket++ by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.3.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|