Wavecom W-RCI (Remote Control) V8.7.0 - Manual (Page 57)

XML SDK V8.7.0 Remote Control Interface TCP/IP Interface

49
C Application Programming Interface
Source
RCI_HANDLE Start(XMLRCI_SINK_FUNCTION_TYPE pFunction,
XMLRCI_CONNECTED_FUNCTION_TYPE pConnect,
XMLRCI_DISCONNECTED_FUNCTION_TYPE pDisconnect,
XMLRCI_TIMOUT_FUNCTION_TYPE pTimeout,
const char* strUsr, const char* strPwd, const XMLFormattingC *pFormat);
void Stop(RCI_HANDLE hRci);
bool Connect(const char* strIPAddress, const char* strPort, RCI_HANDLE hRci);
void Disconnect(RCI_HANDLE hRci);
bool SendXMLMessage(const void* pMessage, size_t unMsgSize, RCI_HANDLE hRci);
void SetUserParameter(RCI_HANDLE hRci, void *pParam);
void *GetUserParameter(RCI_HANDLE hRci);
The parameter hRci is the value which was returned by the Start method. It identifies the user within this
API.
RCI_HANDLE
Start(…)
RCI_HANDLE Start(XMLRCI_SINK_FUNCTION_TYPE pFunction,
XMLRCI_CONNECTED_FUNCTION_TYPE pConnect,
XMLRCI_DISCONNECTED_FUNCTION_TYPE pDisconnect,
XMLRCI_TIMOUT_FUNCTION_TYPE pTimeout,
const char* strUsr, const char* strPwd,
const XMLFormattingC *pFormat);
This function starts a session with the specified user.
Return Value
Returns a handle to the instance of the RCI connection.
Parameters
Parameter Definition
pFunction Function pointer to the Sink method
pConnect Function pointer to the Connected method
pDisconnect Function Pointer to the Disconnected method
pTimeout Function Pointer to the Timeout method
strUser Username
strPwd Password
Format: See section ” XML Message Format ” on page 52
void Stop(RCI_HANDLE hRci)
Stops a session and destroys the connection instance. The handle may not be used anymore after calling
this function.
void Connect(const char* strAddress, const char* strPort, RCI_HANDLE hRci)
Connects to the specified server.
Return Value
None.
Parameters
Parameter Definition
strAddress The IP address or DNS name of the host on which the server runs. If the string is emp-