dxFeed Graal Native SDK 3.13.0
Loading...
Searching...
No Matches
dxfg_v4_endpoint.h
Go to the documentation of this file.
1// Copyright (c) 2026 Devexperts LLC.
2// SPDX-License-Identifier: MPL-2.0
3
8
9#ifndef DXFG_V4_ENDPOINT_H
10#define DXFG_V4_ENDPOINT_H
11
12#include "dxfg_endpoint.h"
13#include "dxfg_v4_common.h"
14#include "dxfg_v4_javac.h"
15
16#ifdef __cplusplus
17extern "C" {
18#endif
19
26
29
32
35
38
41
44
47
50
53
68
84
101 const char *name);
102
120 const char *key, const char *value);
121
138 const char *file_path);
139
165 dxfg_v4_executor_t *executor);
166
183 const char *key, DXFG_OUT int32_t *supported);
184
203 DXFG_OUT dxfg_v4_endpoint_t **endpoint);
204
223
243 DXFG_OUT dxfg_v4_endpoint_t **endpoint);
244
258
273 DXFG_OUT dxfg_v4_endpoint_t **endpoint);
274
293
312
326
341int32_t dxfg_v4_DXEndpoint_user(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint, const char *user);
342
357int32_t dxfg_v4_DXEndpoint_password(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint, const char *password);
358
381int32_t dxfg_v4_DXEndpoint_connect(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint, const char *address);
382
402
418
434
453
474
488
510
529
546 DXFG_OUT dxfg_v4_feed_t **feed);
547
564 DXFG_OUT dxfg_v4_publisher_t **publisher);
565
583
598
612 dxfg_v4_endpoint_t *endpoint, DXFG_OUT int64_t *period);
613
633 dxfg_v4_time_period_t *period);
634
652 dxfg_v4_endpoint_t *endpoint, int64_t period);
653
670 DXFG_OUT int64_t *min, DXFG_OUT int64_t *max);
671
695 dxfg_v4_endpoint_state_change_listener_func user_func, void *user_data,
697 // end of V4_Endpoint
699
700#ifdef __cplusplus
701}
702#endif
703
704#endif // DXFG_V4_ENDPOINT_H
dxFeed Graal Native SDK Endpoint functions and types declarations
The v4 functions of dxfg_common.h and the v4 names of its types (see the group Common (v4)).
The v4 functions of dxfg_javac.h and the v4 names of its types (see the group Javac (v4)).
struct __graal_isolatethread_t graal_isolatethread_t
The state of one thread attached to an isolate: the first parameter (thread) of the SDK functions.
Definition graal_isolate.h:60
#define DXFG_OUT
Definition dxfg_common.h:37
void(*) dxfg_endpoint_state_change_listener_func(graal_isolatethread_t *thread, dxfg_endpoint_state_t old_state, dxfg_endpoint_state_t new_state, void *user_data)
The function of a dxfg_endpoint_state_change_listener_t: called when the state of the endpoint change...
Definition dxfg_endpoint.h:175
dxfg_endpoint_state_t
The state of an endpoint, see dxfg_DXEndpoint_getState().
Definition dxfg_endpoint.h:147
dxfg_endpoint_role_t
The role of an endpoint: it is specified when the endpoint is created and cannot be changed afterward...
Definition dxfg_endpoint.h:111
int32_t dxfg_v4_DXEndpoint_create(graal_isolatethread_t *thread, DXFG_OUT dxfg_v4_endpoint_t **endpoint)
Creates a new endpoint with the DXFG_ENDPOINT_ROLE_FEED role.
int32_t dxfg_v4_DXEndpoint_awaitProcessed(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint)
Waits until the endpoint stops processing data (becomes quiescent).
int32_t dxfg_v4_DXEndpoint_getInstance(graal_isolatethread_t *thread, DXFG_OUT dxfg_v4_endpoint_t **endpoint)
Returns the default application-wide singleton endpoint with the DXFG_ENDPOINT_ROLE_FEED role,...
int32_t dxfg_v4_DXEndpoint_createWithRole(graal_isolatethread_t *thread, dxfg_v4_endpoint_role_t role, DXFG_OUT dxfg_v4_endpoint_t **endpoint)
Creates a new endpoint with the given role.
int32_t dxfg_v4_DXEndpoint_getRequestedAggregationPeriod(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint, DXFG_OUT dxfg_v4_time_period_t **period)
Returns the aggregation period that the endpoint requests from the server.
int32_t dxfg_v4_DXEndpoint_getRequestedAggregationPeriodMillis(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint, DXFG_OUT int64_t *period)
Returns the aggregation period (in millis) that the endpoint requests from the server.
int32_t dxfg_v4_DXEndpoint_addStateChangeListener(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint, dxfg_v4_endpoint_state_change_listener_t *listener)
Adds the state change listener (see dxfg_v4_PropertyChangeListener_new()).
int32_t dxfg_v4_DXEndpoint_getFeed(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint, DXFG_OUT dxfg_v4_feed_t **feed)
Returns the feed of the endpoint.
dxfg_endpoint_state_t dxfg_v4_endpoint_state_t
The state of an endpoint, see dxfg_DXEndpoint_getState().
Definition dxfg_v4_endpoint.h:49
int32_t dxfg_v4_DXEndpoint_getRole(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint, DXFG_OUT dxfg_v4_endpoint_role_t *role)
Returns the role of the endpoint.
int32_t dxfg_v4_DXEndpoint_Builder_build(graal_isolatethread_t *thread, dxfg_v4_endpoint_builder_t *builder, DXFG_OUT dxfg_v4_endpoint_t **endpoint)
Builds a new endpoint with the builder's settings.
int32_t dxfg_v4_DXEndpoint_newBuilder(graal_isolatethread_t *thread, DXFG_OUT dxfg_v4_endpoint_builder_t **builder)
Creates a new endpoint builder.
int32_t dxfg_v4_DXEndpoint_getEventTypes(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint, DXFG_OUT dxfg_v4_event_clazz_list **eventTypes)
Returns the event types that the endpoint supports.
int32_t dxfg_v4_DXEndpoint_getAggregationPeriodInfo(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint, DXFG_OUT int64_t *min, DXFG_OUT int64_t *max)
Returns the aggregation period that the servers apply, over all connections of the endpoint.
int32_t dxfg_v4_DXEndpoint_disconnectAndClear(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint)
Terminates all the remote network connections of the endpoint and clears the stored data.
int32_t dxfg_v4_DXEndpoint_Builder_withName(graal_isolatethread_t *thread, dxfg_v4_endpoint_builder_t *builder, const char *name)
Sets the name of the endpoints built by the builder.
int32_t dxfg_v4_DXEndpoint_getPublisher(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint, DXFG_OUT dxfg_v4_publisher_t **publisher)
Returns the publisher of the endpoint.
int32_t dxfg_v4_DXEndpoint_getState(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint, DXFG_OUT dxfg_v4_endpoint_state_t *state)
Returns the state of the endpoint.
dxfg_endpoint_t dxfg_v4_endpoint_t
A handle of a Java DXEndpoint object; release it with dxfg_JavaObjectHandler_release().
Definition dxfg_v4_endpoint.h:37
int32_t dxfg_v4_DXEndpoint_closeAndAwaitTermination(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint)
Closes the endpoint and waits until all the data processing and the scheduled notifications are compl...
dxfg_endpoint_role_t dxfg_v4_endpoint_role_t
The role of an endpoint: it is specified when the endpoint is created and cannot be changed afterward...
Definition dxfg_v4_endpoint.h:46
int32_t dxfg_v4_DXEndpoint_setRequestedAggregationPeriodMillis(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint, int64_t period)
Sets the aggregation period (in millis) that the endpoint requests from the server.
int32_t dxfg_v4_PropertyChangeListener_new(graal_isolatethread_t *thread, dxfg_v4_endpoint_state_change_listener_func user_func, void *user_data, DXFG_OUT dxfg_v4_endpoint_state_change_listener_t **listener)
Creates a new endpoint state change listener.
int32_t dxfg_v4_DXEndpoint_user(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint, const char *user)
Sets the user name of the endpoint.
int32_t dxfg_v4_DXEndpoint_Builder_withRole(graal_isolatethread_t *thread, dxfg_v4_endpoint_builder_t *builder, dxfg_v4_endpoint_role_t role)
Sets the role of the endpoints built by the builder.
int32_t dxfg_v4_DXEndpoint_setRequestedAggregationPeriod(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint, dxfg_v4_time_period_t *period)
Sets the aggregation period that the endpoint requests from the server.
int32_t dxfg_v4_DXEndpoint_reconnect(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint)
Terminates all the network connections of the endpoint and initiates connecting again with the same a...
int32_t dxfg_v4_DXEndpoint_Builder_withProperties(graal_isolatethread_t *thread, dxfg_v4_endpoint_builder_t *builder, const char *file_path)
Sets the properties of the endpoints built by the builder from a properties file.
dxfg_event_clazz_list_t dxfg_v4_event_clazz_list
A list of event classes.
Definition dxfg_v4_endpoint.h:34
int32_t dxfg_v4_DXEndpoint_connect(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint, const char *address)
Connects the endpoint to the remote address.
dxfg_endpoint_state_change_listener_t dxfg_v4_endpoint_state_change_listener_t
A handle of a Java PropertyChangeListener object that reports the state changes of an endpoint; relea...
Definition dxfg_v4_endpoint.h:43
int32_t dxfg_v4_DXEndpoint_removeStateChangeListener(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint, dxfg_v4_endpoint_state_change_listener_t *listener)
Removes the state change listener that was added with dxfg_v4_DXEndpoint_addStateChangeListener().
int32_t dxfg_v4_DXEndpoint_password(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint, const char *password)
Sets the password of the endpoint.
dxfg_endpoint_builder_t dxfg_v4_endpoint_builder_t
A handle of a Java DXEndpoint.Builder object; release it with dxfg_JavaObjectHandler_release().
Definition dxfg_v4_endpoint.h:40
dxfg_publisher_t dxfg_v4_publisher_t
A handle of a Java DXPublisher object; release it with dxfg_JavaObjectHandler_release().
Definition dxfg_v4_endpoint.h:31
int32_t dxfg_v4_DXEndpoint_awaitNotConnected(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint)
Waits until the state of the endpoint becomes DXFG_ENDPOINT_STATE_NOT_CONNECTED or DXFG_ENDPOINT_STAT...
int32_t dxfg_v4_DXEndpoint_Builder_supportsProperty(graal_isolatethread_t *thread, dxfg_v4_endpoint_builder_t *builder, const char *key, DXFG_OUT int32_t *supported)
Checks whether the builder supports a property.
dxfg_endpoint_state_change_listener_func dxfg_v4_endpoint_state_change_listener_func
The function of a dxfg_endpoint_state_change_listener_t: called when the state of the endpoint change...
Definition dxfg_v4_endpoint.h:52
int32_t dxfg_v4_DXEndpoint_disconnect(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint)
Terminates all the remote network connections of the endpoint.
int32_t dxfg_v4_DXEndpoint_close(graal_isolatethread_t *thread, dxfg_v4_endpoint_t *endpoint)
Closes the endpoint: disconnects it and releases its resources. The endpoint cannot be used after tha...
int32_t dxfg_v4_DXEndpoint_Builder_withProperty(graal_isolatethread_t *thread, dxfg_v4_endpoint_builder_t *builder, const char *key, const char *value)
Sets a property of the endpoints built by the builder.
dxfg_feed_t dxfg_v4_feed_t
A handle of a Java DXFeed object; release it with dxfg_JavaObjectHandler_release().
Definition dxfg_v4_endpoint.h:28
int32_t dxfg_v4_DXEndpoint_getInstanceWithRole(graal_isolatethread_t *thread, dxfg_v4_endpoint_role_t role, DXFG_OUT dxfg_v4_endpoint_t **endpoint)
Creates a new endpoint with the given role on every call, the same as dxfg_v4_DXEndpoint_createWithRo...
int32_t dxfg_v4_DXEndpoint_Builder_withExecutor(graal_isolatethread_t *thread, dxfg_v4_endpoint_builder_t *builder, dxfg_v4_executor_t *executor)
Sets the executor of the notifications of the endpoints built by this builder: event processing,...
dxfg_executor_t dxfg_v4_executor_t
A handle of a Java Executor object; release it with dxfg_JavaObjectHandler_release().
Definition dxfg_v4_feed.h:36
dxfg_time_period_t dxfg_v4_time_period_t
A handle of a Java TimePeriod object; release it with dxfg_JavaObjectHandler_release().
Definition dxfg_v4_javac.h:48
A handle of a Java DXEndpoint.Builder object; release it with dxfg_JavaObjectHandler_release().
Definition dxfg_endpoint.h:81
A handle of a Java PropertyChangeListener object that reports the state changes of an endpoint; relea...
Definition dxfg_endpoint.h:96
A handle of a Java DXEndpoint object; release it with dxfg_JavaObjectHandler_release().
Definition dxfg_endpoint.h:68
A list of event classes.
Definition dxfg_events.h:1227
A handle of a Java DXFeed object; release it with dxfg_JavaObjectHandler_release().
Definition dxfg_feed.h:61
A handle of a Java DXPublisher object; release it with dxfg_JavaObjectHandler_release().
Definition dxfg_publisher.h:54