dxFeed Graal Native SDK 3.9.0
Loading...
Searching...
No Matches
CandleWebService

Data Structures

struct  dxfg_history_endpoint_t
struct  dxfg_history_endpoint_builder_t

Typedefs

typedef struct dxfg_history_endpoint_t dxfg_history_endpoint_t
typedef struct dxfg_history_endpoint_builder_t dxfg_history_endpoint_builder_t
typedef enum dxfg_history_endpoint_compression_t dxfg_history_endpoint_compression_t
typedef enum dxfg_history_endpoint_format_t dxfg_history_endpoint_format_t

Enumerations

enum  dxfg_history_endpoint_compression_t { DXFG_HISTORY_ENDPOINT_COMPRESSION_NONE = 0 , DXFG_HISTORY_ENDPOINT_COMPRESSION_ZIP , DXFG_HISTORY_ENDPOINT_COMPRESSION_GZIP }
enum  dxfg_history_endpoint_format_t { DXFG_HISTORY_ENDPOINT_FORMAT_TEXT = 0 , DXFG_HISTORY_ENDPOINT_FORMAT_CSV , DXFG_HISTORY_ENDPOINT_FORMAT_BINARY }

Functions

int32_t dxfg_HistoryEndpoint_newBuilder (graal_isolatethread_t *thread, DXFG_OUT dxfg_history_endpoint_builder_t **builder)
int32_t dxfg_HistoryEndpoint_getTimeSeries (graal_isolatethread_t *thread, dxfg_history_endpoint_t *endpoint, dxfg_event_clazz_t eventClazz, dxfg_symbol_t *symbol, int64_t fromTime, int64_t toTime, DXFG_OUT dxfg_event_type_list **events)
int32_t dxfg_HistoryEndpoint_Builder_withAddress (graal_isolatethread_t *thread, dxfg_history_endpoint_builder_t *builder, const char *address)
int32_t dxfg_HistoryEndpoint_Builder_withUserName (graal_isolatethread_t *thread, dxfg_history_endpoint_builder_t *builder, const char *userName)
int32_t dxfg_HistoryEndpoint_Builder_withPassword (graal_isolatethread_t *thread, dxfg_history_endpoint_builder_t *builder, const char *password)
int32_t dxfg_HistoryEndpoint_Builder_withAuthToken (graal_isolatethread_t *thread, dxfg_history_endpoint_builder_t *builder, const char *authToken)
int32_t dxfg_HistoryEndpoint_Builder_withCompression (graal_isolatethread_t *thread, dxfg_history_endpoint_builder_t *builder, dxfg_history_endpoint_compression_t compression)
int32_t dxfg_HistoryEndpoint_Builder_withFormat (graal_isolatethread_t *thread, dxfg_history_endpoint_builder_t *builder, dxfg_history_endpoint_format_t format)
int32_t dxfg_HistoryEndpoint_Builder_build (graal_isolatethread_t *thread, dxfg_history_endpoint_builder_t *builder, DXFG_OUT dxfg_history_endpoint_t **endpoint)

Detailed Description

Typedef Documentation

◆ dxfg_history_endpoint_builder_t

typedef struct dxfg_history_endpoint_builder_t dxfg_history_endpoint_builder_t

◆ dxfg_history_endpoint_compression_t

◆ dxfg_history_endpoint_format_t

◆ dxfg_history_endpoint_t

typedef struct dxfg_history_endpoint_t dxfg_history_endpoint_t

Enumeration Type Documentation

◆ dxfg_history_endpoint_compression_t

Enumerator
DXFG_HISTORY_ENDPOINT_COMPRESSION_NONE 
DXFG_HISTORY_ENDPOINT_COMPRESSION_ZIP 
DXFG_HISTORY_ENDPOINT_COMPRESSION_GZIP 

◆ dxfg_history_endpoint_format_t

Enumerator
DXFG_HISTORY_ENDPOINT_FORMAT_TEXT 
DXFG_HISTORY_ENDPOINT_FORMAT_CSV 
DXFG_HISTORY_ENDPOINT_FORMAT_BINARY 

Function Documentation

◆ dxfg_HistoryEndpoint_Builder_build()

int32_t dxfg_HistoryEndpoint_Builder_build ( graal_isolatethread_t * thread,
dxfg_history_endpoint_builder_t * builder,
DXFG_OUT dxfg_history_endpoint_t ** endpoint )

Builds and returns a configured instance of HistoryEndpoint(dxfg_history_endpoint_t).

