IPEndpoint Class Reference

#include <IPEndpoint.h>

Inheritance diagram for IPEndpoint:

TCPEndpoint UDPEndpoint TCPHandler TestServer DDPHandler GameControllerUDPHandler UDPHandlerEndpoint List of all members.

Public Member Functions

 IPEndpoint (int sbs=16384, int rbs=16384)
 ~IPEndpoint ()
virtual void listenCont (antEnvMsg *msg)
virtual void sendCont (antEnvMsg *msg)
virtual void receiveCont (antEnvMsg *msg)
virtual void closeCont (antEnvMsg *msg)
virtual void connectCont (antEnvMsg *msg)

Protected Attributes

antModuleRef endpoint
antSharedBuffer sendBuffer
byte * sharedSendBuffer
int sharedSendBufferSize
int sharedReceiveBufferSize
antSharedBuffer receiveBuffer
byte * sharedReceiveBuffer
int * listenContSelector
int * sendContSelector
int * receiveContSelector
int * closeContSelector
int * connectContSelector
antStackRef ipStackRef
OID * myOID_

Detailed Description

This class is used to encapsule ANT library entpoints. Its used as a base-class for TCPEndpoint and UDPEndpoint.

Definition at line 22 of file IPEndpoint.h.


Constructor & Destructor Documentation

IPEndpoint::IPEndpoint ( int  sbs = 16384,
int  rbs = 16384 
)

Constructor

Parameters:
sbs The size of the send-buffer. The send-buffer is shared memory between the process and Aperios. You can only send data with this size at once.
rbs The size of the receive-buffer. Its also shared memory and you can only receive this much data in one call of receiveCont

Definition at line 20 of file IPEndpoint.cpp.

References closeContSelector, connectContSelector, ProcessBase::getOID(), ipStackRef, listenContSelector, myOID_, receiveBuffer, receiveContSelector, sendBuffer, sendContSelector, sharedReceiveBuffer, sharedReceiveBufferSize, sharedSendBuffer, sharedSendBufferSize, and ProcessBase::theInstance.

IPEndpoint::~IPEndpoint (  ) 

Definition at line 68 of file IPEndpoint.cpp.

References receiveBuffer, and sendBuffer.


Member Function Documentation

virtual void IPEndpoint::closeCont ( antEnvMsg *  msg  )  [inline, virtual]

called by the processFreamwork after a close

Reimplemented in TCPEndpoint, and UDPEndpoint.

Definition at line 45 of file IPEndpoint.h.

virtual void IPEndpoint::connectCont ( antEnvMsg *  msg  )  [inline, virtual]

called by the processFramework after connecting

Reimplemented in TCPEndpoint.

Definition at line 48 of file IPEndpoint.h.

virtual void IPEndpoint::listenCont ( antEnvMsg *  msg  )  [inline, virtual]

called by the processFramework if someone connects to a listen port

Reimplemented in TCPEndpoint.

Definition at line 36 of file IPEndpoint.h.

virtual void IPEndpoint::receiveCont ( antEnvMsg *  msg  )  [inline, virtual]

called by the processFramework if new data arrives

Reimplemented in TCPEndpoint, and UDPEndpoint.

Definition at line 42 of file IPEndpoint.h.

virtual void IPEndpoint::sendCont ( antEnvMsg *  msg  )  [inline, virtual]

called by the processFramework if data was send.

Reimplemented in TCPEndpoint, and UDPEndpoint.

Definition at line 39 of file IPEndpoint.h.


Member Data Documentation

int* IPEndpoint::closeContSelector [protected]

Definition at line 71 of file IPEndpoint.h.

Referenced by UDPEndpoint::close(), TCPEndpoint::close(), and IPEndpoint().

int* IPEndpoint::connectContSelector [protected]

Definition at line 72 of file IPEndpoint.h.

Referenced by TCPEndpoint::connect(), and IPEndpoint().

antModuleRef IPEndpoint::endpoint [protected]

ANT Library Endpoint

