class CAVERNnet_udpReflector_c : public CAVERNnet_socketbase_c

UDP and Multicast Reflector class

Inheritance:

Public Methods

int	init () Initialize the reflector once all the parameters are set up
void	setIncomingPort (unsigned short port = 6000) Set the incoming port for the reflector to listen on
void	setTimeOutTime (int secs) Set the time out time when connected clients who have not sent any data for a while will be removed
void	setForcedDestination (char *ipAddr, unsigned short port) Set a single ip address and port number to which all packets will be sent.
void	setMulticastAddress (char *ipAddr, unsigned short port) Set up to also listen on a multicast address and port
void	setMulticastTTL (int ttl) Set multicast TTL to something other than the default at 160
int	process () Call this within a while loop to let the reflector continuously do its processing
void	intercept (int (*callback) (CAVERNnet_udp_c *client, char** buffer, int *bufferSize, void *userData), void* userData) Intercept incoming messages and call a user-defined callback function
void	enableInstrumentation () Enable instrumentation - this is for turning on the performance monitoring for the UDPsocket used -instrumentation for the udp sockets are turned off by default - and it should be explicitly enabled for latency, jitter and related statistics
void	disableInstrumentation () Disable instrumentation - this is for turning off the performance monitoring for the UDPsocket used
void	showStats (char* streamInfo, char* comment) Displays the resultant statistics instantaneously in the netlogger format - this should be typically done after a read/write is done a network
int	logStats (char* streamInfo, char* comment, FILE* filePtr) This logs performance statistics in a file
int	sendStats (char* streamInfo, char* comment) Sends the performance statistics to a remote perfdaemon -for further analysis of the monitored data - the initSendStats API should be called first, before calling a sendStats (In order to connect to the perfdaemon initially)
int	initSendStats (char* monitorClientIP, int port = PERF_DAEMON_DEFAULT_PORT) Initialize sendStats - provide the IP of the perfDaemon and an optional port number to connect to
void	exitSendStats () Properly delete the perfDaemonClient after sendStats is done

Public

static const int FAILED Status Failed static const int OK Status Ok. static const int SKIP_DISTRIBUTION Skip the data distribution process. Used in user callback. See intercept().

Inherited from CAVERNnet_socketbase_c:

Public Methods

static int hostnameToIP(char *hostname, char* hostIP)

static void ipNumToString(unsigned int ip, char *ipstring)

static double getTimeInSecs()

static void getHostName(char *name, int len)

static void expandHostName(char *src, char *newname, int len)

unsigned int getTotalDataSent()

unsigned int getTotalDataRead()

double getInstantReceiveBandwidth()

double getInstantSendBandwidth()

double getAverageReceiveBandwidth()

double getAverageSendBandwidth()

void setInstantLatency(double lat)

double getInstantLatency()

double getAverageLatency()

double getMaxLatency()

double getMinLatency()

void incrementDataSent(unsigned long size)

void incrementDataRead(unsigned long size)

double getInstantInterMesgDelay()

double getMaxInterMesgDelay()

double getMinInterMesgDelay()

double getAverageInterMesgDelay()

double getSTABandwidth()

double getSTALatency()

double getBurstiness()

double getJitter()

unsigned long getPacketsRead()

unsigned long getPacketsSent()

virtual int getSocketId()

int selectSock(void *ptr, int *status, int numSocks, struct timeval *timeout)

Protected Methods

void computeInstantSendBandwidth()

void computeInstantReceiveBandwidth()

void computeAverageReceiveBandwidth()

void computeAverageSendBandwidth()

void calculateJitter(double lat)

void calculateBurstiness(double bw)

int init()

Initialize the reflector once all the parameters are set up. If you need to change the settings at a later time you need to delete this object and create a new one with the new settings.

Returns:

FAILED if failed; OK if success.

void setIncomingPort(unsigned short port = 6000)

Set the incoming port for the reflector to listen on. Default is set at 6000

void setTimeOutTime(int secs)

Set the time out time when connected clients who have not sent any data for a while will be removed. Default is set at 60 seconds.

void setMulticastAddress(char *ipAddr, unsigned short port)

Set up to also listen on a multicast address and port. This means that any incoming packets on the UDP connection will get broadcasted via this reflector to the multicast channel too.

int process()

Call this within a while loop to let the reflector continuously do its processing

Returns:

FAILED if error; OK if success.

void intercept(int (*callback) (CAVERNnet_udp_c *client, char** buffer, int *bufferSize, void *userData), void* userData)

Intercept incoming messages and call a user-defined callback function. If you want you can also alter the buffer completely so that the reflector will reflect an entirely different message. You can do this by changing the contents of the buffer or by replacing the buffer entirely by allocating memory for a new buffer and stuffing it with your own data. If you choose to allocate a totally new buffer you must remember to deallocate memory for the original buffer before substituting it with yours. If after your callback function exits you do not wish the reflector to forward the contents of the buffer, return with CAVERNnet_udpReflector_c::SKIP_DISTRIBUTION. Otherwise just return CAVERNnet_udpReflector_c::OK.

Note also that the callback function will also be given a pointer to a CAVERNnet_udp_c object that can then be used to send data directly to the client that originally sent the message.

void showStats(char* streamInfo, char* comment)

Displays the resultant statistics instantaneously in the netlogger format - this should be typically done after a read/write is done a network.

Also, it should be noted that a showStats call should be made at the end of atleast one send and receive for two-way information (the same applies for logStats and sendStats)

Parameters:

streamInfo - A label describing the stream that is being monitored.
comment - A comment on the event that marks the time at which the stream is being monitored

int logStats(char* streamInfo, char* comment, FILE* filePtr)

This logs performance statistics in a file. The user opens a file and passes the file pointer with this function and results of monitoring are written into the logfile.

Returns:

Either CAVERNnet_perfMonitor_c::OK or CAVERNnet_perfMonitor_c::FAILED

Parameters:

streamInfo - A label describing the stream that is being monitored.
comment - A comment on the event that marks the time at which the stream is being monitored
filePtr - File pointer to the file in which the results of monitoring are to be stored

int sendStats(char* streamInfo, char* comment)

Sends the performance statistics to a remote perfdaemon -for further analysis of the monitored data - the initSendStats API should be called first, before calling a sendStats (In order to connect to the perfdaemon initially)

Returns:

Either CAVERNnet_perfMonitor_c::OK or CAVERNnet_perfMonitor_c::FAILED

Parameters:

streamInfo - A label describing the stream that is being monitored.
comment - A comment on the event that marks the time at which the stream is being monitored

int initSendStats(char* monitorClientIP, int port = PERF_DAEMON_DEFAULT_PORT)

Initialize sendStats - provide the IP of the perfDaemon and an optional port number to connect to. This should be done initially before using the sendStats API.

Returns:

Either CAVERNnet_perfMonitor_c::OK or CAVERNnet_perfMonitor_c::FAILED

Parameters:

monitorClientIP - IP address of the perfDameon to connect to
port - Port number at which the perfDaemon is running -this is optional. The default port number for perfDaemon is 9500 -so a different port number has to be specified if the perfDaemon is running ona different port.

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