NetSocket--/doxy/html/class_net_socket_p_p_1_1_se...

242 lines
13 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++: NetSocketPP::ServerFunctionArgs Class 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">NetSocket++
&#160;<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&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><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="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_net_socket_p_p.html">NetSocketPP</a></li><li class="navelem"><a class="el" href="class_net_socket_p_p_1_1_server_function_args.html">ServerFunctionArgs</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_net_socket_p_p_1_1_server_function_args-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NetSocketPP::ServerFunctionArgs Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A class for storing server function arguments.
<a href="class_net_socket_p_p_1_1_server_function_args.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_server_socket_8h_source.html">ServerSocket.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a12a15c962ca5f38701e8d3f461623668"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a12a15c962ca5f38701e8d3f461623668"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket_p_p_1_1_server_function_args.html#a12a15c962ca5f38701e8d3f461623668">ServerFunctionArgs</a> ()</td></tr>
<tr class="memdesc:a12a15c962ca5f38701e8d3f461623668"><td class="mdescLeft">&#160;</td><td class="mdescRight">A constructor. <br/></td></tr>
<tr class="separator:a12a15c962ca5f38701e8d3f461623668"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7f9a434d7525e09f9568a3b7fb33d51"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket_p_p_1_1_server_function_args.html#ac7f9a434d7525e09f9568a3b7fb33d51">ServerFunctionArgs</a> (<a class="el" href="class_net_socket_p_p_1_1_server_function_args.html">ServerFunctionArgs</a> &amp;sfa)</td></tr>
<tr class="memdesc:ac7f9a434d7525e09f9568a3b7fb33d51"><td class="mdescLeft">&#160;</td><td class="mdescRight">A copy constructor. <a href="#ac7f9a434d7525e09f9568a3b7fb33d51">More...</a><br/></td></tr>
<tr class="separator:ac7f9a434d7525e09f9568a3b7fb33d51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94b84df8925528f994cff8d5f95b56b3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a94b84df8925528f994cff8d5f95b56b3"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket_p_p_1_1_server_function_args.html#a94b84df8925528f994cff8d5f95b56b3">~ServerFunctionArgs</a> ()</td></tr>
<tr class="memdesc:a94b84df8925528f994cff8d5f95b56b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">A destructor. <br/></td></tr>
<tr class="separator:a94b84df8925528f994cff8d5f95b56b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59fd11d1cef4e1be812da1e2d3399327"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket_p_p_1_1_server_function_args.html#a59fd11d1cef4e1be812da1e2d3399327">addArgument</a> (std::string arg)</td></tr>
<tr class="memdesc:a59fd11d1cef4e1be812da1e2d3399327"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function adding an argument to the list. <a href="#a59fd11d1cef4e1be812da1e2d3399327">More...</a><br/></td></tr>
<tr class="separator:a59fd11d1cef4e1be812da1e2d3399327"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf399ccff87f5692d31f7edeb8469e0e"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket_p_p_1_1_server_function_args.html#aaf399ccff87f5692d31f7edeb8469e0e">getArgument</a> (unsigned int idx)</td></tr>
<tr class="memdesc:aaf399ccff87f5692d31f7edeb8469e0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function returning the argument of given index number. <a href="#aaf399ccff87f5692d31f7edeb8469e0e">More...</a><br/></td></tr>
<tr class="separator:aaf399ccff87f5692d31f7edeb8469e0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a905fd5c411969f8976541a10c243fc40"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket_p_p_1_1_server_function_args.html#a905fd5c411969f8976541a10c243fc40">operator[]</a> (unsigned int idx)</td></tr>
<tr class="memdesc:a905fd5c411969f8976541a10c243fc40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operator[] returning the argument of given index number. <a href="#a905fd5c411969f8976541a10c243fc40">More...</a><br/></td></tr>
<tr class="separator:a905fd5c411969f8976541a10c243fc40"><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>A class for storing server function arguments. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ac7f9a434d7525e09f9568a3b7fb33d51"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ServerFunctionArgs::ServerFunctionArgs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_net_socket_p_p_1_1_server_function_args.html">ServerFunctionArgs</a> &amp;&#160;</td>
<td class="paramname"><em>sfa</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>A copy constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sfa</td><td>An object to be copied. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a59fd11d1cef4e1be812da1e2d3399327"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ServerFunctionArgs::addArgument </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>arg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Function adding an argument to the list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">arg</td><td>An argument to be added, of type std::string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aaf399ccff87f5692d31f7edeb8469e0e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string ServerFunctionArgs::getArgument </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>idx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Function returning the argument of given index number. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">idx</td><td>Index of the argument. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The argument. </dd></dl>
</div>
</div>
<a class="anchor" id="a905fd5c411969f8976541a10c243fc40"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string ServerFunctionArgs::operator[] </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>idx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Operator[] returning the argument of given index number. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">idx</td><td>Index of the argument. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The argument. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_server_socket_8h_source.html">ServerSocket.h</a></li>
<li>ServerSocket.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Feb 27 2013 00:04:35 for NetSocket++ by &#160;<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>