Main Page   Namespace List   Class Hierarchy   Compound List   File List   Compound Members   File Members  

CL_NetSession Class Reference

#include <netsession.h>

Collaboration diagram for CL_NetSession:

Collaboration graph
[legend]
List of all members.

Public Methods

 CL_NetSession (const std::string &app_id, int port)
 Construction:.

 CL_NetSession (const std::string &app_id, const std::string &hostname, int port)
 CL_NetSession (const CL_ServerInfo &server)
virtual ~CL_NetSession ()
CL_EventTriggerget_trigger ()
 Attributes:.

CL_NetComputerget_server ()
CL_NetGroupget_all ()
bool peek (int channel) const
int access_status (int channel) const
bool is_writable (int channel) const
bool is_readable (int channel) const
CL_NetMessage receive (int channel, int timeout=-1)
 Operations:.

void send (const int dest_channel, const CL_NetGroup &dest, const CL_NetMessage &message, bool reliable=true)
 param: channel - Channel to look for a message.param: timeout - Timeout, -1 means block forever.retval: The message received from the specified channel.

CL_NetComputer receive_computer_leave ()
 param: dest - The group of computers to receive the message.param: dest_channel - Netchannel the message is sent to.param: message - Data in the message sent. All the data from 'message' is duplicated before this function returns.param: reliable - Arrival reliability. True guarantees arrival (use TCP/Pony express), false doesn't (use UDP/US Mail).

CL_NetComputer receive_computer_join ()
CL_NetComputer receive_computer_rejoin ()
bool receive_session_closed ()
int receive_access_changed ()
void set_access (int channel, const CL_NetGroup &group, int access_rights=ACCESS_CHANNEL_READ|ACCESS_CHANNEL_WRITE)
 CL_NetSession (class CL_NetSession_Generic *impl)
 Implementation:.


Public Attributes

class CL_NetSession_Genericimpl

Constructor & Destructor Documentation

CL_NetSession::CL_NetSession ( const std::string & app_id,
int port )
 

Construction:.

CL_NetSession::CL_NetSession ( const std::string & app_id,
const std::string & hostname,
int port )
 

CL_NetSession::CL_NetSession ( const CL_ServerInfo & server )
 

virtual CL_NetSession::~CL_NetSession ( ) [virtual]
 

CL_NetSession::CL_NetSession ( class CL_NetSession_Generic * impl )
 

Implementation:.


Member Function Documentation

int CL_NetSession::access_status ( int channel ) const
 

CL_NetGroup& CL_NetSession::get_all ( )
 

CL_NetComputer& CL_NetSession::get_server ( )
 

CL_EventTrigger * CL_NetSession::get_trigger ( )
 

Attributes:.

bool CL_NetSession::is_readable ( int channel ) const
 

bool CL_NetSession::is_writable ( int channel ) const
 

bool CL_NetSession::peek ( int channel ) const
 

CL_NetMessage CL_NetSession::receive ( int channel,
int timeout = -1 )
 

Operations:.

int CL_NetSession::receive_access_changed ( )
 

CL_NetComputer CL_NetSession::receive_computer_join ( )
 

CL_NetComputer CL_NetSession::receive_computer_leave ( )
 

param: dest - The group of computers to receive the message.param: dest_channel - Netchannel the message is sent to.param: message - Data in the message sent. All the data from 'message' is duplicated before this function returns.param: reliable - Arrival reliability. True guarantees arrival (use TCP/Pony express), false doesn't (use UDP/US Mail).

CL_NetComputer CL_NetSession::receive_computer_rejoin ( )
 

bool CL_NetSession::receive_session_closed ( )
 

void CL_NetSession::send ( const int dest_channel,
const CL_NetGroup & dest,
const CL_NetMessage & message,
bool reliable = true )
 

param: channel - Channel to look for a message.param: timeout - Timeout, -1 means block forever.retval: The message received from the specified channel.

void CL_NetSession::set_access ( int channel,
const CL_NetGroup & group,
int access_rights = ACCESS_CHANNEL_READ | ACCESS_CHANNEL_WRITE )
 


Member Data Documentation

class CL_NetSession_Generic* CL_NetSession::impl
 

Definition at line 139 of file netsession.h.


The documentation for this class was generated from the following file:
Generated at Wed Apr 4 19:57:16 2001 for ClanLib by doxygen1.2.6 written by Dimitri van Heesch, © 1997-2001