<!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>Event class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.17 -->
<center>
<a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</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> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>Event Class Reference</h1><code>#include <<a class="el" href="event_8h-source.html">event.h</a>></code>
<p>
<a href="classEvent-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 Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classEvent.html#a0">Event</a> (<a class="el" href="event_8h.html#a5">Event_T</a> etype, SOCKET eid, int elen, const char *edata)</td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classEvent.html#a1">~Event</a> ()</td></tr>
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="event_8h.html#a5">Event_T</a> </td><td valign=bottom><a class="el" href="classEvent.html#m0">mEventType</a></td></tr>
<tr><td> </td><td><font size=-1><em>Type of event.</em> <a href="#m0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>unsigned int </td><td valign=bottom><a class="el" href="classEvent.html#m1">mClientId</a></td></tr>
<tr><td> </td><td><font size=-1><em>The id. <a class="el" href="classSocket.html">Socket</a> number.</em> <a href="#m1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classEvent.html#m2">mDataLen</a></td></tr>
<tr><td> </td><td><font size=-1><em>Optional length of message data.</em> <a href="#m2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="classEvent.html#m3">mpData</a></td></tr>
<tr><td> </td><td><font size=-1><em>Optional messsage data.</em> <a href="#m3"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Private Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classEvent.html#c0">Event</a> (Event &)</td></tr>
<tr><td nowrap align=right valign=top>Event & </td><td valign=bottom><a class="el" href="classEvent.html#c1">operator=</a> (Event &)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The Event class implements a construct to pass messages between subsystems.
<p>
<dl compact><dt><b>Note: </b></dt><dd>
All attributes are publically accessible. We will store these in the event queues as pointers so we can take advantage of specialization later. No copy constructor or assignment allowed. </dl>
<p>
<p>
Definition at line <a class="el" href="event_8h-source.html#l00034">34</a> of file <a class="el" href="event_8h-source.html">event.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="Event::Event"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Event::Event </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="event_8h.html#a5">Event_T</a> </td>
<td class="mdname" nowrap> <em>etype</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>SOCKET </td>
<td class="mdname" nowrap> <em>eid</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>elen</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>edata</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>
The constructor for an Event.<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>etype</em> </td><td>
The type of event. </td></tr>
<tr><td valign=top><em>eid</em> </td><td>
The client id associated with this event (socket number). </td></tr>
<tr><td valign=top><em>elen</em> </td><td>
The length of the message data. </td></tr>
<tr><td valign=top><em>edata</em> </td><td>
The message data. It may or may not be a null terminated character array. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="event_8cpp-source.html#l00020">20</a> of file <a class="el" href="event_8cpp-source.html">event.cpp</a>.
<p>
References <a class="el" href="event_8h-source.html#l00017">Event_T</a>, <a class="el" href="event_8h-source.html#l00041">mDataLen</a>, and <a class="el" href="event_8h-source.html#l00042">mpData</a>. </td>
</tr>
</table>
<a name="a1" doxytag="Event::~Event"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Event::~Event </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>
Destructor for an Event.
<p>
Definition at line <a class="el" href="event_8cpp-source.html#l00035">35</a> of file <a class="el" href="event_8cpp-source.html">event.cpp</a>.
<p>
References <a class="el" href="event_8h-source.html#l00042">mpData</a>. </td>
</tr>
</table>
<a name="c0" doxytag="Event::Event"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Event::Event </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">Event & </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [private]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="c1" doxytag="Event::operator="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Event& Event::operator= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">Event & </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [private]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="m1" doxytag="Event::mClientId"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> unsigned int Event::mClientId
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The id. <a class="el" href="classSocket.html">Socket</a> number.
<p>
<p>
Definition at line <a class="el" href="event_8h-source.html#l00040">40</a> of file <a class="el" href="event_8h-source.html">event.h</a>.
<p>
Referenced by <a class="el" href="paradigm_8cpp-source.html#l00237">Chat</a>(), and <a class="el" href="server_8cpp-source.html#l00244">Server::ProcessQueue</a>(). </td>
</tr>
</table>
<a name="m2" doxytag="Event::mDataLen"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int Event::mDataLen
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Optional length of message data.
<p>
<p>
Definition at line <a class="el" href="event_8h-source.html#l00041">41</a> of file <a class="el" href="event_8h-source.html">event.h</a>.
<p>
Referenced by <a class="el" href="paradigm_8cpp-source.html#l00237">Chat</a>(), <a class="el" href="event_8cpp-source.html#l00020">Event</a>(), and <a class="el" href="server_8cpp-source.html#l00244">Server::ProcessQueue</a>(). </td>
</tr>
</table>
<a name="m0" doxytag="Event::mEventType"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="event_8h.html#a5">Event_T</a> Event::mEventType
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Type of event.
<p>
<p>
Definition at line <a class="el" href="event_8h-source.html#l00039">39</a> of file <a class="el" href="event_8h-source.html">event.h</a>.
<p>
Referenced by <a class="el" href="paradigm_8cpp-source.html#l00237">Chat</a>(), and <a class="el" href="server_8cpp-source.html#l00244">Server::ProcessQueue</a>(). </td>
</tr>
</table>
<a name="m3" doxytag="Event::mpData"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> char* Event::mpData
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Optional messsage data.
<p>
<p>
Definition at line <a class="el" href="event_8h-source.html#l00042">42</a> of file <a class="el" href="event_8h-source.html">event.h</a>.
<p>
Referenced by <a class="el" href="paradigm_8cpp-source.html#l00237">Chat</a>(), <a class="el" href="event_8cpp-source.html#l00020">Event</a>(), <a class="el" href="server_8cpp-source.html#l00244">Server::ProcessQueue</a>(), and <a class="el" href="event_8cpp-source.html#l00035">~Event</a>(). </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="event_8h-source.html">event.h</a><li><a class="el" href="event_8cpp-source.html">event.cpp</a></ul>
<hr><address style="align: right;"><small>Generated on Mon Mar 29 23:12:57 2004 for Paradigm by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.17 </small></address>
</body>
</html>
