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

Functions for sending messages to handlers in control clients via topic endpoints. More...

Data Structures

struct  svc_send_receiver_client_request_s
 Structure containing the information received and passed to a topic endpoint handler, including the message content. More...
 
struct  svc_send_receiver_client_response_s
 Response structure. More...
 
struct  send_receiver_client_params_s
 Internal structure used when issuing a register_msg_handler() call. More...
 

Macros

#define SEND_RECEIVER_CLIENT_HANDLERS
 Handlers for notification of a message being received.
 

Typedefs

typedef struct
svc_send_receiver_client_request_s 
SVC_SEND_RECEIVER_CLIENT_REQUEST_T
 Structure containing the information received and passed to a topic endpoint handler, including the message content.
 
typedef struct
svc_send_receiver_client_response_s 
SVC_SEND_RECEIVER_CLIENT_RESPONSE_T
 Response structure.
 
typedef int(* on_send_receiver_client_msg_cb )(SESSION_T *session, const SVC_SEND_RECEIVER_CLIENT_REQUEST_T *request, void *context)
 Callback when a message is received by a registered handler on a topic endpoint. More...
 
typedef struct
send_receiver_client_params_s 
SEND_RECEIVER_CLIENT_PARAMS_T
 Internal structure used when issuing a register_msg_handler() call.
 

Detailed Description

Functions for sending messages to handlers in control clients via topic endpoints.

Typedef Documentation

typedef int(* on_send_receiver_client_msg_cb)(SESSION_T *session, const SVC_SEND_RECEIVER_CLIENT_REQUEST_T *request, void *context)

Callback when a message is received by a registered handler on a topic endpoint.

Parameters
sessionThe currently active session.
requestDetails about the incoming message, and the message itself.
contextUser-supplied context from the initial register_msg_handler() call.
Returns
HANDLER_SUCCESS or HANDLER_FAILURE.