dxFeed Graal Native SDK 3.12.0
Loading...
Searching...
No Matches
dxfg_endpoint.h File Reference

dxFeed Graal Native SDK Endpoint functions and types declarations More...

#include <stdint.h>
#include "dxfg_common.h"
#include "graal_isolate.h"
#include "dxfg_javac.h"

Go to the source code of this file.

Data Structures

struct  dxfg_endpoint_t
 A handle of a Java DXEndpoint object; release it with dxfg_JavaObjectHandler_release(). More...
struct  dxfg_endpoint_builder_t
 A handle of a Java DXEndpoint.Builder object; release it with dxfg_JavaObjectHandler_release(). More...
struct  dxfg_endpoint_state_change_listener_t
 A handle of a Java PropertyChangeListener object that reports the state changes of an endpoint; release it with dxfg_JavaObjectHandler_release(). More...

Typedefs

typedef struct dxfg_feed_t dxfg_feed_t
 Forward declaration of the handle of a Java DXFeed object (see dxfg_feed.h): the result of dxfg_DXEndpoint_getFeed().
typedef struct dxfg_publisher_t dxfg_publisher_t
 Forward declaration of the handle of a Java DXPublisher object (see dxfg_publisher.h): the result of dxfg_DXEndpoint_getPublisher().
typedef struct dxfg_event_clazz_list_t dxfg_event_clazz_list_t
 Forward declaration of the list of event classes (see dxfg_events.h): the result of dxfg_DXEndpoint_getEventTypes().
typedef struct dxfg_endpoint_t dxfg_endpoint_t
 A handle of a Java DXEndpoint object; release it with dxfg_JavaObjectHandler_release().
typedef struct dxfg_endpoint_builder_t dxfg_endpoint_builder_t
 A handle of a Java DXEndpoint.Builder object; release it with dxfg_JavaObjectHandler_release().
typedef struct dxfg_endpoint_state_change_listener_t dxfg_endpoint_state_change_listener_t
 A handle of a Java PropertyChangeListener object that reports the state changes of an endpoint; release it with dxfg_JavaObjectHandler_release().
typedef enum dxfg_endpoint_role_t dxfg_endpoint_role_t
 The role of an endpoint: it is specified when the endpoint is created and cannot be changed afterwards.
typedef enum dxfg_endpoint_state_t dxfg_endpoint_state_t
 The state of an endpoint, see dxfg_DXEndpoint_getState().
typedef 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 changes.

Enumerations

enum  dxfg_endpoint_role_t {
  DXFG_ENDPOINT_ROLE_FEED = 0 , DXFG_ENDPOINT_ROLE_ON_DEMAND_FEED , DXFG_ENDPOINT_ROLE_STREAM_FEED , DXFG_ENDPOINT_ROLE_PUBLISHER ,
  DXFG_ENDPOINT_ROLE_STREAM_PUBLISHER , DXFG_ENDPOINT_ROLE_LOCAL_HUB
}
 The role of an endpoint: it is specified when the endpoint is created and cannot be changed afterwards. More...
enum  dxfg_endpoint_state_t { DXFG_ENDPOINT_STATE_NOT_CONNECTED = 0 , DXFG_ENDPOINT_STATE_CONNECTING , DXFG_ENDPOINT_STATE_CONNECTED , DXFG_ENDPOINT_STATE_CLOSED }
 The state of an endpoint, see dxfg_DXEndpoint_getState(). More...

Functions

dxfg_endpoint_builder_t * dxfg_DXEndpoint_newBuilder (graal_isolatethread_t *thread)
 Creates a new endpoint builder.
int32_t dxfg_DXEndpoint_Builder_withRole (graal_isolatethread_t *thread, dxfg_endpoint_builder_t *builder, dxfg_endpoint_role_t role)
 Sets the role of the endpoints built by the builder.
int32_t dxfg_DXEndpoint_Builder_withName (graal_isolatethread_t *thread, dxfg_endpoint_builder_t *builder, const char *name)
 Sets the name of the endpoints built by the builder.
int32_t dxfg_DXEndpoint_Builder_withProperty (graal_isolatethread_t *thread, dxfg_endpoint_builder_t *builder, const char *key, const char *value)
 Sets a property of the endpoints built by the builder.
int32_t dxfg_DXEndpoint_Builder_withProperties (graal_isolatethread_t *thread, dxfg_endpoint_builder_t *builder, const char *file_path)
 Sets the properties of the endpoints built by the builder from a properties file.
int32_t dxfg_DXEndpoint_Builder_withExecutor (graal_isolatethread_t *thread, dxfg_endpoint_builder_t *builder, dxfg_executor_t *executor)
 Sets the executor of the notifications of the endpoints built by this builder: event processing, state changes, etc.
int32_t dxfg_DXEndpoint_Builder_supportsProperty (graal_isolatethread_t *thread, dxfg_endpoint_builder_t *builder, const char *key)
 Checks whether the builder supports a property.
dxfg_endpoint_t * dxfg_DXEndpoint_Builder_build (graal_isolatethread_t *thread, dxfg_endpoint_builder_t *builder)
 Builds a new endpoint with the builder's settings.
dxfg_endpoint_t * dxfg_DXEndpoint_getInstance (graal_isolatethread_t *thread)
 Returns the default application-wide singleton endpoint with the DXFG_ENDPOINT_ROLE_FEED role, the same one that dxfg_DXFeed_getInstance() uses.
dxfg_endpoint_t * dxfg_DXEndpoint_getInstance2 (graal_isolatethread_t *thread, dxfg_endpoint_role_t role)
 Creates a new endpoint with the given role on every call, the same as dxfg_DXEndpoint_create2().
