IPEndpoint Class Reference

This class is used to encapsule ANT library entpoints. More...

#include <IPEndpoint.h>

Inheritance diagram for IPEndpoint:

[legend]List of all members.

Public Member Functions
	IPEndpoint (int sbs=16384, int rbs=16384)
	Constructor.
	~IPEndpoint ()
virtual void	listenCont (antEnvMsg *msg)
	called by the processFramework if someone connects to a listen port
virtual void	sendCont (antEnvMsg *msg)
	called by the processFramework if data was send.
virtual void	receiveCont (antEnvMsg *msg)
	called by the processFramework if new data arrives
virtual void	closeCont (antEnvMsg *msg)
	called by the processFreamwork after a close
virtual void	connectCont (antEnvMsg *msg)
	called by the processFramework after connecting
Protected Attributes
antModuleRef	endpoint
	ANT Library Endpoint.
antSharedBuffer	sendBuffer
	ANT buffer for sending.
byte *	sharedSendBuffer
	Pointer to the data.
int	sharedSendBufferSize
	size of the sendBuffer
int	sharedReceiveBufferSize
	size of the receiveBuffer
antSharedBuffer	receiveBuffer
	ANT buffer for receiving.
byte *	sharedReceiveBuffer
	pointer to the data received
int *	listenContSelector
	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.
int *	sendContSelector
int *	receiveContSelector
int *	closeContSelector
int *	connectContSelector
antStackRef	ipStackRef
	handle to comminicate to the ip-stack (ANT library
OID *	myOID_
	Object id of this process.

---

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, and sharedSendBufferSize.

Here is the call graph for this function:

IPEndpoint::~IPEndpoint (   )

Definition at line 68 of file IPEndpoint.cpp. References receiveBuffer, and sendBuffer.

---

Member Function Documentation

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::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.

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::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.

---

Member Data Documentation

antModuleRef IPEndpoint::endpoint [protected]

ANT Library Endpoint. Definition at line 52 of file IPEndpoint.h.

antSharedBuffer IPEndpoint::sendBuffer [protected]

ANT buffer for sending. Definition at line 53 of file IPEndpoint.h. Referenced by IPEndpoint(), and ~IPEndpoint().

byte* IPEndpoint::sharedSendBuffer [protected]

Pointer to the data. Definition at line 54 of file IPEndpoint.h. Referenced by IPEndpoint().

int IPEndpoint::sharedSendBufferSize [protected]

size of the sendBuffer Definition at line 55 of file IPEndpoint.h. Referenced by IPEndpoint().

int IPEndpoint::sharedReceiveBufferSize [protected]

size of the receiveBuffer Definition at line 56 of file IPEndpoint.h. Referenced by IPEndpoint().

antSharedBuffer IPEndpoint::receiveBuffer [protected]

ANT buffer for receiving. Reimplemented in TCPHandler. Definition at line 58 of file IPEndpoint.h. Referenced by IPEndpoint(), and ~IPEndpoint().

byte* IPEndpoint::sharedReceiveBuffer [protected]

pointer to the data received Definition at line 59 of file IPEndpoint.h. Referenced by IPEndpoint().

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().

int* IPEndpoint::sendContSelector [protected]

Definition at line 69 of file IPEndpoint.h. Referenced by IPEndpoint().

int* IPEndpoint::receiveContSelector [protected]

Definition at line 70 of file IPEndpoint.h. Referenced by IPEndpoint().

int* IPEndpoint::closeContSelector [protected]

Definition at line 71 of file IPEndpoint.h. Referenced by IPEndpoint().

int* IPEndpoint::connectContSelector [protected]

Definition at line 72 of file IPEndpoint.h. Referenced by IPEndpoint().

antStackRef IPEndpoint::ipStackRef [protected]

handle to comminicate to the ip-stack (ANT library Definition at line 75 of file IPEndpoint.h. Referenced by IPEndpoint().

OID* IPEndpoint::myOID_ [protected]

Object id of this process. Definition at line 76 of file IPEndpoint.h. Referenced by IPEndpoint().

---

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

• Platform/Aperios1.3.2/IPEndpoint.h
• Platform/Aperios1.3.2/IPEndpoint.cpp

---