G3D::Conduit Class Reference

#include <NetworkDevice.h>

Public Member Functions
virtual	~Conduit ()
uint64	bytesSent () const
uint64	messagesSent () const
uint64	bytesReceived () const
uint64	messagesReceived () const
virtual bool	messageWaiting ()
virtual uint32	waitingMessageType ()=0
bool	ok () const
Public Member Functions inherited from G3D::ReferenceCountedObject
virtual	~ReferenceCountedObject ()

Protected Member Functions
	Conduit ()

Protected Attributes
uint64	mSent
uint64	mReceived
uint64	bSent
uint64	bReceived
SOCKET	sock
BinaryOutput	binaryOutput

Friends
class	NetworkDevice
class	NetListener

Detailed Description

Deprecated:

Constructor & Destructor Documentation

G3D::Conduit::Conduit ( )

protected

 : binaryOutput("<memory>", G3D_LITTLE_ENDIAN) {
 sock = 0;
 mSent = 0;
 mReceived = 0;
 bSent = 0;
 bReceived = 0;
}

G3D::Conduit::~Conduit ( )

virtual

 {
 NetworkDevice::instance()->closesocket(sock);
}

Here is the call graph for this function:

Member Function Documentation

uint64 G3D::Conduit::bytesReceived

(

)

const

 {
 return bReceived;
}

uint64 G3D::Conduit::bytesSent

(

)

const

 {
 return bSent;
}

uint64 G3D::Conduit::messagesReceived

(

)

const

 {
 return mReceived;
}

uint64 G3D::Conduit::messagesSent

(

)

const

 {
 return mSent;
}

bool G3D::Conduit::messageWaiting ( )

virtual

If true, receive will return true.

Reimplemented in G3D::LightweightConduit, and G3D::ReliableConduit.

 {
 return readWaiting(sock);
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool G3D::Conduit::ok

(

)

const

Returns true if the connection is ok.

 {
 return (sock != 0) && (sock != SOCKET_ERROR);
}

Here is the caller graph for this function:

virtual uint32 G3D::Conduit::waitingMessageType ( )

pure virtual

Returns the type of the waiting message (i.e. the type supplied with send). The return value is zero when there is no message waiting.

One way to use this is to have a Table mapping message types to pre-allocated subclasses so receiving looks like:

    // My base class for messages.
    class Message {
        virtual void serialize(BinaryOutput&) const;
        virtual void deserialize(BinaryInput&);
        virtual void process() = 0;
    };

    Message* m = table[conduit->waitingMessageType()];
    conduit->receive(m);
    m->process();

Another is to simply switch on the message type:

    switch (conduit->waitingMessageType()) {
    case 0:
       // No message
       break;

    case ENTITY_SPAWN_MSG:
       {
          EntitySpawnMsg m;
          condiut->receive(m);
          spawnEntity(m.id, m.position, m.modelID);
       }
       break;
       ...
    }
 

Implemented in G3D::LightweightConduit, and G3D::ReliableConduit.

Friends And Related Function Documentation

friend class NetListener

friend

friend class NetworkDevice

friend

Member Data Documentation

BinaryOutput G3D::Conduit::binaryOutput

protected

Used for serialization. One per socket to make this threadsafe.

uint64 G3D::Conduit::bReceived

protected

uint64 G3D::Conduit::bSent

protected

uint64 G3D::Conduit::mReceived

protected

uint64 G3D::Conduit::mSent

protected

SOCKET G3D::Conduit::sock

protected

---

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

• dep/g3dlite/include/G3D/NetworkDevice.h
• dep/g3dlite/source/NetworkDevice.cpp