AppClient

class AppClient

Application client API.

Inheritance:

Public Methods
virtual ~AppClient(void): Destructor.
AppClient(void): Default constructor.
error_t request(const MsgAddr& to, const Message& req, MsgHeader& hdr, char* data, index_t length): Send a request message to a server and wait for the reply.
error_t request(const MsgHeader& ReqHdr, const void* ReqData, MsgHeader& hdr, char* data, index_t length): Send a request message to a server and wait for the reply.
error_t request(const MsgAddr& to, const Message& Req, Message& Reply): Send a request message to a server and wait for the reply.
error_t request(const MsgAddr& to, const Message& Req, MsgHeader& RepHdr, Message& Reply): Send a request message to a server and wait for the reply.
error_t getDebug(void) const: Get the debug flag.
error_t getRetry(void) const: Get number of retries.
wtime_t getTimeOut(void) const: Maximum response time.
bool isOpen(void) const: Test whether Client is open.
void setBufferPool(BufferPool* pool): Select a buffer pool.
void setDebug(index_t level): Set the debug flag.
void setRetry(index_t n): Set the maximum number of retries..
void setTimeOut(wtime_t time): Set the maximum response time.
void setSocketPool(SocketPool* pool): Select a socket pool.

Documentation

The client application class provides a generic client API. AppClient provides the primitive client request operation and server name resolution functions. If a server does not reply to a request within a specified amount of time, the request is retried. A transaction ID is sent with the request and returned with the reply. The client API verifies that the trasaction ID of the reply is correct. The port used by the client API is allocated dynamically from a specified socket pool or from the defaul pool. If a request fails. the socket is deleted and a new socket is allocated to retry the request. In non-linux systems, the socket is logically connected to the server socket before the request is made. This allows the client to receive notification if the server socket is not available.

virtual ~AppClient(void)

Client destructor.

AppClient(void)

Construct a disconnected client interface.

error_t request(const MsgAddr& to, const Message& req, MsgHeader& hdr, char* data, index_t length)

Send a request message to the specified server and wait for a reply. If no reply is received in the specified timeout period, the request is resent. The reply header and message are stored in the buffers provided by the user.

Returns:: Error code from lmsg::ErrorList.
Parameters:: to - Address of server to handle request.
req - Request message.
hdr - Reply header.
data - Pointer to buffer to receive reply text.
length - Length of reply buffer.

error_t request(const MsgHeader& ReqHdr, const void* ReqData, MsgHeader& hdr, char* data, index_t length)

Returns:: Error code from lmsg::ErrorList.
Parameters:: ReqHdr - Request header (with destination, type, length).
ReqData - Request message text.
hdr - Reply header.
data - Pointer to buffer to receive reply text.
length - Length of reply buffer.

error_t request(const MsgAddr& to, const Message& Req, Message& Reply)

Returns:: Error code from lmsg::ErrorList.
Parameters:: to - Request header (including det, type, length).
Req - Request message.
Reply - Reply message.

error_t request(const MsgAddr& to, const Message& Req, MsgHeader& RepHdr, Message& Reply)

Returns:: Error code from lmsg::ErrorList.
Parameters:: to - Request header (including det, type, length).
Req - Request message.
RepHdr - Reply message header.
Reply - Reply message.

error_t getDebug(void) const