This method uses the values set in the builder instance, such as address, username, password, compression, format, and authentication token, to create a new HistoryEndpoint(dxfg_history_endpoint_t) object.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]builderThe history endpoint's builder.
[out]endpointA new instance of HistoryEndpoint(dxfg_history_endpoint_t) configured with the provided settings.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown. Use dxfg_JavaObjectHandler_release() to free the object handle.

◆ dxfg_HistoryEndpoint_Builder_withAddress()

int32_t dxfg_HistoryEndpoint_Builder_withAddress ( graal_isolatethread_t * thread,
dxfg_history_endpoint_builder_t * builder,
const char * address )

Specifies the address for the target endpoint.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]builderThe history endpoint's builder.
[in]addressThe address of the endpoint to be set.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown.

◆ dxfg_HistoryEndpoint_Builder_withAuthToken()

int32_t dxfg_HistoryEndpoint_Builder_withAuthToken ( graal_isolatethread_t * thread,
dxfg_history_endpoint_builder_t * builder,
const char * authToken )

Sets the authentication token for the target endpoint.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]builderThe history endpoint's builder.
[in]authTokenThe authentication token to be used for access.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown.

◆ dxfg_HistoryEndpoint_Builder_withCompression()

int32_t dxfg_HistoryEndpoint_Builder_withCompression ( graal_isolatethread_t * thread,
dxfg_history_endpoint_builder_t * builder,
dxfg_history_endpoint_compression_t compression )

Sets the compression type to be used for data transmission or storage.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]builderThe history endpoint's builder.
[in]compressionThe compression type to be applied, represented by the dxfg_history_endpoint_compression_t enum
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown.

◆ dxfg_HistoryEndpoint_Builder_withFormat()

int32_t dxfg_HistoryEndpoint_Builder_withFormat ( graal_isolatethread_t * thread,
dxfg_history_endpoint_builder_t * builder,
dxfg_history_endpoint_format_t format )

Sets the format to be used for data handling.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]builderThe history endpoint's builder.
[in]formatThe format type to be applied, represented by the dxfg_history_endpoint_format_t enum.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown.

◆ dxfg_HistoryEndpoint_Builder_withPassword()

int32_t dxfg_HistoryEndpoint_Builder_withPassword ( graal_isolatethread_t * thread,
dxfg_history_endpoint_builder_t * builder,
const char * password )

Sets the password for the target endpoint.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]builderThe history endpoint's builder.
[in]passwordThe password to be set for the endpoint.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown.

◆ dxfg_HistoryEndpoint_Builder_withUserName()

int32_t dxfg_HistoryEndpoint_Builder_withUserName ( graal_isolatethread_t * thread,
dxfg_history_endpoint_builder_t * builder,
const char * userName )

Sets the username for the target endpoint.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]builderThe history endpoint's builder.
[in]userNameThe username to be set for the endpoint.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown.

◆ dxfg_HistoryEndpoint_getTimeSeries()

int32_t dxfg_HistoryEndpoint_getTimeSeries ( graal_isolatethread_t * thread,
dxfg_history_endpoint_t * endpoint,
dxfg_event_clazz_t eventClazz,
dxfg_symbol_t * symbol,
int64_t fromTime,
int64_t toTime,
DXFG_OUT dxfg_event_type_list ** events )

Retrieves a list of time series events for a specific type of event and symbol within the given time range.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]endpointThe history endpoint.
[in]eventClazzThe class representing the type of event to retrieve.
[in]symbolThe identifier of the symbol for which the time series data is requested.
[in]fromTimeThe start timestamp for the time series query, in milliseconds since epoch.
[in]toTimeThe end timestamp for the time series query, in milliseconds since epoch.
[out]eventsA list of events of the specified type and symbol within the given time range
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown. Use dxfg_CList_EventType_release() to free the events.

◆ dxfg_HistoryEndpoint_newBuilder()

int32_t dxfg_HistoryEndpoint_newBuilder ( graal_isolatethread_t * thread,
DXFG_OUT dxfg_history_endpoint_builder_t ** builder )

Creates a new instance of HistoryEndpoint.Builder(dxfg_history_endpoint_builder_t) with default configurations.

The default settings include:

  • DXFG_HISTORY_ENDPOINT_COMPRESSION_ZIP as the compression type.
  • DXFG_HISTORY_ENDPOINT_FORMAT_BINARY as the data format.
Parameters
[in]threadThe current GraalVM Isolate's thread.
[out]builderThe new builder instance.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown. Use dxfg_JavaObjectHandler_release() to free the object handle.