ClanSoft logo
ClanSoft logo
Entire Class Index Main Class Index Cross Index Global Index

Class CL_NetObjectChannel

Network object replication channel.
Contained in: global
Derived from: none
Derived by: none
Group: Network (NetObjects)

#include <ClanLib/network.h>


public function member index:

Construction:

CL_NetObjectChannel(const CL_NetObjectChannel& copy);
CL_NetObjectChannel(class CL_NetSession* netgame, int channel);
virtual ~CL_NetObjectChannel();

Attributes:

CL_Signal_v3<const class CL_NetObject& , int, const std::string& >& sig_create_object();
void begin_sync(const class CL_NetGroup* group = NULL);
void end_sync(const class CL_NetGroup* group = NULL);
bool wait_sync(int timeout = -1);
 

Description:

Manages a netchannel with netobject replication data. It dispatches incoming messages to the correct netobject.


Function Member Descriptions:

CL_NetObjectChannel::CL_NetObjectChannel - Copy constructor.
CL_NetObjectChannel(const CL_NetObjectChannel& copy);


CL_NetObjectChannel::CL_NetObjectChannel - Constructs a netobject channel.
CL_NetObjectChannel(class CL_NetSession* netgame, int channel);


CL_NetObjectChannel::begin_sync - Sends a begin_sync message to the netchannel. This is used together with end_sync to mark a group of objects. The client can use wait_sync to wait for a full transfer of a list of objects.
void begin_sync(const class CL_NetGroup* group = NULL);


CL_NetObjectChannel::end_sync - Sends a end_sync message to the netchannel. This is used together with end_sync to mark a group of objects. The client can use wait_sync to wait for a full transfer of a list of objects.
void end_sync(const class CL_NetGroup* group = NULL);


CL_NetObjectChannel::sig_create_object - CL_Signal_v3<netobject, msgtype, message>.

Signal that is called whenever the netobject channel receives a message for a netobject it doesnt know. The application should hook a slot into this signal and determine what to do with the message.
CL_Signal_v3<const class CL_NetObject& , int, const std::string& >& sig_create_object();


CL_NetObjectChannel::wait_sync - Waits for a synced group of objects to arrive. If the whole group havnt been received before the timeout, the function will return false.
bool wait_sync(int timeout = -1);


CL_NetObjectChannel::~CL_NetObjectChannel - Net Object Channel Destructor
virtual ~CL_NetObjectChannel();



Variable Member Descriptions:

CL_NetObjectChannel::impl - Net Object Channel Generic Implementation
CL_NetObjectChannel_Generic * impl;