NLNET::CTransportClass Class Reference

#include <transport_class.h>

---

Detailed Description

You have to inherit this class and implement description() and callback() method. For an example of use, take a look at nel/samples/class_transport sample.

Author:

Vianney Lecroart

Nevrax France

Date:

2002

Definition at line 71 of file transport_class.h.

Public Types
enum	TProp {   PropUInt8, PropUInt16, PropUInt32, PropUInt64,   PropSInt8, PropSInt16, PropSInt32, PropSInt64,   PropBool, PropFloat, PropDouble, PropString,   PropDataSetRow, PropSheetId, PropUKN }
Public Member Functions
virtual	~CTransportClass ()
Static Public Member Functions
void	displayLocalRegisteredClass ()
	Display registered transport class (debug purpose).
void	init ()
	Init the transport class system (must be called one time, in the IService5::init() for example).
void	registerClass (CTransportClass &instance)
void	release ()
	Release the transport class system (must be called one time, in the IService5::release() for example).

---

Member Enumeration Documentation

enum NLNET::CTransportClass::TProp

Different types that we can use in a Transport class warning: if you add/change a prop, change also in CTransportClass::init() warning: PropUKN must be the last value (used to resize a vector) Enumeration values: PropUInt8  PropUInt16  PropUInt32  PropUInt64  PropSInt8  PropSInt16  PropSInt32  PropSInt64  PropBool  PropFloat  PropDouble  PropString  PropDataSetRow  PropSheetId  PropUKN  Definition at line 79 of file transport_class.h. { PropUInt8, PropUInt16, PropUInt32, PropUInt64, PropSInt8, PropSInt16, PropSInt32, PropSInt64, PropBool, PropFloat, PropDouble, PropString, PropDataSetRow, PropSheetId, PropUKN };

---

Constructor & Destructor Documentation

virtual NLNET::CTransportClass::~CTransportClass (   )  [inline, virtual]

Definition at line 74 of file transport_class.h. {}

---

Member Function Documentation

void NLNET::CTransportClass::displayLocalRegisteredClass (   )  [static]

Display registered transport class (debug purpose). Definition at line 245 of file transport_class.cpp. References nldebug. { nldebug ("NETTC:> LocalRegisteredClass:"); for (TRegisteredClass::iterator it = LocalRegisteredClass.begin(); it != LocalRegisteredClass.end (); it++) { displayLocalRegisteredClass ((*it).second); } }

void NLNET::CTransportClass::init (   )  [static]

Init the transport class system (must be called one time, in the IService5::init() for example). Definition at line 330 of file transport_class.cpp. References NLNET::CallbackArray, NLNET::cbTCUpService(), nlassert, PropBool, PropDouble, PropFloat, PropSheetId, PropSInt16, PropSInt32, PropSInt64, PropSInt8, PropString, PropUInt16, PropUInt32, PropUInt64, PropUInt8, and PropUKN. { // this isn't an error! if (Init) return; CUnifiedNetwork::getInstance()->addCallbackArray (CallbackArray, sizeof (CallbackArray) / sizeof (CallbackArray[0])); // create an instance of all d'ifferent prop types DummyProp.resize (PropUKN); nlassert (PropUInt8 < PropUKN); DummyProp[PropUInt8] = new CTransportClass::CRegisteredProp<uint8>; nlassert (PropUInt16 < PropUKN); DummyProp[PropUInt16] = new CTransportClass::CRegisteredProp<uint16>; nlassert (PropUInt32 < PropUKN); DummyProp[PropUInt32] = new CTransportClass::CRegisteredProp<uint32>; nlassert (PropUInt64 < PropUKN); DummyProp[PropUInt64] = new CTransportClass::CRegisteredProp<uint64>; nlassert (PropSInt8 < PropUKN); DummyProp[PropSInt8] = new CTransportClass::CRegisteredProp<sint8>; nlassert (PropSInt16 < PropUKN); DummyProp[PropSInt16] = new CTransportClass::CRegisteredProp<sint16>; nlassert (PropSInt32 < PropUKN); DummyProp[PropSInt32] = new CTransportClass::CRegisteredProp<sint32>; nlassert (PropSInt64 < PropUKN); DummyProp[PropSInt64] = new CTransportClass::CRegisteredProp<sint64>; nlassert (PropBool < PropUKN); DummyProp[PropBool] = new CTransportClass::CRegisteredProp<bool>; nlassert (PropFloat < PropUKN); DummyProp[PropFloat] = new CTransportClass::CRegisteredProp<float>; nlassert (PropDouble < PropUKN); DummyProp[PropDouble] = new CTransportClass::CRegisteredProp<double>; nlassert (PropString < PropUKN); DummyProp[PropString] = new CTransportClass::CRegisteredProp<string>; // nlassert (PropDataSetRow < PropUKN); DummyProp[PropDataSetRow] = new CTransportClass::CRegisteredProp<TDataSetRow>; // nlassert (PropEntityId < PropUKN); DummyProp[PropEntityId] = new CTransportClass::CRegisteredProp<CEntityId>; nlassert (PropSheetId < PropUKN); DummyProp[PropSheetId] = new CTransportClass::CRegisteredProp<CSheetId>; // we have to know when a service comes, so add callback (put the callback before all other one because we have to send this message first) CUnifiedNetwork::getInstance()->setServiceUpCallback("*", cbTCUpService, NULL, false); Init = true; }

void NLNET::CTransportClass::registerClass (  CTransportClass &  instance  )  [static]

Call this function to register a new transport class. Parameters: instance  A reference to a GLOBAL space of the instance of this transport class. It will be used when receive this class from network. Definition at line 186 of file transport_class.cpp. References nlassert. { nlassert (Init); nlassert (Mode == 0); // set the mode to register Mode = 3; // clear the current class TempRegisteredClass.clear (); // set the instance pointer TempRegisteredClass.Instance = &instance; // fill name and props TempRegisteredClass.Instance->description (); // add the new registered class in the array LocalRegisteredClass[TempRegisteredClass.Instance->Name] = TempRegisteredClass; // set to mode none Mode = 0; }

void NLNET::CTransportClass::release (   )  [static]

Release the transport class system (must be called one time, in the IService5::release() for example). Definition at line 363 of file transport_class.cpp. References uint. { unregisterClass (); for (uint i = 0; i < DummyProp.size (); i++) { delete DummyProp[i]; } DummyProp.clear (); }

---

The documentation for this class was generated from the following files:

• transport_class.h
• transport_class.cpp

---