Definition at line 48 of file IPEndpoint.h.

Referenced by UDPEndpoint::bind(), UDPEndpoint::close(), TCPEndpoint::close(), TCPEndpoint::connect(), TCPEndpoint::listen(), UDPEndpoint::send(), TCPEndpoint::sendSendMessage(), UDPEndpoint::startReceiving(), TCPEndpoint::startReceiving(), and UDPEndpoint::UDPEndpoint().

antStackRef IPEndpoint::ipStackRef [protected]

handle to comminicate to the ip-stack (ANT library

Definition at line 75 of file IPEndpoint.h.

Referenced by UDPEndpoint::bind(), UDPEndpoint::close(), TCPEndpoint::close(), TCPEndpoint::connect(), IPEndpoint(), TCPEndpoint::listen(), UDPEndpoint::send(), TCPEndpoint::sendSendMessage(), UDPEndpoint::startReceiving(), TCPEndpoint::startReceiving(), and UDPEndpoint::UDPEndpoint().

int* IPEndpoint::listenContSelector [protected]

Pointers to the entry-point selectors in the process-framework Need to be pointers because an IPEndpoint can be created before the entry-points are created

Definition at line 68 of file IPEndpoint.h.

Referenced by IPEndpoint(), and TCPEndpoint::listen().

OID* IPEndpoint::myOID_ [protected]

Object id of this process

Definition at line 76 of file IPEndpoint.h.

Referenced by UDPEndpoint::close(), TCPEndpoint::close(), TCPEndpoint::connect(), IPEndpoint(), TCPEndpoint::listen(), UDPEndpoint::send(), TCPEndpoint::sendSendMessage(), UDPEndpoint::startReceiving(), and TCPEndpoint::startReceiving().

antSharedBuffer IPEndpoint::receiveBuffer [protected]

ANT buffer for receiving

Reimplemented in TCPHandler.

Definition at line 58 of file IPEndpoint.h.

Referenced by IPEndpoint(), and ~IPEndpoint().

int* IPEndpoint::receiveContSelector [protected]

Definition at line 70 of file IPEndpoint.h.

Referenced by IPEndpoint(), UDPEndpoint::startReceiving(), and TCPEndpoint::startReceiving().

antSharedBuffer IPEndpoint::sendBuffer [protected]

ANT buffer for sending

Definition at line 53 of file IPEndpoint.h.

Referenced by IPEndpoint(), and ~IPEndpoint().

int* IPEndpoint::sendContSelector [protected]

Definition at line 69 of file IPEndpoint.h.

Referenced by IPEndpoint(), UDPEndpoint::send(), and TCPEndpoint::sendSendMessage().

byte* IPEndpoint::sharedReceiveBuffer [protected]

pointer to the data received

Definition at line 59 of file IPEndpoint.h.

Referenced by IPEndpoint(), UDPEndpoint::receiveCont(), TCPEndpoint::receiveCont(), UDPEndpoint::startReceiving(), and TCPEndpoint::startReceiving().

int IPEndpoint::sharedReceiveBufferSize [protected]

size of the receiveBuffer

Definition at line 56 of file IPEndpoint.h.

Referenced by IPEndpoint(), and UDPEndpoint::startReceiving().

byte* IPEndpoint::sharedSendBuffer [protected]

Pointer to the data

Definition at line 54 of file IPEndpoint.h.

Referenced by IPEndpoint(), UDPEndpoint::send(), TCPEndpoint::send(), TCPEndpoint::sendCont(), and TCPEndpoint::sendSendMessage().

int IPEndpoint::sharedSendBufferSize [protected]

size of the sendBuffer

Definition at line 55 of file IPEndpoint.h.

Referenced by IPEndpoint(), TCPEndpoint::send(), TCPEndpoint::sendCont(), and UDPEndpoint::UDPEndpoint().


The documentation for this class was generated from the following files:
Generated on Thu Dec 7 01:39:24 2006 for DT2005.panorama by  doxygen 1.4.7