Diffusion C API  5.9.24
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
svc-subscribe.h File Reference

Functions and structures required for a client to be able to subscribe to topics on a Diffusion server. More...

Data Structures

struct  svc_subscribe_request_s
 Structure describing a subscription request. More...
 
struct  svc_subscribe_response_s
 Structure describing a subscription response. More...
 
struct  subscription_handlers_s
 
struct  subscription_params_s
 Structure supplied when subscribing to a topic. More...
 

Macros

#define SUBSCRIPTION_HANDLERS
 Callback handlers that may be registered to deal with messages sent by Diffusion in response to the subscription request.
 

Typedefs

typedef struct
svc_subscribe_request_s 
SVC_SUBSCRIBE_REQUEST_T
 Structure describing a subscription request.
 
typedef struct
svc_subscribe_response_s 
SVC_SUBSCRIBE_RESPONSE_T
 Structure describing a subscription response.
 
typedef int(* on_subscribe_cb )(SESSION_T *session, void *context)
 Callback for on_subscribe(). More...
 
typedef struct
subscription_params_s 
SUBSCRIPTION_PARAMS_T
 Structure supplied when subscribing to a topic.
 

Functions

TOPIC_HANDLER_T subscribe (SESSION_T *session, const SUBSCRIPTION_PARAMS_T params)
 Subscribe to topics. More...
 

Detailed Description

Functions and structures required for a client to be able to subscribe to topics on a Diffusion server.

Typedef Documentation

typedef int(* on_subscribe_cb)(SESSION_T *session, void *context)

Callback for on_subscribe().

Parameters
sessionThe current active session.
contextUser-supplied context from the initial subscribe() call.
Returns
HANDLER_SUCCESS or HANDLER_FAILURE.