Diffusion C API  5.9.24
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
File List
Here is a list of all documented files with brief descriptions:
[detail level 1234]
\-public
 \-include
  o-service
  |o*svc-add-topic.hAdd topic feature (topic control)
  |o*svc-authentication-deregister.hFunctions required for deregistering an authentication service in a control client
  |o*svc-authentication-register.hFunctions required for registering an authentication service in a control client
  |o*svc-authentication.hFunctions required for handling authentication requests in a control client
  |o*svc-change-principal.hFunctions that allow a client to change its principal (usually, username) which is using to identify itself to Diffusion
  |o*svc-fetch.hClient functions for fetching data from topics
  |o*svc-get-session-properties.hFunctions for directly requesting session properties of a connected client
  |o*svc-missing-topic.hAllow a client to register to receive notification of subscription/fetch requests for topics that do not exist
  |o*svc-msg-receiver-registration.hFunctions for registering message handlers
  |o*svc-notify-subscription.hFunctions for notifying a client that it has been subscribed to a topic
  |o*svc-notify-unsubscription.hFunctions for notifying a client that it has been unsubscribed from a topic
  |o*svc-ping-system.hFunctions to handle system-level ping requests and responses
  |o*svc-ping-user.hFunctions to handle user-initiated ping requests and responses
  |o*svc-remove-topics.hRemove topics feature (topic control)
  |o*svc-security-control.hServices for querying and updating the security store
  |o*svc-send-msg-to-filter.hFunctions for sending messages to client sessions via topic endpoints, using a filter to select the clients
  |o*svc-send-msg-to-session.hFunctions for sending messages to client sessions via topic endpoints
  |o*svc-send-msg.hFunctions for sending messages to handlers in control clients via topic endpoints
  |o*svc-send-receiver-client.hFunctions for sending messages to handlers in control clients via topic endpoints
  |o*svc-session-details-event.hFunctions for notifying a control client that other clients have opened, closed or been updated
  |o*svc-session-properties-event-batch.hFunctions for notifying a control client that other clients have opened, closed or been updated
  |o*svc-session-properties-event.hFunctions for notifying a control client that other clients have opened, closed or been updated
  |o*svc-session-properties-registration.hFunctions for registering a registration for a control client, so that it can receive notifications that other clients have opened, closed or been updated
  |o*svc-session-wills.hFunctions relating to topic lifecycle; what should Diffusion do with topics created in by this control client session when that session terminates?
  |o*svc-subscribe.hFunctions and structures required for a client to be able to subscribe to topics on a Diffusion server
  |o*svc-subscription-control.hFunctions for subscribing and unsubscribing connected clients from topics
  |o*svc-system-auth-control.hServices for querying and updating the system authentication store
  |o*svc-topic-control-registration.hRegister in interest in TOPIC_CONTROL_REGISTRATION service messages
  |o*svc-topic-removal.hTopic removal feature (topic control)
  |o*svc-unsubscribe.hFunctions and structures required for a client to be able to unsubscribe from topics on a Diffusion server
  |\*svc-update.hFunctions for registering an update source and providing updates to topics
  o-types
  |o*client_details_types.hTypes used for client (and by extension, session) details
  |o*common_types.hCommon types that don't fit anywhere else
  |o*content_types.hStructures representing content types (e.g., used for updating topics)
  |o*conversation_types.hDefinitions for types representing conversations and conversation IDs
  |o*error_types.hTypes and structures relating to reported errors
  |o*messaging_types.hTypes used across messaging and messaging control
  |o*security_types.hConstants and types relating to security and authorisation functions
  |o*service_types.hThis file lists the types of services supported by Diffusion (although some of these may not yet be supported by the C API) and associated structures
  |o*session_types.hTypes to describe a session, its parameters and related functions
  |o*topic_types.hTypes relating to topic messages and service messages
  |\*transport_types.hStructures and definitions specific to transport related functions
  o*args.hUtilities for parsing command line arguments, as used in the examples
  o*buf.hDefines structures and functions for working with byte arrays of arbitrary length
  o*content.hDefines functions that operate on the CONTENT_T data structure, which is used to wrap data used in updates to topics
  o*conversation.hFunctions for handling conversations and conversation IDs
  o*d_semaphore.hWrappers to provide simple semaphores based on APR mutexes and condition variables
  o*diffusion.hMain include file
  o*error.hFunctions relating to error reporting within the API
  o*hash.hA simple hashmap implementation
  o*list.hA simple linked list implementation
  o*reconnect.hFunctions relating to session reconnection
  o*security.hFunctions handling authorisation, security and user credentials
  o*session.hFunctions relating to a session and session management
  o*set.hA simple set implementation, based on hash.h
  o*topic-details.hFunctions used for working with topic details (TOPIC_DETAILS_T)
  o*topic.hFunctions which are used for accessing topics and their contents
  o*update.hFunctions which are used for updating topics
  \*utils.hMiscellaneous utility functions that don't fit anywhere else