CASA IPC Client API changes to support multiple remote endpoints.
This commit is contained in:
parent
960d27db69
commit
36f82820c1
@ -45,7 +45,133 @@
|
|||||||
|
|
||||||
|
|
||||||
//++=======================================================================
|
//++=======================================================================
|
||||||
extern "C"
|
extern
|
||||||
|
int
|
||||||
|
IpcClientOpenUnixRemoteEndPoint(
|
||||||
|
IN char *pSocketFileName,
|
||||||
|
IN int maxRpcRetries,
|
||||||
|
INOUT uint32_t *pEndPointHandle);
|
||||||
|
//
|
||||||
|
// Arguments In: port - Server's listening port number.
|
||||||
|
//
|
||||||
|
// address - The server's IP Address. Use
|
||||||
|
// 0x7F000001 if the server is local.
|
||||||
|
//
|
||||||
|
// maxRpcRetries - Maximum number of Rpc retries that
|
||||||
|
// should be utilized when submitting
|
||||||
|
// a request to the endpoint. A value
|
||||||
|
// of zero requests that the default
|
||||||
|
// setting be utilized.
|
||||||
|
//
|
||||||
|
// Arguments Out: pEndPointHandle - Pointer to variable that will receive
|
||||||
|
// the endpoint handle.
|
||||||
|
//
|
||||||
|
// Returns: 0 == Success
|
||||||
|
// -1 == Failure
|
||||||
|
//
|
||||||
|
// Abstract: Method to open a UNIX (PF_UNIX) remote endpoint.
|
||||||
|
//
|
||||||
|
// Note: The service should have been initialized before calling
|
||||||
|
// this procedure.
|
||||||
|
//
|
||||||
|
//=======================================================================--
|
||||||
|
|
||||||
|
|
||||||
|
//++=======================================================================
|
||||||
|
extern
|
||||||
|
int
|
||||||
|
IpcClientOpenInetRemoteEndPoint(
|
||||||
|
IN unsigned short int port,
|
||||||
|
IN uint32_t address,
|
||||||
|
IN int maxRpcRetries,
|
||||||
|
INOUT uint32_t *pEndPointHandle);
|
||||||
|
//
|
||||||
|
// Arguments In: port - Server's listening port number.
|
||||||
|
//
|
||||||
|
// address - The server's IP Address. Use
|
||||||
|
// 0x7F000001 if the server is local.
|
||||||
|
//
|
||||||
|
// maxRpcRetries - Maximum number of Rpc retries that
|
||||||
|
// should be utilized when submitting
|
||||||
|
// a request to the endpoint. A value
|
||||||
|
// of zero requests that the default
|
||||||
|
// setting be utilized.
|
||||||
|
//
|
||||||
|
// Arguments Out: pEndPointHandle - Pointer to variable that will receive
|
||||||
|
// the endpoint handle.
|
||||||
|
//
|
||||||
|
// Returns: 0 == Success
|
||||||
|
// -1 == Failure
|
||||||
|
//
|
||||||
|
// Abstract: Method to open a TCP (AF_INET) remote endpoint.
|
||||||
|
//
|
||||||
|
// Note: The service should have been initialized before calling
|
||||||
|
// this procedure.
|
||||||
|
//
|
||||||
|
//=======================================================================--
|
||||||
|
|
||||||
|
|
||||||
|
//++=======================================================================
|
||||||
|
extern
|
||||||
|
int
|
||||||
|
IpcClientCloseRemoteEndPoint(
|
||||||
|
IN uint32_t endPointHandle);
|
||||||
|
//
|
||||||
|
// Arguments In: endpointHandle - Handle of the endpoint being closed.
|
||||||
|
//
|
||||||
|
//
|
||||||
|
// Arguments Out: None.
|
||||||
|
// the endpoint handle.
|
||||||
|
//
|
||||||
|
// Returns: 0 == Success
|
||||||
|
// -1 == Failure
|
||||||
|
//
|
||||||
|
// Abstract: Method to close a remote endpoint.
|
||||||
|
//
|
||||||
|
// Note: The service should have been initialized before calling
|
||||||
|
// this procedure.
|
||||||
|
//
|
||||||
|
//=======================================================================--
|
||||||
|
|
||||||
|
|
||||||
|
//++=======================================================================
|
||||||
|
extern
|
||||||
|
int
|
||||||
|
IpcClientSubmitReq(
|
||||||
|
IN uint32_t endPointHandle,
|
||||||
|
IN char *pClientData,
|
||||||
|
IN int clientDataLen,
|
||||||
|
INOUT char **ppServerData,
|
||||||
|
INOUT int *pServerDataLen);
|
||||||
|
//
|
||||||
|
// Arguments In: endPointHandle - Handle of the remote endpoint that will
|
||||||
|
// be the target of the request.
|
||||||
|
//
|
||||||
|
// pClientData - Pointer to client data that must be sent to
|
||||||
|
// the server. Buffer is NEVER released by the
|
||||||
|
// procedure.
|
||||||
|
//
|
||||||
|
// clientDataLen - Length of the client data.
|
||||||
|
//
|
||||||
|
// Arguments Out: ppServerData - Pointer to variable that will receive a
|
||||||
|
// pointer to the buffer containing the data
|
||||||
|
// received from the server.
|
||||||
|
//
|
||||||
|
// pServerDataLen - Pointer to variable that will receive the
|
||||||
|
// length of the data received from the server.
|
||||||
|
//
|
||||||
|
// Returns: 0 == Request completed gracefully
|
||||||
|
// -1 == Request did not complete gracefully
|
||||||
|
//
|
||||||
|
// Abstract: Method to submit a request.
|
||||||
|
//
|
||||||
|
// Note: The routine blocks until the request completes.
|
||||||
|
//
|
||||||
|
//=======================================================================--
|
||||||
|
|
||||||
|
|
||||||
|
//++=======================================================================
|
||||||
|
extern
|
||||||
int
|
int
|
||||||
IpcClientInit(
|
IpcClientInit(
|
||||||
IN char *pName,
|
IN char *pName,
|
||||||
@ -82,7 +208,7 @@ IpcClientInit(
|
|||||||
|
|
||||||
|
|
||||||
//++=======================================================================
|
//++=======================================================================
|
||||||
extern "C"
|
extern
|
||||||
void
|
void
|
||||||
IpcClientShutdown(void);
|
IpcClientShutdown(void);
|
||||||
//
|
//
|
||||||
@ -90,94 +216,12 @@ IpcClientShutdown(void);
|
|||||||
//
|
//
|
||||||
// Arguments Out: None.
|
// Arguments Out: None.
|
||||||
//
|
//
|
||||||
// Returns: 0 == Success
|
// Returns: Nothing.
|
||||||
// -1 == Failure
|
|
||||||
//
|
//
|
||||||
// Abstract: Method to shutdown the IPC infrastructure for process.
|
// Abstract: Method to shutdown the IPC infrastructure for process.
|
||||||
//
|
//
|
||||||
//=======================================================================--
|
//=======================================================================--
|
||||||
|
|
||||||
|
|
||||||
//++=======================================================================
|
|
||||||
extern "C"
|
|
||||||
int
|
|
||||||
IpcClientSetUnAddress(
|
|
||||||
IN char *pSocketFileName);
|
|
||||||
//
|
|
||||||
// Arguments In: pSocketFileName - Pointer to string containing the name
|
|
||||||
// of the socket file.
|
|
||||||
//
|
|
||||||
// Arguments Out: None.
|
|
||||||
//
|
|
||||||
// Returns: 0 == Success
|
|
||||||
// -1 == Failure
|
|
||||||
//
|
|
||||||
// Abstract: Method to set the socket file name to utilize for
|
|
||||||
// communicating with the server via DOMAIN sockets.
|
|
||||||
//
|
|
||||||
// Note: The service should have been initialized before calling
|
|
||||||
// this procedure.
|
|
||||||
//
|
|
||||||
//=======================================================================--
|
|
||||||
|
|
||||||
|
|
||||||
//++=======================================================================
|
|
||||||
extern "C"
|
|
||||||
int
|
|
||||||
IpcClientSetInAddress(
|
|
||||||
IN unsigned short int serverPort,
|
|
||||||
IN uint32_t serverAddress);
|
|
||||||
//
|
|
||||||
// Arguments In: serverPort - Server's listening port number.
|
|
||||||
//
|
|
||||||
// serverAddress - The server's IP Address. Use
|
|
||||||
// 0x7F000001 if the server is local.
|
|
||||||
//
|
|
||||||
// Arguments Out: None.
|
|
||||||
//
|
|
||||||
// Returns: 0 == Success
|
|
||||||
// -1 == Failure
|
|
||||||
//
|
|
||||||
// Abstract: Method to set the address to utilize for communicating
|
|
||||||
// with the server via TCP sockets.
|
|
||||||
//
|
|
||||||
// Note: The service should have been initialized before calling
|
|
||||||
// this procedure.
|
|
||||||
//
|
|
||||||
//=======================================================================--
|
|
||||||
|
|
||||||
|
|
||||||
//++=======================================================================
|
|
||||||
extern "C"
|
|
||||||
int
|
|
||||||
IpcClientSubmitReq(
|
|
||||||
IN char *pClientData,
|
|
||||||
IN int clientDataLen,
|
|
||||||
INOUT char **ppServerData,
|
|
||||||
INOUT int *pServerDataLen);
|
|
||||||
//
|
|
||||||
// Arguments In: pClientData - Pointer to client data that must be sent to
|
|
||||||
// the server. Buffer is NEVER released by the
|
|
||||||
// procedure.
|
|
||||||
//
|
|
||||||
// clientDataLen - Length of the client data.
|
|
||||||
//
|
|
||||||
// Arguments Out: ppServerData - Pointer to variable that will receive a
|
|
||||||
// pointer to the buffer containing the data
|
|
||||||
// received from the server.
|
|
||||||
//
|
|
||||||
// pServerDataLen - Pointer to variable that will receive the
|
|
||||||
// length of the data received from the server.
|
|
||||||
//
|
|
||||||
// Returns: 0 == Request completed gracefully
|
|
||||||
// -1 == Request did not complete gracefully
|
|
||||||
//
|
|
||||||
// Abstract: Method to submit a request.
|
|
||||||
//
|
|
||||||
// Note: The routine blocks until the request completes.
|
|
||||||
//
|
|
||||||
//=======================================================================--
|
|
||||||
|
|
||||||
#endif // _IPCCLIENT_
|
#endif // _IPCCLIENT_
|
||||||
|
|
||||||
//=========================================================================
|
//=========================================================================
|
||||||
|
Loading…
Reference in New Issue
Block a user