class CAVERNnet_rpcCaller_c

Remote Procedure Caller class

Public Methods

int init (char *remoteProcedureName, char* ipAddress, int destPort=CAVERNnet_rpcManager_c::DEFAULT_PORT)
Initialize RPC
int call (char *outdata, int outlen, char** retdata, int *retlen)
Remote procedure call
int call1way (char *outdata, int outlen)
1 way RPC
void setTimeOut (int timeout = CAVERNnet_rpcCaller_c::NEVER_TIME_OUT)
Set the timeout time waiting for a reply from an RPC
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 NEVER_TIME_OUT
Use to set RPCs to never time out.
static const int FAILED
RPC Failed
static const int OK
RPC Ok
static const int MEM_ALLOC_ERR
Mem alloc error in RPC

Documentation

Remote Procedure Caller class. Use this to call the remote RPC manager.

int init(char *remoteProcedureName, char* ipAddress, int destPort=CAVERNnet_rpcManager_c::DEFAULT_PORT)
Initialize RPC
Returns:
OK or MEM_ALLOC_ERR
Parameters:
remoteProcedureName - name of remote procedure
ipAddress - ip address of rpc server.
destPort - destination port of rpc server.

int call(char *outdata, int outlen, char** retdata, int *retlen)
Remote procedure call
Returns:
OK or MEM_ALLOC_ERR or FAILED
Parameters:
outdata - outgoing data
outlen - outgoing data size
retdata - incoming return data
retlen - incoming return data size

int call1way(char *outdata, int outlen)
1 way RPC. Ie a remote call without a reply.
Returns:
OK or FAILED
Parameters:
outdata - outgoing data
outlen - outgoing data size

void setTimeOut(int timeout = CAVERNnet_rpcCaller_c::NEVER_TIME_OUT)
Set the timeout time waiting for a reply from an RPC
Parameters:
timeout - is either CAVERNnet_rpcClient_c::NEVER_TIME_OUT or time in seconds.

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.

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