cis_config
Public Member Functions | List of all members
PsiRpcClient Class Reference

C++ interface to psiRpc_t client-side functionality. More...

#include <PsiInterface.hpp>

Inheritance diagram for PsiRpcClient:
PsiRpc

Public Member Functions

 PsiRpcClient (const char *name, char *outFormat, char *inFormat)
 Constructor for PsiRpcClient. More...
 
int call (int nargs,...)
 Send request to an RPC server from the client and wait for a response. See rpcCall in PsiInterface.h for details. More...
 
- Public Member Functions inherited from PsiRpc
 PsiRpc (const char *outName, char *outFormat, const char *inName, char *inFormat)
 Constructor for PsiRpc. More...
 
psiRpc_t pi ()
 Return the psiRpc_t structure. More...
 
int send (int nargs,...)
 Format and send a message to an RPC output queue. See rpcSend from PsiInterface.h for details. More...
 
int recv (int nargs,...)
 Receive and parse a message from an RPC input queue. See rpcRecv from PsiInterface.h for details. More...
 

Detailed Description

C++ interface to psiRpc_t client-side functionality.

The PsiRpcClient class is a basic wrapper around the C psiRpc_t structure and associated client-side functions from the PsiInterface.h header. It provides the user with C++ style access to basic RPC client operations.

Constructor & Destructor Documentation

◆ PsiRpcClient()

PsiRpcClient::PsiRpcClient ( const char *  name,
char *  outFormat,
char *  inFormat 
)
inline

Constructor for PsiRpcClient.

Parameters
[in]nameconstant character pointer name used for input and output queues.
[in]outFormatcharacter pointer to format that should be used for formatting output.
[in]inFormatcharacter pointer to format that should be used for parsing input.

Member Function Documentation

◆ call()

int PsiRpcClient::call ( int  nargs,
  ... 
)
inline

Send request to an RPC server from the client and wait for a response. See rpcCall in PsiInterface.h for details.

Parameters
[in]nargsint Number of arguments being passed.
[in,out]...mixed arguments that include those that should be formatted using the output format string, followed by those that should be assigned parameters extracted using the input format string. These that will be assigned should be pointers to memory that has already been allocated.
Returns
integer specifying if the receive was succesful. Values >= 0 indicate success.

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