Sending and receiving messages as a client.

Functions
SESSION_ID_T *	diffusion_request_context_get_session_id (const DIFFUSION_REQUEST_CONTEXT_T *request_context)
	Return a copy of the request context's session ID.
char *	diffusion_request_context_get_path (const DIFFUSION_REQUEST_CONTEXT_T *request_context)
	Return a copy of the request context's request path.
HASH_T *	diffusion_request_context_get_session_properties (const DIFFUSION_REQUEST_CONTEXT_T *request_context)
	Return a copy of the request context's session properties.
void	send_request_to_session (SESSION_T *session, SEND_REQUEST_TO_SESSION_PARAMS_T params)
	Send a request to a specific session.
void	add_request_handler (SESSION_T *session, ADD_REQUEST_HANDLER_PARAMS_T params)
	Add a server registered request handler.
void	send_request (SESSION_T *session, SEND_REQUEST_PARAMS_T params)
	Send a request to a path.
DIFFUSION_REQUEST_STREAM_T *	set_request_stream (SESSION_T *session, const char *path, DIFFUSION_DATATYPE request_datatype, DIFFUSION_DATATYPE response_datatype, const DIFFUSION_REQUEST_STREAM_T *request_stream)
	Set a request stream to handle requests to a specified path.
DIFFUSION_REQUEST_STREAM_T *	remove_request_stream (SESSION_T *session, const char *request_path)
	Remove a request stream bound to a specified path.

Detailed Description

Function Documentation

add_request_handler()

void add_request_handler	(	SESSION_T *	session,
		ADD_REQUEST_HANDLER_PARAMS_T	params
	)

Add a server registered request handler.

Parameters

session	The session handle. If NULL, this function returns immediately.
params	Parameters defining the request handler to be added.

diffusion_request_context_get_path()

char * diffusion_request_context_get_path

(

const DIFFUSION_REQUEST_CONTEXT_T *

request_context

)

Return a copy of the request context's request path.

free should be called on this pointer when no longer needed.

Parameters

request_context

the request context to retrieve the request path from.

Returns

a copy of the request context's request path. NULL, if request_context is NULL.

diffusion_request_context_get_session_id()

SESSION_ID_T * diffusion_request_context_get_session_id

(

const DIFFUSION_REQUEST_CONTEXT_T *

request_context

)

Return a copy of the request context's session ID.

session_id_free should be called on this pointer when no longer needed.

Parameters

request_context

the request context to retrieve the session ID from.

Returns

a copy of the request context's session ID. NULL, if request_context is NULL.

diffusion_request_context_get_session_properties()

HASH_T * diffusion_request_context_get_session_properties

(

const DIFFUSION_REQUEST_CONTEXT_T *

request_context

)

Return a copy of the request context's session properties.

hash_free should be called on this pointer when no longer needed.

Parameters

request_context

the request context to retrieve session properties from.

Returns

a copy of the request context's session properties. NULL, if request_context is NULL.

remove_request_stream()

DIFFUSION_REQUEST_STREAM_T * remove_request_stream	(	SESSION_T *	session,
		const char *	request_path
	)

Remove a request stream bound to a specified path.

Parameters

session	The session handle. If NULL, this function returns immediately.
request_path	The path at which to remove the request stream. If NULL, this function returns immediately.

Returns

the request stream that was removed. NULL, if there is no request stream bound to this path.

send_request()

void send_request	(	SESSION_T *	session,
		SEND_REQUEST_PARAMS_T	params
	)

Send a request to a path.

Parameters

session	The session handle. If NULL, this function returns immediately.
params	Parameters defining the request to be sent.

send_request_to_session()

void send_request_to_session	(	SESSION_T *	session,
		SEND_REQUEST_TO_SESSION_PARAMS_T	params
	)

Send a request to a specific session.

Parameters

session	The session handle. If NULL, this function returns immediately.
params	Parameters defining the request to send a request to a specific session.

set_request_stream()

DIFFUSION_REQUEST_STREAM_T * set_request_stream	(	SESSION_T *	session,
		const char *	path,
		DIFFUSION_DATATYPE	request_datatype,
		DIFFUSION_DATATYPE	response_datatype,
		const DIFFUSION_REQUEST_STREAM_T *	request_stream
	)

Set a request stream to handle requests to a specified path.

Parameters

session	The session handle. If NULL, this function returns immediately.
path	Path to receive requests on.
request_datatype	The request datatype.
response_datatype	The response datatype.
request_stream	Request stream to handle requests to this path

Returns

the current REQUEST_STREAM_T at this path. NULL, if this is the first stream to be set to the path.