DataSource for C SDK  6.2.20.310828
ds5_subscriptionlistener_t Struct Reference

An implementation of this interface allows applications to receive events raised for a ds5_subscription_t. More...

Data Fields

void(* container_updated )(void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata)
 Callback invoked when a container update is received. More...
 
void(* news_story_updated )(void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata)
 Callback invoked when a news story update is received. More...
 
void(* news_updated )(void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata)
 Callback invoked when a news headline update is received. More...
 
void(* page_updated )(void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata)
 Callback invoked when a page update is received. More...
 
void(* permission_updated )(void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata)
 Callback invoked when a permission update is received. More...
 
void(* record_type2_updated )(void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata)
 Callback invoked when an update to type 2 data in a record is received. More...
 
void(* record_type3_updated )(void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata)
 Callback invoked when an update to type 3 data in a record is received. More...
 
void(* record_updated )(void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata)
 Callback invoked when an update to type 1 data in a record is received. More...
 
void(* subscription_error )(void *context, ds5_subscription_t *sub, int peer, const char *subject, short flags)
 Callback invoked when there is an error in a subscription. More...
 
void(* subscription_status )(void *context, ds5_subscription_t *sub, int peer, const char *subject, int status, const char *message)
 Callback invoked when there is a change in the status of a subscription. More...
 
void(* unknown_subject_type_updated )(void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata)
 Callback invoked when an update for an unknown subject type is received. More...
 

Detailed Description

An implementation of this interface allows applications to receive events raised for a ds5_subscription_t.

Implement this interface to receive subscription events. You can only implement the functions for the subject types that your application is interested in receiving. Call either the ds_create_broadcast_susbcription() or ds_create_active_subscription() function to register your implementation with the DataSource library.

Note
Each callback method is a function defined in a data field of the ds5_subscriptionlistener_t structure. You only need to implement the methods for the subject types that your DataSource application is interested in.

Field Documentation

void(* ds5_subscriptionlistener_t::container_updated) (void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata)

Callback invoked when a container update is received.

Parameters
context- The callback context that was supplied to ds_create_broadcast_subscription() or ds_create_active_subscription().
sub- The subscription for which the update occurred.
peer- The DataSource peer supplying the update.
update- The container update.
void(* ds5_subscriptionlistener_t::news_story_updated) (void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata)

Callback invoked when a news story update is received.

Parameters
context- The callback context that was supplied to ds_create_broadcast_subscription() or ds_create_active_subscription().
sub- The subscription for which the update occurred.
peer- The DataSource peer supplying the update.
update- The news headline update.
void(* ds5_subscriptionlistener_t::news_updated) (void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata)

Callback invoked when a news headline update is received.

Parameters
context- The callback context that was supplied to ds_create_broadcast_subscription() or ds_create_active_subscription().
sub- The subscription for which the update occurred.
peer- The DataSource peer supplying the update.
update- The news headline update.
void(* ds5_subscriptionlistener_t::page_updated) (void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata)

Callback invoked when a page update is received.

Parameters
context- The callback context that was supplied to ds_create_broadcast_subscription() or ds_create_active_subscription().
sub- The subscription for which the update occurred.
peer- The DataSource peer supplying the update.
update- The page update.
void(* ds5_subscriptionlistener_t::permission_updated) (void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata)

Callback invoked when a permission update is received.

Parameters
context- The callback context that was supplied to ds_create_broadcast_subscription() or ds_create_active_subscription().
sub- The subscription for which the update occurred.
peer- The DataSource peer supplying the update.
update- The permission update.
void(* ds5_subscriptionlistener_t::record_type2_updated) (void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata)

Callback invoked when an update to type 2 data in a record is received.

Parameters
context- The callback context that was supplied to ds_create_broadcast_subscription() or ds_create_active_subscription().
sub- The subscription for which the update occurred.
peer- The DataSource peer supplying the update.
update- The record update.
void(* ds5_subscriptionlistener_t::record_type3_updated) (void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata)

Callback invoked when an update to type 3 data in a record is received.

Parameters
context- The callback context that was supplied to ds_create_broadcast_subscription() or ds_create_active_subscription().
sub- The subscription for which the update occurred.
peer- The DataSource peer supplying the update.
update- The record update.
void(* ds5_subscriptionlistener_t::record_updated) (void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata)

Callback invoked when an update to type 1 data in a record is received.

Parameters
context- The callback context that was supplied to ds_create_broadcast_subscription() or ds_create_active_subscription().
sub- The subscription for which the update occurred.
peer- The DataSource peer supplying the update.
update- The record update.
void(* ds5_subscriptionlistener_t::subscription_error) (void *context, ds5_subscription_t *sub, int peer, const char *subject, short flags)

Callback invoked when there is an error in a subscription.

Parameters
context- The callback context that was supplied to ds_create_broadcast_subscription() or ds_create_active_subscription().
sub- The subscription for which the update occurred.
peer- The DataSource peer supplying this subscription error.
subject- The subject for which this subscription error has been received.
flags- The type of error that has been received (for example F_NOTFOUND, F_DELETEOBJECT).
void(* ds5_subscriptionlistener_t::subscription_status) (void *context, ds5_subscription_t *sub, int peer, const char *subject, int status, const char *message)

Callback invoked when there is a change in the status of a subscription.

Parameters
context- The callback context that was supplied to ds_create_broadcast_subscription() or ds_create_active_subscription().
sub- The subscription for which the update occurred.
peer- The DataSource peer supplying this subscription status.
subject- The subject for which this subscription error has been received.
status- The new status of the subject (one of OBJ_STATUS_OK, OBJ_STATUS_LIMITED, OBJ_STATUS_STALE, OBJ_STATUS_INFO.
message- A text message that should describe the reason for the status being raised.
void(* ds5_subscriptionlistener_t::unknown_subject_type_updated) (void *context, ds5_subscription_t *sub, int peer, ds_data_t *dsdata)

Callback invoked when an update for an unknown subject type is received.

Parameters
context- The callback context that was supplied to ds_create_broadcast_subscription() or ds_create_active_subscription().
sub- The subscription for which the update occurred.
peer- The DataSource peer supplying the update.
update- The update.

This callback will be invoked when an update for a subject type that is not one of those handled by other callback methods on the ds5_subscription_listener_t interface.


Generated on Wed Jan 24 2018 12:22:46 for DataSource for C SDK