Data Structures

Here are the data structures with brief descriptions:

_semaphore_internal
add_topic_handlers_s
add_topic_params_s	Structure passed when adding a topic
arg_opts_s	This structure represents a possible argument to an application
authentication_deregistration_handlers_s
authentication_deregistration_params_s	Structure supplied when issuing an authentication_deregister() request
authentication_handlers_s
authentication_params_s	Parameters supplied when registering this authentication handler which are required for the authentication process but not related to the registration itself
authentication_registration_handlers_s
authentication_registration_params_s	Structure supplied when issuing an authentication_register() request
buf_s	A buffer for holding arbitrarily terminated byte arrays
change_principal_handlers_s
change_principal_params_s	Structure supplied when issuing a change_principal() request
CONNECTION_RESPONSE_T
connector_details_s	This structure is populated in the authentication request when the detail type SESSION_DETAIL_CONNECTOR_NAME has been requested
content_s	Content wrapper for encoding and data
conversation_id_s	Structure representing a conversation ID
credentials_s	This structure is used for passing credentials around in the API
diffusion_error_s	A structure which is filled by the API when an error occurs
dpt_message_s	Generic message; all DPT messages should fit into this structure
error_report_s	Structure describing an error report which may arise when calling various API functions
fetch_handlers_s
fetch_params_s	Structure supplied to a fetch() request
get_security_store_params_s	Structure passed when requesting the security store
get_session_properties_params_s
get_system_authentication_store_params_s	Structure passed when requesting the system authentication store
handler_set_s	A handler set is registered against a conversation id and contains function pointers to callback handlers related to that conversation
hash_entry_s	This structure represents an entry within a hash table
hash_s	This represents a hash table
list_node_s	Structure representing a node in a linked list
list_s	A structure defining a linked list
location_details_s	This structure describes the network and physical location of a client/session
missing_topic_handlers_s
missing_topic_params_s	Structure supplied when registering to receive missing topic notifications
msg_listener_deregistration_params_s	Structure supplied when deregistering a message listener
msg_listener_registration_params_s	Structure supplied when registering a message listener
msg_receiver_registration_params_s	Structure supplied when issuing a register_msg_handler() call
notify_subscription_handlers_s
notify_subscription_params_s	Structure supplied when registering to receive topic subscription notifications
notify_unsubscription_handlers_s
notify_unsubscription_params_s	Structure supplied when registering to receive topic unsubscription notifications
ping_system_handlers_s
ping_system_params_s	Structure supplied when registering a system ping handler or sending a system ping request
ping_user_handlers_s
ping_user_params_s	Structure supplied when registering a user ping handler or sending a user ping request
reconnection_args_repeating
reconnection_strategy_s	When connecting to Diffusion, a reconnection strategy can be employed which describes what to do if the connection fails
remove_topics_handlers_s
remove_topics_params_s	Structure passed to remove_topics()
security_store_role_s
security_store_s
semaphore_s
send_msg_params_s	Structure supplied to a send_msg() call
send_msg_to_filter_params_s
send_msg_to_session_params_s
send_options_s	Options sub-structure related to requests
send_receiver_client_params_s	Internal structure used when issuing a register_msg_handler() call
session_create_callback_s	When creating a session which performs a connection to Diffusion asynchronously, these callbacks can be supplied and are invoked when the connection is made successfully, or an error occurs
session_details_event_params_s
session_details_s
session_details_summary_s
session_id_s	Structure describing a session ID, which is a unique identifier used by Diffusion for tracking this client; it is also used on reconnection to attempt to restore existing session state
session_listener_s	When a session changes state, a listener may be called to inform the client of the transition via the appropriate function pointer in this structure
session_properties_event_params_s
session_properties_event_s
session_properties_registration_handlers_s
session_properties_registration_params_s
session_s	This is the session structure which is created to represent a single instance of connection (session) with Diffusion
session_wills_remove_topic_handlers_s
session_wills_remove_topic_params_s	Structure supplied when registering a topic will to remove topics
set_entry_s	This structure represents an entry in the set
set_s	This respresents a set
stream_message_options_s	Additional options associated with a STREAM_MESSAGE_T
stream_message_s	Messages directed to this session are received through a globally registered handler, and are parsed into this structure
subscription_control_params_s
subscription_handlers_s
subscription_params_s	Structure supplied when subscribing to a topic
svc_add_topic_request_s	Structure describing an "add topic" request
svc_add_topic_response_s	Structure describing an "add topic" response
svc_authentication_deregister_response_s	Structure holding the deregistration response message
svc_authentication_register_request_s	Structure containing the information required when sending a request to register as an authentication service
svc_authentication_register_response_s	A response to an authentication registration request is considered successful by virtue of being received; there is no service-specific data returned
svc_authentication_request_s	The structure passed to an authentication handler
svc_authentication_response_s	Structure holding the response message from the authentication handler
svc_change_principal_request_s	Structure used internally to represent the request that will be sent to Diffusion
svc_change_principal_response_s	Structure used internally to notify the client that the request has been processed
svc_defn_s	Every service that a client can provide has to implement this core set of functions
svc_fetch_request_s	Structure used to model a fetch request
svc_fetch_response_s	Structure used to model a fetch response
svc_fetch_status_response_s	Structure passed to fetch response callback
svc_get_security_store_request_s	Structure describing the "get security store" request
svc_get_security_store_response_s	Structure describing a "get security store" response
svc_get_session_properties_request_s
svc_get_session_properties_response_s
svc_get_system_authentication_store_request_s	Structure describing the "get system authentication store" request
svc_get_system_authentication_store_response_s	Structure describing a "get system authentication store" response
svc_missing_topic_request_s	Structure of a request to register for missing topic notifications
svc_missing_topic_response_s	Structure of a response to register for missing topic notifications
svc_msg_common_s	Base type for service messages
svc_msg_receiver_registration_request_s	Structure containing information passed to Diffusion in order to register a message handler at a topic endpoint
svc_msg_receiver_registration_response_s	Response structure when a handler is registered
svc_notify_subscription_request_s	Structure describing an incoming notification that the client has been subscribed to a topic
svc_notify_subscription_response_s	Response message to subscription notifications
svc_notify_unsubscription_request_s	Structure describing an incoming unsubscription notification
svc_notify_unsubscription_response_s	Response message to unsubscription notifications
svc_ping_system_request_s	Structure of a system ping request
svc_ping_system_response_s	Structure of a system ping response
svc_ping_user_request_s	Structure of a user ping request
svc_ping_user_response_s	Structure of a user ping response
svc_remove_topics_request_s	Structure describing a "remove topic" request
svc_remove_topics_response_s	Structure describing a "remove topic" response
svc_send_msg_response_s
svc_send_receiver_client_request_s	Structure containing the information received and passed to a topic endpoint handler, including the message content
svc_send_receiver_client_response_s	Response structure
svc_send_to_filter_request_s
svc_send_to_filter_response_s
svc_send_to_session_request_s
svc_send_to_session_response_s
svc_session_details_event_request_s
svc_session_details_event_response_s
svc_session_properties_event_batch_request_s
svc_session_properties_event_batch_response_s
svc_session_properties_event_request_s
svc_session_properties_event_response_s
svc_session_properties_registration_request_s
svc_session_properties_registration_response_s
svc_session_wills_request_s	Structure defining a request to register a session will for a topic
svc_session_wills_response_s	Structure representing a session will registration response
svc_subscribe_request_s	Structure describing a subscription request
svc_subscribe_response_s	Structure describing a subscription response
svc_subscription_control_request_s	Structure describing a subscription control request
svc_subscription_control_response_s	Structure describing a subscription control response
svc_topic_control_registration_request_s	Structure for requesting control over providing topic state
svc_topic_control_registration_response_s
svc_topic_removal_request_s	Structure describing a "topic removal" request
svc_topic_removal_response_s	Structure describing a "topic removal" response
svc_unsubscribe_request_s	Structure describing a unsubscription request
svc_unsubscribe_response_s	Structure describing a unsubscription response
svc_update_deregistration_request_s	Structure describing a request to deregister a topic update source
svc_update_deregistration_response_s	Structure describing the response to a topic update deregistration request
svc_update_registration_request_s	Structure describing a request to register a topic update source
svc_update_registration_response_s	Structure describing the response to a topic update registration request
svc_update_request_s	Structure describing a request to update a topic
svc_update_response_s	Structure describing the response to a topic update request
svc_update_security_store_request_s	Structure describing an "update security store" request
svc_update_security_store_response_s	Structure describing the response to an "update security store" request
svc_update_source_state_request_s	Structure describing a request to change an updater's state
svc_update_source_state_response_s	Structure for responding to a request to change and updater's state
svc_update_system_authentication_store_request_s	Structure describing an "update system store" request
svc_update_system_authentication_store_response_s	Structure describing the response to an "update system store" request
system_authentication_store_s
system_principal_s	Structure describing a principal in the authentication store
topic_details_attributes_s	Various attributes relating to topic details
topic_details_cache_s
topic_details_decimal_s	Parameters for a M_DATA_TYPE_DECIMAL_STRING
topic_details_integer_s	Parameters for a M_DATA_TYPE_INTEGER_STRING
topic_details_string_s	Paramaters for a M_DATA_TYPE_STRING
topic_id_details_s
topic_message_s	Structure for slightly simplified access to topic messages
topic_removal_handlers_s
topic_removal_params_s	Structure passed to topic_removal()
topics_details_s	Structure containing information encapsulated within topic details, either for creation or received through a notification by Diffusion
transport_s
unsubscription_handlers_s
unsubscription_params_s	Structure supplied when unsubscribing from a topic
update_s	This represents an update to apply to a topic
update_security_store_params_s	Structure passed when updating the security store
update_source_deregistration_handlers_s
update_source_deregistration_params_s	Structure passed when deregistering an update source
update_source_handlers_s
update_source_params_s	Structure passed when updating a topic
update_source_registration_handlers_s
update_source_registration_params_s	Structure passed when registering an update source
update_source_state_handlers_s
update_source_state_params_s
update_system_authentication_store_params_s	Structure passed when updating the system authentication store
v5_message_s	Service messages over the V5 protocol are parsed into this common structure, with the unparsed service-specific content in the payload field