Diffusion C API  6.8.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Structures
Here are the data structures with brief descriptions:
oC_semaphore_internal
oCadd_request_handler_params_sStructure supplied when issuing a add_request_handler() call
oCadd_topic_callback_sAdd_topic_from_specification callback
oCarg_opts_sThis structure represents a possible argument to an application
oCchange_principal_handlers_s
oCchange_principal_params_sStructure supplied when issuing a change_principal() request
oCCONNECTION_RESPONSE_T
oCcontent_sContent wrapper for encoding and data
oCconversation_id_sStructure representing a conversation ID
oCcredentials_sThis structure is used for passing credentials around in the API
oCdiffusion_apply_json_patch_params_sStructure describing a JSON patch application request
oCdiffusion_authentication_handler_params_sStructure supplied when issuing an diffusion_set_authentication_handler request
oCdiffusion_authentication_handler_sStructure supplied as part of a diffusion_set_authentication_handler request
oCdiffusion_change_roles_params_with_filter_sStructure supplied when issuing a diffusion_change_roles_with_filter call
oCdiffusion_change_roles_with_session_id_params_sStructure supplied when issuing a diffusion_change_roles_with_session_id call
oCdiffusion_check_remote_server_params_s
oCdiffusion_client_close_with_filter_params_sStructure supplied when issuing a diffusion_client_close_with_filter call
oCdiffusion_client_close_with_session_params_sStructure supplied when issuing a diffusion_client_close_with_session call
oCdiffusion_client_set_conflated_with_filter_params_sStructure supplied when issuing a diffusion_client_set_conflated_with_filter call
oCdiffusion_create_remote_server_params_s
oCdiffusion_create_topic_view_params_sStructure describing a request to create a topic view
oCdiffusion_error_sA structure which is filled by the API when an error occurs
oCdiffusion_fetch_request_params_sStructure describing a fetch request
oCdiffusion_get_global_permissions_params_sStructure supplied when issuing a diffusion_get_global_permissions request
oCdiffusion_get_path_permissions_params_sStructure supplied when issuing a diffusion_get_path_permissions request
oCdiffusion_get_topic_view_params_sStructure describing a request to get a topic view
oCdiffusion_list_remote_servers_params_s
oCdiffusion_metrics_list_session_metric_collectors_params_sStructure supplied when issuing a diffusion_metrics_list_session_metric_collectors call
oCdiffusion_metrics_list_topic_metric_collectors_params_sStructure supplied when issuing a diffusion_metrics_list_topic_metric_collectors call
oCdiffusion_metrics_put_session_metric_collector_params_sStructure supplied when issuing a diffusion_metrics_put_session_metric_collector call
oCdiffusion_metrics_put_topic_metric_collector_params_sStructure supplied when issuing a diffusion_metrics_put_topic_metric_collector call
oCdiffusion_metrics_remove_session_metric_collector_params_sStructure supplied when issuing a diffusion_metrics_remove_session_metric_collector call
oCdiffusion_metrics_remove_topic_metric_collector_params_sStructure supplied when issuing a diffusion_metrics_remove_topic_metric_collector call
oCdiffusion_remove_remote_server_params_s
oCdiffusion_remove_topic_view_params_sStructure describing a request to remove a topic view
oCdiffusion_request_handler_sRequest handler structure required when creating an ADD_REQUEST_HANDLER_PARAMS_T
oCdiffusion_request_stream_sStructure supplied when adding a request stream
oCdiffusion_session_lock_params_sStructure describing a session lock request
oCdiffusion_session_lock_unlock_params_sStructure describing a session lock unlock request
oCdiffusion_session_trees_get_branch_mapping_table_params_sStructure supplied when issuing a diffusion_session_trees_get_branch_mapping_table call
oCdiffusion_session_trees_get_session_tree_branches_params_sStructure supplied when issuing a diffusion_session_trees_get_session_tree_branches call
oCdiffusion_session_trees_put_branch_mapping_table_params_sStructure supplied when issuing a diffusion_session_trees_put_branch_mapping_table call
oCdiffusion_set_session_properties_filter_params_sStructure supplied when issuing a diffusion_set_session_properties_filter call
oCdiffusion_set_session_properties_params_sStructure supplied when issuing a diffusion_set_session_properties call
oCdiffusion_subscribe_by_filter_sStructure supplied when issuing a diffusion_subscribe_by_filter call
oCdiffusion_time_series_append_params_sStructure supplied when issuing a diffusion_time_series_append request
oCdiffusion_time_series_edit_params_sStructure supplied when issuing a diffusion_time_series_edit request
oCdiffusion_time_series_range_query_params_sStructure supplied when issuing a diffusion_time_series_select_from request
oCdiffusion_time_series_timestamp_append_params_sStructure supplied when issuing a diffusion_time_series_timestamp_append request
oCdiffusion_topic_notification_listener_sStructure for adding a topic notification listener
oCdiffusion_topic_notification_registration_params_sStructure supplied when issuing a diffusion_topic_notification_registration_select or diffusion_topic_notification_registration_deselect request
oCdiffusion_topic_update_add_and_set_params_sStructure describing a topic add and set request
oCdiffusion_topic_update_params_sStructure describing a topic set request
oCdiffusion_topic_update_stream_params_sStructure provided when calling diffusion_topic_update_stream_set
oCdiffusion_topic_views_list_params_sStructure describing a request to list topic views
oCdiffusion_unsubscribe_by_filter_sStructure supplied when issuing a diffusion_unsubscribe_by_filter call
oCerror_report_sStructure describing an error report which may arise when calling various API functions
oCget_security_store_params_sStructure passed when requesting the security store
oCget_session_properties_params_s
oCget_system_authentication_store_params_sStructure passed when requesting the system authentication store
oChandler_set_sA handler set is registered against a conversation id and contains function pointers to callback handlers related to that conversation
oChash_entry_sThis structure represents an entry within a hash table
oChash_num_entry_sThis structure represents an entry within a hash table
oChash_num_sThis represents a hash table
oChash_sThis represents a hash table
oClocation_details_sThis structure describes the network and physical location of a client/session
oCmessage_sGeneric message; all messages should fit into this structure
oCmissing_topic_handlers_s
oCmissing_topic_params_sStructure supplied when registering to receive missing topic notifications
oCmsg_receiver_registration_params_sStructure supplied when issuing a register_msg_handler() call
oCnotify_subscription_handlers_s
oCnotify_subscription_params_sStructure supplied when registering to receive topic subscription notifications
oCnotify_unsubscription_handlers_s
oCnotify_unsubscription_params_sStructure supplied when registering to receive topic unsubscription notifications
oCping_system_handlers_s
oCping_system_params_sStructure supplied when registering a system ping handler or sending a system ping request
oCping_user_handlers_s
oCping_user_params_sStructure supplied when registering a user ping handler or sending a user ping request
oCreconnection_args_repeating
oCreconnection_strategy_sWhen connecting to Diffusion, a reconnection strategy can be employed which describes what to do if the connection fails
oCsecurity_store_role_s
oCsecurity_store_s
oCsemaphore_s
oCsend_options_sOptions sub-structure related to requests
oCsend_request_params_sStructure supplied to a send_request() call
oCsend_request_to_filter_params_sStructure supplied when issuing a send_request_to_filter() call
oCsend_request_to_session_params_sStructure supplied when issuing a send_request_to_session() call
oCsession_create_callback_sWhen 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
oCsession_details_s
oCsession_details_summary_s
oCsession_id_sStructure 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
oCsession_listener_sWhen a session changes state, a listener may be called to inform the client of the transition via the appropriate function pointer in this structure
oCsession_properties_event_s
oCsession_properties_registration_handlers_s
oCsession_properties_registration_params_s
oCsession_sThis is the session structure which is created to represent a single instance of connection (session) with Diffusion
oCset_entry_sThis structure represents an entry in the set
oCset_sThis respresents a set
oCstream_message_options_sAdditional options associated with a STREAM_MESSAGE_T
oCstream_message_sMessages directed to this session are received through a globally registered handler, and are parsed into this structure
oCsubscription_control_params_s
oCsubscription_handlers_s
oCsubscription_params_sStructure supplied when subscribing to a topic
oCsvc_defn_sEvery service that a client can provide has to implement this core set of functions
oCsvc_get_session_properties_response_s
oCsvc_missing_topic_request_sStructure of a request to register for missing topic notifications
oCsvc_msg_common_sBase type for service messages
oCsvc_notify_subscription_request_sStructure describing an incoming notification that the client has been subscribed to a topic
oCsvc_notify_unsubscription_request_sStructure describing an incoming unsubscription notification
oCsvc_ping_system_request_sStructure of a system ping request
oCsvc_ping_user_request_sStructure of a user ping request
oCsvc_send_receiver_client_request_sStructure containing the information received and passed to a handler registered on a message path, including the message content
oCsystem_authentication_store_s
oCsystem_principal_sStructure describing a principal in the authentication store
oCtopic_message_sStructure for slightly simplified access to topic messages
oCtopic_removal_handlers_s
oCtopic_removal_params_sStructure passed to topic_removal()
oCtransport_s
oCunsubscription_handlers_s
oCunsubscription_params_sStructure supplied when unsubscribing from a topic
oCupdate_sThis represents an update to apply to a topic
oCupdate_security_store_params_sStructure passed when updating the security store
oCupdate_system_authentication_store_params_sStructure passed when updating the system authentication store
oCv5_message_sService messages over the V5 protocol are parsed into this common structure, with the unparsed service-specific content in the payload field
\Cvalue_stream_s