Subscription initiation/closing functions.
More...
|
DXFEED_API ERRORCODE | dxf_create_subscription (dxf_connection_t connection, int event_types, OUT dxf_subscription_t *subscription) |
| Creates a subscription with the specified parameters. More...
|
|
DXFEED_API ERRORCODE | dxf_create_subscription_with_flags (dxf_connection_t connection, int event_types, dx_event_subscr_flag subscr_flags, OUT dxf_subscription_t *subscription) |
| Creates a subscription with the specified parameters and the subscription flags. More...
|
|
DXFEED_API ERRORCODE | dxf_create_subscription_timed (dxf_connection_t connection, int event_types, dxf_long_t time, OUT dxf_subscription_t *subscription) |
| Creates a timed subscription with the specified parameters. More...
|
|
DXFEED_API ERRORCODE | dxf_create_subscription_timed_with_flags (dxf_connection_t connection, int event_types, dxf_long_t time, dx_event_subscr_flag subscr_flags, OUT dxf_subscription_t *subscription) |
| Creates a timed subscription with the specified parameters and the subscription flags. More...
|
|
DXFEED_API ERRORCODE | dxf_close_subscription (dxf_subscription_t subscription) |
| Closes a subscription. More...
|
|
size_t | dx_get_event_subscription_params (dxf_connection_t connection, dx_order_source_array_ptr_t order_source, dx_event_id_t event_id, dx_event_subscr_flag subscr_flags, OUT dx_event_subscription_param_list_t *params) |
| Returns the list of subscription params. Fills records list according to event_id. More...
|
|
Subscription initiation/closing functions.
◆ dx_get_event_subscription_params()
Returns the list of subscription params. Fills records list according to event_id.
- Parameters
-
[in] | connection | Connection handle |
[in] | order_source | Order source |
[in] | event_id | Event id |
[in] | subscr_flags | Subscription flags |
[out] | params | Subscription params |
- Warning
- You need to call dx_free(params.elements) to free resources.
◆ dxf_close_subscription()
Closes a subscription.
All the data associated with it will be disposed. As a side-effect, API error is reset.
- Parameters
-
[in] | subscription | A handle of the subscription to close |
- Returns
- DXF_SUCCESS on successful subscription closure or DXF_FAILURE on error; dxf_get_last_error can be used to retrieve the error code and description in case of failure;
◆ dxf_create_subscription()
Creates a subscription with the specified parameters.
- Parameters
-
[in] | connection | A handle of a previously created connection which the subscription will be using |
[in] | event_types | A bitmask of the subscription event types. See dx_event_id_t and DX_EVENT_BIT_MASK for information on how to create an event type bitmask |
[out] | subscription | A handle of the created subscription |
- Returns
- DXF_SUCCESS on successful subscription creation or DXF_FAILURE on error; dxf_get_last_error can be used to retrieve the error code and description in case of failure; a handle to newly created subscription is returned via
subscription
out parameter
◆ dxf_create_subscription_timed()
Creates a timed subscription with the specified parameters.
- Parameters
-
[in] | connection | A handle of a previously created connection which the subscription will be using |
[in] | event_types | A bitmask of the subscription event types. See dx_event_id_t and DX_EVENT_BIT_MASK for information on how to create an event type bitmask |
[in] | time | UTC time in the past (unix time in milliseconds) |
[out] | subscription | A handle of the created subscription |
- Returns
- DXF_SUCCESS on successful subscription creation or DXF_FAILURE on error; dxf_get_last_error can be used to retrieve the error code and description in case of failure; a handle to newly created subscription is returned via
subscription
out parameter
◆ dxf_create_subscription_timed_with_flags()
Creates a timed subscription with the specified parameters and the subscription flags.
- Parameters
-
[in] | connection | A handle of a previously created connection which the subscription will be using |
[in] | event_types | A bitmask of the subscription event types. See dx_event_id_t and DX_EVENT_BIT_MASK for information on how to create an event type bitmask |
[in] | time | UTC time in the past (unix time in milliseconds) |
[in] | subscr_flags | A bitmask of the subscription event flags. See dx_event_subscr_flag |
[out] | subscription | A handle of the created subscription |
- Returns
- DXF_SUCCESS on successful subscription creation or DXF_FAILURE on error; dxf_get_last_error can be used to retrieve the error code and description in case of failure; a handle to newly created subscription is returned via
subscription
out parameter
◆ dxf_create_subscription_with_flags()
Creates a subscription with the specified parameters and the subscription flags.
- Parameters
-
[in] | connection | A handle of a previously created connection which the subscription will be using |
[in] | event_types | A bitmask of the subscription event types. See dx_event_id_t and DX_EVENT_BIT_MASK for information on how to create an event type bitmask |
[in] | subscr_flags | A bitmask of the subscription event flags. See dx_event_subscr_flag |
[out] | subscription | A handle of the created subscription |
- Returns
- DXF_SUCCESS on successful subscription creation or DXF_FAILURE on error; dxf_get_last_error can be used to retrieve the error code and description in case of failure; a handle to newly created subscription is returned via
subscription
out parameter