Message API documentation

Version: beta

FUNCTION
ResetUrl() Resets the given URL to default values.
GetSocket() Get the message socket
SetSocket() Set the socket
IsSocketValid() Tests if a socket is valid (not deleted).
GetSocketName() Get socket name
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 dmMessage::URL URL to reset

GetSocket()

GetSocket(url)

Get the message socket

PARAMETERS

url dmMessage::URL url

RETURNS

socket dmMessage::HSocket

SetSocket()

SetSocket(url,socket)

Set the socket

PARAMETERS

url dmMessage::URL url
socket dmMessage::HSocket

IsSocketValid()

IsSocketValid(socket)

Tests if a socket is valid (not deleted).

PARAMETERS

socket dmMessage::HSocket Socket

RETURNS

result bool if the socket is valid or not

GetSocketName()

GetSocketName(socket)

Get socket name

PARAMETERS

socket dmMessage::HSocket Socket

RETURNS

name const char* socket name. 0 if it was not found

GetPath()

GetPath(url)

Get the message path

PARAMETERS

url dmMessage::URL url

RETURNS

path dmhash_t

SetPath()

SetPath(url,path)

Set the message path

PARAMETERS

url dmMessage::URL url
path dmhash_t

GetFragment()

GetFragment(url)

Get the message fragment

PARAMETERS

url dmMessage::URL url

RETURNS

fragment dmhash_t

SetFragment()

SetFragment(url,fragment)

Set the message fragment

PARAMETERS

url dmMessage::URL url
fragment dmhash_t

ParseUrl()

ParseUrl(uri,out)

Convert a string to a URL struct

PARAMETERS

uri const char*] string of the format [socket:][path][#fragment
out dmMessage::StringUrl url in string format, must not be 0x0

RETURNS

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