dxfg_endpoint_t * dxfg_DXEndpoint_create (graal_isolatethread_t *thread)
 Creates a new endpoint with the DXFG_ENDPOINT_ROLE_FEED role.
dxfg_endpoint_t * dxfg_DXEndpoint_create2 (graal_isolatethread_t *thread, dxfg_endpoint_role_t role)
 Creates a new endpoint with the given role.
int32_t dxfg_DXEndpoint_close (graal_isolatethread_t *thread, dxfg_endpoint_t *endpoint)
 Closes the endpoint: disconnects it and releases its resources. The endpoint cannot be used after that.
int32_t dxfg_DXEndpoint_closeAndAwaitTermination (graal_isolatethread_t *thread, dxfg_endpoint_t *endpoint)
 Closes the endpoint and waits until all the data processing and the scheduled notifications are completed.
dxfg_endpoint_role_t dxfg_DXEndpoint_getRole (graal_isolatethread_t *thread, dxfg_endpoint_t *endpoint)
 Returns the role of the endpoint.
int32_t dxfg_DXEndpoint_user (graal_isolatethread_t *thread, dxfg_endpoint_t *endpoint, const char *user)
 Sets the user name of the endpoint.
int32_t dxfg_DXEndpoint_password (graal_isolatethread_t *thread, dxfg_endpoint_t *endpoint, const char *password)
 Sets the password of the endpoint.
int32_t dxfg_DXEndpoint_connect (graal_isolatethread_t *thread, dxfg_endpoint_t *endpoint, const char *address)
 Connects the endpoint to the remote address.
int32_t dxfg_DXEndpoint_reconnect (graal_isolatethread_t *thread, dxfg_endpoint_t *endpoint)
 Terminates all the network connections of the endpoint and initiates connecting again with the same address.
int32_t dxfg_DXEndpoint_disconnect (graal_isolatethread_t *thread, dxfg_endpoint_t *endpoint)
 Terminates all the remote network connections of the endpoint.
int32_t dxfg_DXEndpoint_disconnectAndClear (graal_isolatethread_t *thread, dxfg_endpoint_t *endpoint)
 Terminates all the remote network connections of the endpoint and clears the stored data.
int32_t dxfg_DXEndpoint_awaitProcessed (graal_isolatethread_t *thread, dxfg_endpoint_t *endpoint)
 Waits until the endpoint stops processing data (becomes quiescent).
int32_t dxfg_DXEndpoint_awaitNotConnected (graal_isolatethread_t *thread, dxfg_endpoint_t *endpoint)
 Waits until the state of the endpoint becomes DXFG_ENDPOINT_STATE_NOT_CONNECTED or DXFG_ENDPOINT_STATE_CLOSED.
dxfg_endpoint_state_t dxfg_DXEndpoint_getState (graal_isolatethread_t *thread, dxfg_endpoint_t *endpoint)
 Returns the state of the endpoint.
int32_t dxfg_DXEndpoint_addStateChangeListener (graal_isolatethread_t *thread, dxfg_endpoint_t *endpoint, dxfg_endpoint_state_change_listener_t *listener)
 Adds the state change listener (see dxfg_PropertyChangeListener_new()).
int32_t dxfg_DXEndpoint_removeStateChangeListener (graal_isolatethread_t *thread, dxfg_endpoint_t *endpoint, dxfg_endpoint_state_change_listener_t *listener)
 Removes the state change listener that was added with dxfg_DXEndpoint_addStateChangeListener().
dxfg_feed_t * dxfg_DXEndpoint_getFeed (graal_isolatethread_t *thread, dxfg_endpoint_t *endpoint)
 Returns the feed of the endpoint.
dxfg_publisher_t * dxfg_DXEndpoint_getPublisher (graal_isolatethread_t *thread, dxfg_endpoint_t *endpoint)
 Returns the publisher of the endpoint.
int32_t dxfg_DXEndpoint_executor (graal_isolatethread_t *thread, dxfg_endpoint_t *endpoint, dxfg_executor_t *executor)
 Changes the executor of the endpoint's notifications.
dxfg_event_clazz_list_t * dxfg_DXEndpoint_getEventTypes (graal_isolatethread_t *thread, dxfg_endpoint_t *endpoint)
 Returns the event types that the endpoint supports.
int32_t dxfg_DXEndpoint_getRequestedAggregationPeriod (graal_isolatethread_t *thread, dxfg_endpoint_t *endpoint, DXFG_OUT dxfg_time_period_t **period)
 Returns the aggregation period that the endpoint requests from the server.
int32_t dxfg_DXEndpoint_getRequestedAggregationPeriodMillis (graal_isolatethread_t *thread, dxfg_endpoint_t *endpoint, DXFG_OUT int64_t *period)
 Returns the aggregation period (in millis) that the endpoint requests from the server.
int32_t dxfg_DXEndpoint_setRequestedAggregationPeriod (graal_isolatethread_t *thread, dxfg_endpoint_t *endpoint, dxfg_time_period_t *period)
 Sets the aggregation period that the endpoint requests from the server.
int32_t dxfg_DXEndpoint_setRequestedAggregationPeriodMillis (graal_isolatethread_t *thread, dxfg_endpoint_t *endpoint, int64_t period)
 Sets the aggregation period (in millis) that the endpoint requests from the server.
int32_t dxfg_DXEndpoint_getAggregationPeriodInfo (graal_isolatethread_t *thread, dxfg_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.
dxfg_endpoint_state_change_listener_t * dxfg_PropertyChangeListener_new (graal_isolatethread_t *thread, dxfg_endpoint_state_change_listener_func user_func, void *user_data)
 Creates a new endpoint state change listener.

Detailed Description

dxFeed Graal Native SDK Endpoint functions and types declarations