Message API documentation

Version: alpha

FUNCTION
ResetUrl() Resets the given URL to default values.
GetSocket() Get the message socket
SetSocket() Set the socket
GetPath() Get the message path
SetPath() Set the message path
GetFragment() Get the message fragment
SetFragment() Set the message fragment
ParseUrl() Convert a string to a URL struct
ENUMS
dmMessage::Result Result enum

Functions

ResetUrl()

ResetUrl(url)

Resets the given URL to default values.

PARAMETERS

url URL to reset

GetSocket()

GetSocket(url)

Get the message socket

PARAMETERS

url url

RETURNS

socket

SetSocket()

SetSocket(url,socket)

Set the socket

PARAMETERS

url url
socket

GetPath()

GetPath(url)

Get the message path

PARAMETERS

url url

RETURNS

path

SetPath()

SetPath(url,path)

Set the message path

PARAMETERS

url url
path

GetFragment()

GetFragment(url)

Get the message fragment

PARAMETERS

url url

RETURNS

fragment

SetFragment()

SetFragment(url,fragment)

Set the message fragment

PARAMETERS

url url
fragment

ParseUrl()

ParseUrl(uri,out)

Convert a string to a URL struct

PARAMETERS

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

RETURNS

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

Enums

dmMessage::Result

Result enum

Result enum

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