Message API documentation

Version: stable

FUNCTIONS
GetFragment() Get the message fragment
GetPath() Get the message path
GetSocket() Get the message socket
GetSocketName() Get socket name
GetSocketNameHash() Get socket name hash
IsSocketValid() Tests if a socket is valid (not deleted).
ParseUrl() Convert a string to a URL struct
ResetUrl() Resets the given URL to default values.
SetFragment() Set the message fragment
SetPath() Set the message path
SetSocket() Set the socket
ENUMS
dmMessage::Result Result enum

Functions

GetFragment()

GetFragment(url)

Get the message fragment

PARAMETERS

url dmMessage::URL url

RETURNS

fragment dmhash_t

GetPath()

GetPath(url)

Get the message path

PARAMETERS

url dmMessage::URL url

RETURNS

path dmhash_t

GetSocket()

GetSocket(url)

Get the message socket

PARAMETERS

url dmMessage::URL url

RETURNS

socket dmMessage::HSocket

GetSocketName()

GetSocketName(socket)

Get socket name

PARAMETERS

socket dmMessage::HSocket Socket

RETURNS

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

GetSocketNameHash()

GetSocketNameHash(socket)

Get socket name hash

PARAMETERS

socket dmMessage::HSocket Socket

RETURNS

name_hash dmhash_t socket name hash. 0 if it was not found

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

ParseUrl()

ParseUrl(uri,out)

Convert a string to a URL struct

PARAMETERS

uri const char* string of the format ][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

ResetUrl()

ResetUrl(url)

Resets the given URL to default values.

PARAMETERS

url dmMessage::URL URL to reset

SetFragment()

SetFragment(url,fragment)

Set the message fragment

PARAMETERS

url dmMessage::URL url
fragment dmhash_t

SetPath()

SetPath(url,path)

Set the message path

PARAMETERS

url dmMessage::URL url
path dmhash_t

SetSocket()

SetSocket(url,socket)

Set the socket

PARAMETERS

url dmMessage::URL url
socket dmMessage::HSocket