diff options
Diffstat (limited to 'docs/module-doc/classRequest.html')
| -rw-r--r-- | docs/module-doc/classRequest.html | 361 |
1 files changed, 361 insertions, 0 deletions
diff --git a/docs/module-doc/classRequest.html b/docs/module-doc/classRequest.html new file mode 100644 index 000000000..8af50c2b9 --- /dev/null +++ b/docs/module-doc/classRequest.html @@ -0,0 +1,361 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>InspIRCd: Request class Reference</title> +<link href="inspircd.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.3.3 --> +<div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Compound List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a></div> +<h1>Request Class Reference</h1>The Request class is a unicast message directed at a given module. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="modules_8h-source.html">modules.h</a>></code> +<p> +Inherits <a class="el" href="classModuleMessage.html">ModuleMessage</a>. +<p> +<a href="classRequest-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classRequest.html#a0">Request</a> (char *anydata, <a class="el" href="classModule.html">Module</a> *src, <a class="el" href="classModule.html">Module</a> *dst)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new Request. </em> <a href="#a0"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>char * </td><td class="memItemRight" valign=bottom><a class="el" href="classRequest.html#a1">GetData</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Fetch the Request data. </em> <a href="#a1"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classModule.html">Module</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classRequest.html#a2">GetSource</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Fetch the request source. </em> <a href="#a2"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classModule.html">Module</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classRequest.html#a3">GetDest</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Fetch the request destination (should be 'this' in the receiving module). </em> <a href="#a3"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>char * </td><td class="memItemRight" valign=bottom><a class="el" href="classRequest.html#a4">Send</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Send the Request. </em> <a href="#a4"></a><em><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>char * </td><td class="memItemRight" valign=bottom><a class="el" href="classRequest.html#p0">data</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This member holds a pointer to arbitary data set by the emitter of the message. </em> <a href="#p0"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classModule.html">Module</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classRequest.html#p1">source</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This is a pointer to the sender of the message, which can be used to directly trigger events, or to create a reply. </em> <a href="#p1"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classModule.html">Module</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classRequest.html#p2">dest</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The single destination of the Request. </em> <a href="#p2"></a><em><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The Request class is a unicast message directed at a given module. +<p> +When this class is properly instantiated it may be sent to a module using the <a class="el" href="classRequest.html#a4">Send()</a> method, which will call the given module's OnRequest method with this class as its parameter. +<p> + +<p> +Definition at line <a class="el" href="modules_8h-source.html#l00151">151</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="Request::Request"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> Request::Request </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">char * </td> + <td class="mdname" nowrap> <em>anydata</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="classModule.html">Module</a> * </td> + <td class="mdname" nowrap> <em>src</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="classModule.html">Module</a> * </td> + <td class="mdname" nowrap> <em>dst</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Create a new Request. +<p> + +<p> +Definition at line <a class="el" href="modules_8cpp-source.html#l00308">308</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00308 : <a class="code" href="classRequest.html#p0">data</a>(anydata), <a class="code" href="classRequest.html#p1">source</a>(src), <a class="code" href="classRequest.html#p2">dest</a>(dst) { }; +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a1" doxytag="Request::GetData"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> char * Request::GetData </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Fetch the Request data. +<p> + +<p> +Definition at line <a class="el" href="modules_8cpp-source.html#l00310">310</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l00156">data</a>. +<p> +<div class="fragment"><pre>00311 { +00312 <span class="keywordflow">return</span> this-><a class="code" href="classRequest.html#p0">data</a>; +00313 } +</pre></div> </td> + </tr> +</table> +<a name="a3" doxytag="Request::GetDest"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classModule.html">Module</a> * Request::GetDest </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Fetch the request destination (should be 'this' in the receiving module). +<p> + +<p> +Definition at line <a class="el" href="modules_8cpp-source.html#l00320">320</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l00163">dest</a>. +<p> +<div class="fragment"><pre>00321 { +00322 <span class="keywordflow">return</span> this-><a class="code" href="classRequest.html#p2">dest</a>; +00323 } +</pre></div> </td> + </tr> +</table> +<a name="a2" doxytag="Request::GetSource"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classModule.html">Module</a> * Request::GetSource </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Fetch the request source. +<p> + +<p> +Definition at line <a class="el" href="modules_8cpp-source.html#l00315">315</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l00160">source</a>. +<p> +<div class="fragment"><pre>00316 { +00317 <span class="keywordflow">return</span> this-><a class="code" href="classRequest.html#p1">source</a>; +00318 } +</pre></div> </td> + </tr> +</table> +<a name="a4" doxytag="Request::Send"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> char * Request::Send </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Send the Request. +<p> +Upon returning the result will be arbitary data returned by the module you sent the request to. It is up to your module to know what this data is and how to deal with it. +<p> +Implements <a class="el" href="classModuleMessage.html#a0">ModuleMessage</a>. +<p> +Definition at line <a class="el" href="modules_8cpp-source.html#l00325">325</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l00163">dest</a>, and <a class="el" href="modules_8cpp-source.html#l00407">Module::OnRequest()</a>. +<p> +<div class="fragment"><pre>00326 { +00327 <span class="keywordflow">if</span> (this-><a class="code" href="classRequest.html#p2">dest</a>) +00328 { +00329 <span class="keywordflow">return</span> <a class="code" href="classRequest.html#p2">dest</a>-><a class="code" href="classModule.html#a46">OnRequest</a>(<span class="keyword">this</span>); +00330 } +00331 <span class="keywordflow">else</span> +00332 { +00333 <span class="keywordflow">return</span> NULL; +00334 } +00335 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="p0" doxytag="Request::data"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> char* <a class="el" href="classRequest.html#p0">Request::data</a><code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This member holds a pointer to arbitary data set by the emitter of the message. +<p> + +<p> +Definition at line <a class="el" href="modules_8h-source.html#l00156">156</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. +<p> +Referenced by <a class="el" href="modules_8cpp-source.html#l00310">GetData()</a>. </td> + </tr> +</table> +<a name="p2" doxytag="Request::dest"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classModule.html">Module</a>* <a class="el" href="classRequest.html#p2">Request::dest</a><code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The single destination of the Request. +<p> + +<p> +Definition at line <a class="el" href="modules_8h-source.html#l00163">163</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. +<p> +Referenced by <a class="el" href="modules_8cpp-source.html#l00320">GetDest()</a>, and <a class="el" href="modules_8cpp-source.html#l00325">Send()</a>. </td> + </tr> +</table> +<a name="p1" doxytag="Request::source"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classModule.html">Module</a>* <a class="el" href="classRequest.html#p1">Request::source</a><code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is a pointer to the sender of the message, which can be used to directly trigger events, or to create a reply. +<p> + +<p> +Definition at line <a class="el" href="modules_8h-source.html#l00160">160</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. +<p> +Referenced by <a class="el" href="modules_8cpp-source.html#l00315">GetSource()</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="modules_8h-source.html">modules.h</a><li><a class="el" href="modules_8cpp-source.html">modules.cpp</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Wed Apr 20 15:47:07 2005 for InspIRCd by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border=0 > +</a>1.3.3 </small></address> +</body> +</html> |