class TdNetCavConnection

Class used to encapsulate a CAVERNsoft Connection

Public Classes

enum connectionType

Connection type enumeration

Public Methods

TdNetCavConnection(const TcUtString &connectID, const TcUtString &worldServer, const long &remotePort, TdNetCavConnection::connectionType type = TCP)

Constructor

~TdNetCavConnection()

Destructor.

void addLink(TdNetCavKey& key)

Link this key to key on remote server

void removeLink(TdNetCavKey& key)

Removes a link.

void setCavLinkAttribute(CAVERN_linkAttrib_c& att)

Sets the attributes for the link.

void setCB(void (*callback)(CAVERN_irbChannel_c::CAVERN_channelEvent_t event, CAVERN_irbChannel_c *thisChannel, void *userData), void *userData)

Sets the callback for the channel.

CAVERN_irbLink_c* getLink(TdNetCavKey &key)

Returns a link for a given key by reference to the key..

CAVERN_irbLink_c* getLink(const TcUtString &key)

Returns a link for a given key by name.

enum connectionType

Connection type enumeration

Parameters:

UDP - Unreliable connection type.
TCP - Reliable connection type.

TdNetCavConnection(const TcUtString &connectID, const TcUtString &worldServer, const long &remotePort, TdNetCavConnection::connectionType type = TCP)

Constructor

Parameters:

connectionID - Specifies the string ID of the connection.
worldServer - Specifies the destination URL of the server for the connection.
remotePort - Specifies the remote port for the connection.
type - Specifies a reliable or unreliable connection type.

~TdNetCavConnection()

Destructor.

void addLink(TdNetCavKey& key)

Link this key to key on remote server

Parameters:

key - The name of this key must match the name on the remote server.

void removeLink(TdNetCavKey& key)

Removes a link.

void setCavLinkAttribute(CAVERN_linkAttrib_c& att)

Sets the attributes for the link.

void setCB(void (*callback)(CAVERN_irbChannel_c::CAVERN_channelEvent_t event, CAVERN_irbChannel_c *thisChannel, void *userData), void *userData)

Sets the callback for the channel.

CAVERN_irbLink_c* getLink(TdNetCavKey &key)

Returns a link for a given key by reference to the key..

CAVERN_irbLink_c* getLink(const TcUtString &key)

Returns a link for a given key by name.

This class has no child classes.

alphabetic index hierarchy of classes

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de