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_peer.html | 702 +++++++++++++++++++++++++++++++++++ 1 file changed, 702 insertions(+) create mode 100644 Doc/doxygen/html/class_net_peer.html (limited to 'Doc/doxygen/html/class_net_peer.html') diff --git a/Doc/doxygen/html/class_net_peer.html b/Doc/doxygen/html/class_net_peer.html new file mode 100644 index 0000000..4d0cfd5 --- /dev/null +++ b/Doc/doxygen/html/class_net_peer.html @@ -0,0 +1,702 @@ + + + + + +Starshatter_Open: NetPeer Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Types | +Public Member Functions | +Static Public Member Functions
+
+
NetPeer Class Reference
+
+
+ +

#include <NetPeer.h>

+ +

List of all members.

+ + + +

+Public Types

enum  STATUS { OK, +SEND_OVERFLOW, +RECV_OVERFLOW + }
+ + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 NetPeer (const NetAddr &addr, DWORD id)
 ~NetPeer ()
int operator== (const NetPeer &p) const
bool SendMessage (NetMsg *msg)
NetMsg * GetMessage ()
NetGram * ComposeGram ()
bool ReceiveGram (NetGram *g, List< NetMsg > *q=0)
const NetAddr & Address () const
DWORD NetID () const
DWORD Sequence () const
int GetMaxPPS () const
void SetMaxPPS (int p)
int GetMaxBPS () const
void SetMaxBPS (int b)
int GetMaxQSize () const
void SetMaxQSize (int q)
DWORD GetChunkSize () const
void SetChunkSize (DWORD s)
DWORD LastReceiveTime () const
void SetLastReceiveTime (DWORD t)
+ + +

+Static Public Member Functions

static const char * TYPENAME ()
+

Detailed Description

+
+

Definition at line 31 of file NetPeer.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum NetPeer::STATUS
+
+
Enumerator:
+ + + +
OK  +
SEND_OVERFLOW  +
RECV_OVERFLOW  +
+
+
+ +

Definition at line 36 of file NetPeer.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
NetPeer::NetPeer (const NetAddr & addr,
DWORD id 
)
+
+ +

Definition at line 36 of file NetPeer.cpp.

+ +
+
+ +
+
+ + + + + + + +
NetPeer::~NetPeer ()
+
+ +

Definition at line 47 of file NetPeer.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + +
const NetAddr& NetPeer::Address () const
+ 		+inline
+
+ +

Definition at line 49 of file NetPeer.h.

+ +
+
+ +
+
+ + + + + + + +
NetGram * NetPeer::ComposeGram ()
+
+ +

Definition at line 144 of file NetPeer.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
DWORD NetPeer::GetChunkSize () const
+ 		+inline
+
+ +

Definition at line 60 of file NetPeer.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int NetPeer::GetMaxBPS () const
+ 		+inline
+
+ +

Definition at line 55 of file NetPeer.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int NetPeer::GetMaxPPS () const
+ 		+inline
+
+ +

Definition at line 53 of file NetPeer.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int NetPeer::GetMaxQSize () const
+ 		+inline
+
+ +

Definition at line 57 of file NetPeer.h.

+ +
+
+ +
+
+ + + + + + + +
NetMsg * NetPeer::GetMessage ()
+
+ +

Definition at line 130 of file NetPeer.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
DWORD NetPeer::LastReceiveTime () const
+ 		+inline
+
+ +

Definition at line 63 of file NetPeer.h.

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

Definition at line 50 of file NetPeer.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
int NetPeer::operator== (const NetPeer & p) const
+ 		+inline
+
+ +

Definition at line 41 of file NetPeer.h.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
bool NetPeer::ReceiveGram (NetGram * g,
List< NetMsg > * q = 0 
)
+
+ +

Definition at line 274 of file NetPeer.cpp.

+ +
+
+ +
+
+ + + + + + + + +
bool NetPeer::SendMessage (NetMsg * msg)
+
+ +

Definition at line 59 of file NetPeer.cpp.

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

Definition at line 51 of file NetPeer.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetPeer::SetChunkSize (DWORD s)
+ 		+inline
+
+ +

Definition at line 61 of file NetPeer.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetPeer::SetLastReceiveTime (DWORD t)
+ 		+inline
+
+ +

Definition at line 64 of file NetPeer.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetPeer::SetMaxBPS (int b)
+ 		+inline
+
+ +

Definition at line 56 of file NetPeer.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetPeer::SetMaxPPS (int p)
+ 		+inline
+
+ +

Definition at line 54 of file NetPeer.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetPeer::SetMaxQSize (int q)
+ 		+inline
+
+ +

Definition at line 58 of file NetPeer.h.

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

Definition at line 34 of file NetPeer.h.

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