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

Client functions for fetching data from topics. More...

Data Structures

struct  svc_fetch_request_s
 Structure used to model a fetch request. More...
 
struct  svc_fetch_response_s
 Structure used to model a fetch response. More...
 
struct  svc_fetch_status_response_s
 Structure passed to fetch response callback. More...
 
struct  fetch_handlers_s
 
struct  fetch_params_s
 Structure supplied to a fetch() request. More...
 

Macros

#define FETCH_HANDLERS
 Callbacks which can be registered for handling the responses to the fetch request.
 

Typedefs

typedef struct svc_fetch_request_s SVC_FETCH_REQUEST_T
 Structure used to model a fetch request.
 
typedef struct svc_fetch_response_s SVC_FETCH_RESPONSE_T
 Structure used to model a fetch response.
 
typedef struct
svc_fetch_status_response_s 
SVC_FETCH_STATUS_RESPONSE_T
 Structure passed to fetch response callback.
 
typedef int(* on_fetch_cb )(SESSION_T *session, void *context)
 Callback for on_fetch() command having been received by Diffusion. More...
 
typedef int(* on_fetch_status_message_cb )(SESSION_T *session, const SVC_FETCH_STATUS_RESPONSE_T *status, void *context)
 Callback for on_status_message() indicating the end of the fetch conversation. More...
 
typedef struct fetch_params_s FETCH_PARAMS_T
 Structure supplied to a fetch() request.
 

Functions

void fetch (SESSION_T *session, const FETCH_PARAMS_T params)
 Fetch state for a topic (or many topics). More...
 

Detailed Description

Client functions for fetching data from topics.

Typedef Documentation

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

Callback for on_fetch() command having been received by Diffusion.

Parameters
sessionThe currently active session.
contextUser-supplied context from the fetch() call.
Returns
HANDLERS_SUCCESS or HANDLER_FAILURE.
typedef int(* on_fetch_status_message_cb)(SESSION_T *session, const SVC_FETCH_STATUS_RESPONSE_T *status, void *context)

Callback for on_status_message() indicating the end of the fetch conversation.

Parameters
sessionThe currently active session.
statusThe fetch status response.
contextUser-supplied context from the fetch() call.
Returns
HANDLERS_SUCCESS or HANDLER_FAILURE.