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

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

Data Structures

struct  svc_unsubscribe_request_s
 Structure describing a unsubscription request. More...
 
struct  svc_unsubscribe_response_s
 Structure describing a unsubscription response. More...
 
struct  unsubscription_handlers_s
 
struct  unsubscription_params_s
 Structure supplied when unsubscribing from a topic. More...
 

Macros

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

Typedefs

typedef struct
svc_unsubscribe_request_s 
SVC_UNSUBSCRIBE_REQUEST_T
 Structure describing a unsubscription request.
 
typedef struct
svc_unsubscribe_response_s 
SVC_UNSUBSCRIBE_RESPONSE_T
 Structure describing a unsubscription response.
 
typedef int(* on_unsubscribe_cb )(SESSION_T *session, void *context)
 Callback for on_unsubscribe(). More...
 
typedef struct
unsubscription_params_s 
UNSUBSCRIPTION_PARAMS_T
 Structure supplied when unsubscribing from a topic.
 

Functions

void unsubscribe (SESSION_T *session, const UNSUBSCRIPTION_PARAMS_T params)
 Unsubscribe from one or more topics. More...
 

Detailed Description

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

Typedef Documentation

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

Callback for on_unsubscribe().

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