Diffusion C API 6.12.0
Loading...
Searching...
No Matches
Data Structures
Here are the data structures with brief descriptions:
 C_semaphore_internal
 Cadd_request_handler_params_sStructure supplied when issuing a add_request_handler() call
 Cadd_topic_callback_sAdd_topic_from_specification callback
 Carg_opts_sThis structure represents a possible argument to an application
 Cchange_principal_params_sStructure supplied when issuing a change_principal() request
 CCONNECTION_RESPONSE_T
 Ccontent_sContent wrapper for encoding and data
 Cconversation_id_sStructure representing a conversation ID
 Ccredentials_sThis structure is used for passing credentials around in the API
 Cdiffusion_apply_json_patch_params_sStructure describing a JSON patch application request
 Cdiffusion_authentication_handler_params_sStructure supplied when issuing an diffusion_set_authentication_handler request
 Cdiffusion_authentication_handler_sStructure supplied as part of a diffusion_set_authentication_handler request
 Cdiffusion_change_roles_params_with_filter_sStructure supplied when issuing a diffusion_change_roles_with_filter call
 Cdiffusion_change_roles_with_session_id_params_sStructure supplied when issuing a diffusion_change_roles_with_session_id call
 Cdiffusion_check_remote_server_params_s
 Cdiffusion_client_close_with_filter_params_sStructure supplied when issuing a diffusion_client_close_with_filter call
 Cdiffusion_client_close_with_session_params_sStructure supplied when issuing a diffusion_client_close_with_session call
 Cdiffusion_client_set_conflated_with_filter_params_sStructure supplied when issuing a diffusion_client_set_conflated_with_filter call
 Cdiffusion_create_remote_server_params_s
 Cdiffusion_create_topic_view_params_sStructure describing a request to create a topic view
 Cdiffusion_error_sA structure which is filled by the API when an error occurs
 Cdiffusion_fetch_request_params_sStructure describing a fetch request
 Cdiffusion_get_global_permissions_params_sStructure supplied when issuing a diffusion_get_global_permissions request
 Cdiffusion_get_path_permissions_params_sStructure supplied when issuing a diffusion_get_path_permissions request
 Cdiffusion_get_topic_selections_sStructure supplied when issuing a diffusion_get_topic_selections call
 Cdiffusion_get_topic_view_params_sStructure describing a request to get a topic view
 Cdiffusion_list_remote_servers_params_s
 Cdiffusion_metrics_list_session_metric_collectors_params_sStructure supplied when issuing a diffusion_metrics_list_session_metric_collectors call
 Cdiffusion_metrics_list_topic_metric_collectors_params_sStructure supplied when issuing a diffusion_metrics_list_topic_metric_collectors call
 Cdiffusion_metrics_put_session_metric_collector_params_sStructure supplied when issuing a diffusion_metrics_put_session_metric_collector call
 Cdiffusion_metrics_put_topic_metric_collector_params_sStructure supplied when issuing a diffusion_metrics_put_topic_metric_collector call
 Cdiffusion_metrics_remove_session_metric_collector_params_sStructure supplied when issuing a diffusion_metrics_remove_session_metric_collector call
 Cdiffusion_metrics_remove_topic_metric_collector_params_sStructure supplied when issuing a diffusion_metrics_remove_topic_metric_collector call
 Cdiffusion_recoverable_update_stream_callback_response_sStructure representing the response for all DIFFUSION_RECOVERABLE_UPDATE_STREAM_T operations
 Cdiffusion_recoverable_update_stream_params_sStructure provided when calling diffusion_recoverable_update_stream_set or diffusion_recoverable_update_stream_validate
 Cdiffusion_remove_remote_server_params_s
 Cdiffusion_remove_topic_view_params_sStructure describing a request to remove a topic view
 Cdiffusion_request_handler_sRequest handler structure required when creating an ADD_REQUEST_HANDLER_PARAMS_T
 Cdiffusion_request_stream_sStructure supplied when adding a request stream
 Cdiffusion_revoke_authentication_params_sStructure supplied when issuing a diffusion_revoke_authentication request
 Cdiffusion_session_get_session_properties_params_s
 Cdiffusion_session_lock_params_sStructure describing a session lock request
 Cdiffusion_session_lock_unlock_params_sStructure describing a session lock unlock request
 Cdiffusion_session_trees_get_branch_mapping_table_params_sStructure supplied when issuing a diffusion_session_trees_get_branch_mapping_table call
 Cdiffusion_session_trees_get_session_tree_branches_params_sStructure supplied when issuing a diffusion_session_trees_get_session_tree_branches call
 Cdiffusion_session_trees_put_branch_mapping_table_params_sStructure supplied when issuing a diffusion_session_trees_put_branch_mapping_table call
 Cdiffusion_set_session_properties_filter_params_sStructure supplied when issuing a diffusion_set_session_properties_filter call
 Cdiffusion_set_session_properties_params_sStructure supplied when issuing a diffusion_set_session_properties call
 Cdiffusion_subscribe_by_filter_sStructure supplied when issuing a diffusion_subscribe_by_filter call
 Cdiffusion_time_series_append_params_sStructure supplied when issuing a diffusion_time_series_append request
 Cdiffusion_time_series_edit_params_sStructure supplied when issuing a diffusion_time_series_edit request
 Cdiffusion_time_series_range_query_params_sStructure supplied when issuing a diffusion_time_series_select_from request
 Cdiffusion_time_series_timestamp_append_params_sStructure supplied when issuing a diffusion_time_series_timestamp_append request
 Cdiffusion_topic_notification_listener_sStructure for adding a topic notification listener
 Cdiffusion_topic_notification_registration_params_sStructure supplied when issuing a diffusion_topic_notification_registration_select or diffusion_topic_notification_registration_deselect request
 Cdiffusion_topic_selection_sStructure of the topic selection
 Cdiffusion_topic_update_add_and_set_params_sStructure describing a topic add and set request
 Cdiffusion_topic_update_params_sStructure describing a topic set request
 Cdiffusion_topic_update_stream_params_sStructure provided when calling diffusion_topic_update_stream_set
 Cdiffusion_topic_views_list_params_sStructure describing a request to list topic views
 Cdiffusion_unsubscribe_by_filter_sStructure supplied when issuing a diffusion_unsubscribe_by_filter call
 Cerror_report_sStructure describing an error report which may arise when calling various API functions
 Cget_security_store_params_sStructure passed when requesting the security store
 Cget_session_properties_params_s
 Cget_system_authentication_store_params_sStructure passed when requesting the system authentication store
 Chandler_set_sA handler set is registered against a conversation id and contains function pointers to callback handlers related to that conversation
 Chash_entry_sThis structure represents an entry within a hash table
 Chash_num_entry_sThis structure represents an entry within a hash table
 Chash_num_sThis represents a hash table
 Chash_sThis represents a hash table
 Clocation_details_sThis structure describes the network and physical location of a client/session
 Cmessage_sGeneric message; all messages should fit into this structure
 Cmissing_topic_handlers_s
 Cmissing_topic_params_sStructure supplied when registering to receive missing topic notifications
 Cmsg_receiver_registration_params_sStructure supplied when issuing a register_msg_handler() call
 Cnotify_subscription_handlers_s
 Cnotify_subscription_params_sStructure supplied when registering to receive topic subscription notifications
 Cnotify_unsubscription_handlers_s
 Cnotify_unsubscription_params_sStructure supplied when registering to receive topic unsubscription notifications
 Cping_system_handlers_s
 Cping_system_params_sStructure supplied when registering a system ping handler or sending a system ping request
 Cping_user_handlers_s
 Cping_user_params_sStructure supplied when registering a user ping handler or sending a user ping request
 Creauthenticate_params_sStructure supplied when issuing a change_principal() request
 Creconnection_args_repeating
 Creconnection_strategy_sWhen connecting to Diffusion, a reconnection strategy can be employed which describes what to do if the connection fails
 Csecurity_store_role_s
 Csecurity_store_s
 Csemaphore_s
 Csend_options_sOptions sub-structure related to requests
 Csend_request_params_sStructure supplied to a send_request() call
 Csend_request_to_filter_params_sStructure supplied when issuing a send_request_to_filter() call
 Csend_request_to_session_params_sStructure supplied when issuing a send_request_to_session() call
 Csession_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
 Csession_details_s
 Csession_details_summary_s
 Csession_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
 Csession_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
 Csession_properties_event_s
 Csession_properties_registration_handlers_s
 Csession_properties_registration_params_s
 Csession_sThis is the session structure which is created to represent a single instance of connection (session) with Diffusion
 Cset_entry_sThis structure represents an entry in the set
 Cset_sThis represents a set
 Cstream_message_options_sAdditional options associated with a STREAM_MESSAGE_T
 Cstream_message_sMessages directed to this session are received through a globally registered handler, and are parsed into this structure
 Csubscription_control_params_s
 Csubscription_handlers_s
 Csubscription_params_sStructure supplied when subscribing to a topic
 Csvc_defn_sEvery service that a client can provide has to implement this core set of functions
 Csvc_get_session_properties_response_s
 Csvc_missing_topic_request_sStructure of a request to register for missing topic notifications
 Csvc_msg_common_sBase type for service messages
 Csvc_notify_subscription_request_sStructure describing an incoming notification that the client has been subscribed to a topic
 Csvc_notify_unsubscription_request_sStructure describing an incoming unsubscription notification
 Csvc_ping_system_request_sStructure of a system ping request
 Csvc_ping_user_request_sStructure of a user ping request
 Csvc_send_receiver_client_request_sStructure containing the information received and passed to a handler registered on a message path, including the message content
 Csystem_authentication_store_s
 Csystem_principal_sStructure describing a principal in the authentication store
 Ctopic_message_sStructure for slightly simplified access to topic messages
 Ctopic_removal_handlers_s
 Ctopic_removal_params_sStructure passed to topic_removal()
 Ctransport_s
 Cunsubscription_handlers_s
 Cunsubscription_params_sStructure supplied when unsubscribing from a topic
 Cupdate_sThis represents an update to apply to a topic
 Cupdate_security_store_params_sStructure passed when updating the security store
 Cupdate_system_authentication_store_params_sStructure passed when updating the system authentication store
 Cv5_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