summaryrefslogtreecommitdiff
path: root/docs/man/man3/Request.3
diff options
context:
space:
mode:
authorbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2005-05-12 02:26:05 +0000
committerbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2005-05-12 02:26:05 +0000
commita266dadd1351d10b56ec187c7b6f7af75350ed68 (patch)
tree0729c41ca0f1719c69277dc862d4704d63d6248f /docs/man/man3/Request.3
parentc42a4ace0281ee6a89f6df2af3b15563ffe98064 (diff)
Documented new recvq and sendq stuff
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1367 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/man/man3/Request.3')
-rw-r--r--docs/man/man3/Request.352
1 files changed, 26 insertions, 26 deletions
diff --git a/docs/man/man3/Request.3 b/docs/man/man3/Request.3
index e3bc31498..dbee6d6fc 100644
--- a/docs/man/man3/Request.3
+++ b/docs/man/man3/Request.3
@@ -1,4 +1,4 @@
-.TH "Request" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*-
+.TH "Request" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -63,65 +63,65 @@ Definition at line 154 of file modules.h.
.PP
.SS "Request::Request (char * anydata, \fBModule\fP * src, \fBModule\fP * dst)"
.PP
-Create a new Request. Definition at line 306 of file modules.cpp.
+Create a new Request. Definition at line 315 of file modules.cpp.
.PP
.nf
-306 : data(anydata), source(src), dest(dst) { };
+315 : data(anydata), source(src), dest(dst) { };
.fi
.SH "Member Function Documentation"
.PP
.SS "char * Request::GetData ()"
.PP
-Fetch the Request data. Definition at line 308 of file modules.cpp.
+Fetch the Request data. Definition at line 317 of file modules.cpp.
.PP
References data.
.PP
.nf
-309 {
-310 return this->data;
-311 }
+318 {
+319 return this->data;
+320 }
.fi
.SS "\fBModule\fP * Request::GetDest ()"
.PP
-Fetch the request destination (should be 'this' in the receiving module). Definition at line 318 of file modules.cpp.
+Fetch the request destination (should be 'this' in the receiving module). Definition at line 327 of file modules.cpp.
.PP
References dest.
.PP
.nf
-319 {
-320 return this->dest;
-321 }
+328 {
+329 return this->dest;
+330 }
.fi
.SS "\fBModule\fP * Request::GetSource ()"
.PP
-Fetch the request source. Definition at line 313 of file modules.cpp.
+Fetch the request source. Definition at line 322 of file modules.cpp.
.PP
References source.
.PP
.nf
-314 {
-315 return this->source;
-316 }
+323 {
+324 return this->source;
+325 }
.fi
.SS "char * Request::Send ()\fC [virtual]\fP"
.PP
Send the Request. 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. Implements \fBModuleMessage\fP.
.PP
-Definition at line 323 of file modules.cpp.
+Definition at line 332 of file modules.cpp.
.PP
References dest, and Module::OnRequest().
.PP
.nf
-324 {
-325 if (this->dest)
-326 {
-327 return dest->OnRequest(this);
-328 }
-329 else
-330 {
-331 return NULL;
-332 }
-333 }
+333 {
+334 if (this->dest)
+335 {
+336 return dest->OnRequest(this);
+337 }
+338 else
+339 {
+340 return NULL;
+341 }
+342 }
.fi
.SH "Member Data Documentation"
.PP