Sink, Xml message format, Xmlformatting – Wavecom W-RCI (Remote Control) V8.7.0 User Manual

Page 60

Advertising
background image

52

TCP/IP Interface

XML SDK V8.7.0 Remote Control Interface

empty, this value is ignored.

void Disconnect()

Disconnects from the specified server.

void SendXMLMessage(const void* pMessage, size_t unMsgSize)

Sends a XML message to the server.
Return Value
Returns true if successful or false if not successful.
Parameters

Parameter

Definition

pMessage

Pointer to the XML message

unMsgSize

The size of the XML message in Bytes

Sink

class CXMLRCISink
{
public:
virtual void ReceiveXMLMessage(const void* pMessage, const int nMsgSize) = 0;
virtual void Connected() = 0;
virtual void Disconnected() = 0;
virtual void Timeout() = 0;
};

Parent class for the sink implementation of the client application. It contains four callback routines. A
pointer to an instance of this class must be passed to the source.

void ReceiveXMLMessage(const void* pMessage, size_t unMsgSize)

A callback routine for XML messages from the server.
Parameters

Parameter

Definition

strMessage

The message in XML format

unMsgSize

The message size in bytes

void Connected()

After the connect command has been issued some time passes until a connection is established. This mes-
sage is called by the API when the connection is actually established. It is a callback routine.

void Diconnected()

If the link to the server is broken or stopped, this function is called by the API. It is a callback routine.

void Timeout()

If the link to the server cannot be established, this message is called by the API. It is a callback routine.

XML Message Format

This parameter is passed from the client to the server during initialization. It specifies how the server will
format XML messages which are sent to the client.

Note: This parameter has no effect on the messages sent to the server.

XMLFormatting

Advertising
This manual is related to the following products: