From 8898ad9b25fca6afe2374d293a981db02a83d7e9 Mon Sep 17 00:00:00 2001 From: "FWoltermann@gmail.com" Date: Thu, 31 May 2012 14:46:27 +0000 Subject: Committing the documentation to svn to have it accessible online --- Doc/doxygen/html/class_net_msg.html | 664 ++++++++++++++++++++++++++++++++++++ 1 file changed, 664 insertions(+) create mode 100644 Doc/doxygen/html/class_net_msg.html (limited to 'Doc/doxygen/html/class_net_msg.html') diff --git a/Doc/doxygen/html/class_net_msg.html b/Doc/doxygen/html/class_net_msg.html new file mode 100644 index 0000000..0d96cb5 --- /dev/null +++ b/Doc/doxygen/html/class_net_msg.html @@ -0,0 +1,664 @@ + + + + + +Starshatter_Open: NetMsg Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Types | +Public Member Functions | +Static Public Member Functions
+
+
NetMsg Class Reference
+
+
+ +

#include <NetMsg.h>

+ +

List of all members.

+ + + + + +

+Public Types

enum  FLAGS { RELIABLE = 0x01, +PRIORITY = 0x02, +SCATTER = 0x04 + }
enum  TYPES { INVALID = 0, +RESERVED = 0xF0, +MULTIPART = 0xF1 + }
enum  { MAX_SIZE = 250 + }
+ + + + + + + + + + + + + + + + +

+Public Member Functions

 NetMsg (DWORD nid, void *d, int l, BYTE f=0)
 NetMsg (DWORD nid, BYTE type, const char *text, int len, BYTE f=0)
 ~NetMsg ()
int operator== (const NetMsg &m) const
int operator< (const NetMsg &m) const
DWORD Sequence () const
DWORD NetID () const
const BYTE * Data () const
BYTE Type () const
int Length () const
BYTE Flags () const
bool IsReliable () const
bool IsPriority () const
bool IsScatter () const
void SetSequence (DWORD s)
+ + +

+Static Public Member Functions

static const char * TYPENAME ()
+

Detailed Description

+
+

Definition at line 27 of file NetMsg.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
anonymous enum
+
+
Enumerator:
+ +
MAX_SIZE  +
+
+
+ +

Definition at line 37 of file NetMsg.h.

+ +
+
+ +
+
+ + + + +
enum NetMsg::FLAGS
+
+
Enumerator:
+ + + +
RELIABLE  +
PRIORITY  +
SCATTER  +
+
+
+ +

Definition at line 32 of file NetMsg.h.

+ +
+
+ +
+
+ + + + +
enum NetMsg::TYPES
+
+
Enumerator:
+ + + +
INVALID  +
RESERVED  +
MULTIPART  +
+
+
+ +

Definition at line 33 of file NetMsg.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NetMsg::NetMsg (DWORD nid,
void * d,
int l,
BYTE f = 0 
)
+
+ +

Definition at line 26 of file NetMsg.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NetMsg::NetMsg (DWORD nid,
BYTE type,
const char * text,
int len,
BYTE f = 0 
)
+
+ +

Definition at line 46 of file NetMsg.cpp.

+ +
+
+ +
+
+ + + + + + + +
NetMsg::~NetMsg ()
+
+ +

Definition at line 69 of file NetMsg.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + +
const BYTE* NetMsg::Data () const
+ 		+inline
+
+ +

Definition at line 49 of file NetMsg.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
BYTE NetMsg::Flags () const
+ 		+inline
+
+ +

Definition at line 52 of file NetMsg.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool NetMsg::IsPriority () const
+ 		+inline
+
+ +

Definition at line 55 of file NetMsg.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool NetMsg::IsReliable () const
+ 		+inline
+
+ +

Definition at line 54 of file NetMsg.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool NetMsg::IsScatter () const
+ 		+inline
+
+ +

Definition at line 56 of file NetMsg.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int NetMsg::Length () const
+ 		+inline
+
+ +

Definition at line 51 of file NetMsg.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
DWORD NetMsg::NetID () const
+ 		+inline
+
+ +

Definition at line 48 of file NetMsg.h.

+ +
+
+ +
+
+ + + + + + + + +
int NetMsg::operator< (const NetMsg & m) const
+
+ +

Definition at line 76 of file NetMsg.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
int NetMsg::operator== (const NetMsg & m) const
+ 		+inline
+
+ +

Definition at line 43 of file NetMsg.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
DWORD NetMsg::Sequence () const
+ 		+inline
+
+ +

Definition at line 47 of file NetMsg.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetMsg::SetSequence (DWORD s)
+ 		+inline
+
+ +

Definition at line 58 of file NetMsg.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
BYTE NetMsg::Type () const
+ 		+inline
+
+ +

Definition at line 50 of file NetMsg.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
static const char* NetMsg::TYPENAME ()
+ 		+inlinestatic
+
+ +

Definition at line 30 of file NetMsg.h.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.1