Message

Api for sending messages

dmMessage::Result

Result enum

Result enum

MEMBERS

RESULT_OK - = 0

RESULT_SOCKET_EXISTS - = -1

RESULT_SOCKET_NOT_FOUND - = -2

RESULT_SOCKET_OUT_OF_RESOURCES - = -3

RESULT_INVALID_SOCKET_NAME - = -4

RESULT_MALFORMED_URL - = -5

RESULT_NAME_OK_SOCKET_NOT_FOUND - = -6


HSocket

Socket handle

Socket handle


dmMessage::URL()

URL specifying a sender/receiver of messages

URL specifying a sender/receiver of messages


dmMessage::StringURL

Helper struct for parsing a string of the form "so...

Helper struct for parsing a string of the form "socket:path#fragment"

MEMBERS

m_Socket - The socket

m_SocketSize - The socket length

m_Path - The path

m_PathSize - The path length

m_Fragment - The fragment

m_FragmentSize - The fragment length


ResetUrl(url)

Resets the given URL to default values.

Resets the given URL to default values.

PARAMETERS

url - URL to reset


GetSocket(url)

Get the message socket

Get the message socket

PARAMETERS

url - url

RETURN

socket -


SetSocket(url, socket)

Set the socket

Set the socket

PARAMETERS

url - url

socket -


IsSocketValid(socket)

Tests if a socket is valid (not deleted).

Tests if a socket is valid (not deleted).

PARAMETERS

socket - Socket

RETURN

result - if the socket is valid or not


GetSocketName(socket)

Get socket name

Get socket name

PARAMETERS

socket - Socket

RETURN

name - socket name. 0 if it was not found


GetPath(url)

Get the message path

Get the message path

PARAMETERS

url - url

RETURN

path -


SetPath(url, path)

Set the message path

Set the message path

PARAMETERS

url - url

path -


GetFragment(url)

Get the message fragment

Get the message fragment

PARAMETERS

url - url

RETURN

fragment -


SetFragment(url, fragment)

Set the message fragment

Set the message fragment

PARAMETERS

url - url

fragment -


Message()


dmMMessage::MessageDestroyCallback

A callback for messages that needs cleanup after b...

A callback for messages that needs cleanup after being dispatched. E.g. for freeing resources/memory.


Message()

Message data desc used at dispatch callback. When ...

Message data desc used at dispatch callback. When a message is posted, the actual object is copied into the sockets internal buffer.

MEMBERS

m_Sender - Sender uri

m_Receiver - Receiver uri

m_Id - Unique id of message

m_UserData1 - User data pointer

m_UserData2 - User data pointer

m_Descriptor - User specified descriptor of the message data

m_DataSize - Size of message data in bytes

m_Next - Ptr to next message (or 0 if last)

m_DestroyCallback - If set, will be called after each dispatch

m_Data - Payload


ParseUrl(uri, out)

Convert a string to a URL struct

Convert a string to a URL struct

PARAMETERS

uri - string of the format ][path[#fragment]

out - url in string format, must not be 0x0

RETURN

- - RESULT_OK on success - RESULT_MALFORMED_URL if the uri could not be parsed