Diffusion C API  6.5.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
session_s Struct Reference

This is the session structure which is created to represent a single instance of connection (session) with Diffusion. More...

Data Fields

SESSION_ID_Tid
 A unique session identifier allocated by Diffusion.
 
const char * url_str
 The URL used to connect to Diffusion.
 
volatile SESSION_STATE_T state
 The current session connection state.
 
SESSION_LISTENER_Tlistener
 Callbacks to be notified when the session changes state (e.g. More...
 
TOPIC_HANDLER_T global_topic_handler
 If a handler has not otherwise been declared for a particular topic, then this handler is tried. More...
 
int(* global_service_error_handler )(struct session_s *session, const DIFFUSION_ERROR_T *error)
 If defined, this handler is called in the absence of a service-specific handler. More...
 
void * user_context
 User-supplied context for this session. More...
 

Detailed Description

This is the session structure which is created to represent a single instance of connection (session) with Diffusion.

Field Documentation

int(* session_s::global_service_error_handler)(struct session_s *session, const DIFFUSION_ERROR_T *error)

If defined, this handler is called in the absence of a service-specific handler.

TOPIC_HANDLER_T session_s::global_topic_handler

If a handler has not otherwise been declared for a particular topic, then this handler is tried.

SESSION_LISTENER_T* session_s::listener

Callbacks to be notified when the session changes state (e.g.

active, closed).

void* session_s::user_context

User-supplied context for this session.

It is the user's responsibility to free any memory that this points to when the session is no longer required.


The documentation for this struct was generated from the following file: