dxFeed Graal Native SDK 3.13.0-rc2
Loading...
Searching...
No Matches
InstrumentProfile

Instrument profiles: reading of instrument profile files, live connections to an instrument profile source, the collector of the profiles, and the custom fields. More...

Data Structures

struct  dxfg_ipf_connection_t
 A handle of a Java InstrumentProfileConnection object; release it with dxfg_JavaObjectHandler_release(). More...
struct  dxfg_instrument_profile_reader_t
 A handle of a Java InstrumentProfileReader object; release it with dxfg_JavaObjectHandler_release(). More...
struct  dxfg_ipf_connection_state_change_listener_t
 A handle of a Java PropertyChangeListener object; release it with dxfg_JavaObjectHandler_release(). More...
struct  dxfg_ipf_collector_t
 A handle of a Java InstrumentProfileCollector object; release it with dxfg_JavaObjectHandler_release(). More...
struct  dxfg_instrument_profile_t
 A handle of a Java InstrumentProfile object; release it with dxfg_JavaObjectHandler_release(). More...
struct  dxfg_instrument_profile_list
 A list of instrument profile handles. More...
struct  dxfg_ipf_update_listener_t
 A handle of a Java InstrumentProfileUpdateListener object; release it with dxfg_JavaObjectHandler_release(). More...
struct  dxfg_iterable_ip_t
 A handle of a Java Iterator object over instrument profiles; release it with dxfg_JavaObjectHandler_release(). More...
struct  dxfg_instrument_profile_custom_fields_t
 A handle of a Java InstrumentProfileCustomFields object; release it with dxfg_JavaObjectHandler_release(). More...
struct  dxfg_instrument_profile2_t
 The fields of an instrument profile in a plain C structure, with the handle of its custom fields. More...
struct  dxfg_instrument_profile2_list_t
 A list of dxfg_instrument_profile2_t structures. More...

Typedefs

typedef struct dxfg_ipf_connection_t dxfg_ipf_connection_t
 A handle of a Java InstrumentProfileConnection object; release it with dxfg_JavaObjectHandler_release().
typedef struct dxfg_instrument_profile_reader_t dxfg_instrument_profile_reader_t
 A handle of a Java InstrumentProfileReader object; release it with dxfg_JavaObjectHandler_release().
typedef struct dxfg_ipf_connection_state_change_listener_t dxfg_ipf_connection_state_change_listener_t
 A handle of a Java PropertyChangeListener object; release it with dxfg_JavaObjectHandler_release().
typedef enum dxfg_ipf_connection_state_t dxfg_ipf_connection_state_t
 The state of an instrument profile connection.
typedef void(*) dxfg_ipf_connection_state_change_listener_func(graal_isolatethread_t *thread, dxfg_ipf_connection_state_t old_state, dxfg_ipf_connection_state_t new_state, void *user_data)
 The function of a dxfg_ipf_connection_state_change_listener_t: called when the state of the connection changes.
typedef struct dxfg_ipf_collector_t dxfg_ipf_collector_t
 A handle of a Java InstrumentProfileCollector object; release it with dxfg_JavaObjectHandler_release().
typedef struct dxfg_instrument_profile_t dxfg_instrument_profile_t
 A handle of a Java InstrumentProfile object; release it with dxfg_JavaObjectHandler_release().
typedef struct dxfg_instrument_profile_list dxfg_instrument_profile_list
 A list of instrument profile handles.
typedef struct dxfg_ipf_update_listener_t dxfg_ipf_update_listener_t
 A handle of a Java InstrumentProfileUpdateListener object; release it with dxfg_JavaObjectHandler_release().
typedef struct dxfg_iterable_ip_t dxfg_iterable_ip_t
 A handle of a Java Iterator object over instrument profiles; release it with dxfg_JavaObjectHandler_release().
typedef void(*) dxfg_ipf_update_listener_function(graal_isolatethread_t *thread, dxfg_iterable_ip_t *profiles, void *user_data)
 The function of a dxfg_ipf_update_listener_t: called when the set of the instrument profiles of the collector changes.
typedef struct dxfg_instrument_profile_custom_fields_t dxfg_instrument_profile_custom_fields_t
 A handle of a Java InstrumentProfileCustomFields object; release it with dxfg_JavaObjectHandler_release().
typedef struct dxfg_instrument_profile2_t dxfg_instrument_profile2_t
 The fields of an instrument profile in a plain C structure, with the handle of its custom fields.
typedef struct dxfg_instrument_profile2_list_t dxfg_instrument_profile2_list_t
 A list of dxfg_instrument_profile2_t structures.

Enumerations

enum  dxfg_ipf_connection_state_t {
  DXFG_IPF_CONNECTION_STATE_NOT_CONNECTED = 0 , DXFG_IPF_CONNECTION_STATE_CONNECTING , DXFG_IPF_CONNECTION_STATE_CONNECTED , DXFG_IPF_CONNECTION_STATE_COMPLETED ,
  DXFG_IPF_CONNECTION_STATE_CLOSED
}
 The state of an instrument profile connection. More...

Functions

dxfg_ipf_connection_t * dxfg_InstrumentProfileConnection_createConnection (graal_isolatethread_t *thread, const char *address, dxfg_ipf_collector_t *collector)
 Creates an instrument profile connection to an address that pushes the profiles into a collector.
const char * dxfg_InstrumentProfileConnection_getAddress (graal_isolatethread_t *thread, dxfg_ipf_connection_t *connection)
 Returns the address of the connection, without the additional options given as a part of it.
int64_t dxfg_InstrumentProfileConnection_getUpdatePeriod (graal_isolatethread_t *thread, dxfg_ipf_connection_t *connection)
 Returns the update period of the connection in milliseconds.
int32_t dxfg_InstrumentProfileConnection_setUpdatePeriod (graal_isolatethread_t *thread, dxfg_ipf_connection_t *connection, int64_t newValue)
 Changes the update period of the connection.
dxfg_ipf_connection_state_t dxfg_InstrumentProfileConnection_getState (graal_isolatethread_t *thread, dxfg_ipf_connection_t *connection)
 Returns the state of the connection.
int64_t dxfg_InstrumentProfileConnection_getLastModified (graal_isolatethread_t *thread, dxfg_ipf_connection_t *connection)
 Returns the last modification time of the instrument profiles in milliseconds, or 0 if it is unknown.
int32_t dxfg_InstrumentProfileConnection_start (graal_isolatethread_t *thread, dxfg_ipf_connection_t *connection)
 Starts the connection.
int32_t dxfg_InstrumentProfileConnection_close (graal_isolatethread_t *thread, dxfg_ipf_connection_t *connection)
 Closes the connection.
dxfg_ipf_connection_state_change_listener_t * dxfg_IpfPropertyChangeListener_new (graal_isolatethread_t *thread, dxfg_ipf_connection_state_change_listener_func user_func, void *user_data)
 Creates a listener of the state changes of a connection that calls a C function.
int32_t dxfg_InstrumentProfileConnection_addStateChangeListener (graal_isolatethread_t *thread, dxfg_ipf_connection_t *connection, dxfg_ipf_connection_state_change_listener_t *listener)
 Adds a listener of the state changes of the connection.
int32_t dxfg_InstrumentProfileConnection_removeStateChangeListener (graal_isolatethread_t *thread, dxfg_ipf_connection_t *connection, dxfg_ipf_connection_state_change_listener_t *listener)
 Removes a listener of the state changes of the connection.
int32_t dxfg_InstrumentProfileConnection_waitUntilCompleted (graal_isolatethread_t *thread, dxfg_ipf_connection_t *connection, int64_t timeoutInMs)
 Waits until the initial snapshot of the instrument profiles is fully read, for at most the timeout.
int32_t dxfg_CList_InstrumentProfile_wrapper_release (graal_isolatethread_t *thread, dxfg_instrument_profile_list *ips)
 Releases the list structure only and keeps the instrument profile handles in it.
int32_t dxfg_CList_InstrumentProfile_release (graal_isolatethread_t *thread, dxfg_instrument_profile_list *ips)
 Releases the list and all the instrument profile handles in it.
dxfg_ipf_collector_t * dxfg_InstrumentProfileCollector_new (graal_isolatethread_t *thread)
 Creates an instrument profile collector.
int64_t dxfg_InstrumentProfileCollector_getLastUpdateTime (graal_isolatethread_t *thread, dxfg_ipf_collector_t *collector)
 Returns the last modification time of the instrument profiles of the collector in milliseconds.
int32_t dxfg_InstrumentProfileCollector_updateInstrumentProfile (graal_isolatethread_t *thread, dxfg_ipf_collector_t *collector, dxfg_instrument_profile_t *ip)
 Updates one instrument profile in the collector.
int32_t dxfg_InstrumentProfileCollector_updateInstrumentProfiles (graal_isolatethread_t *thread, dxfg_ipf_collector_t *collector, dxfg_instrument_profile_list *ips, dxfg_java_object_handler *generation)
 Updates a list of instrument profiles in the collector and assigns them a generation tag.
int32_t dxfg_InstrumentProfileCollector_removeGenerations (graal_isolatethread_t *thread, dxfg_ipf_collector_t *collector, dxfg_java_object_handler_list *generations)
 Removes the instrument profiles whose generation tags are in a list.
dxfg_iterable_ip_t * dxfg_InstrumentProfileCollector_view (graal_isolatethread_t *thread, dxfg_ipf_collector_t *collector)
 Returns an iterator over the instrument profiles of the collector.
dxfg_executor_t * dxfg_InstrumentProfileCollector_getExecutor (graal_isolatethread_t *thread, dxfg_ipf_collector_t *collector)
 Returns the executor that calls the update listeners of the collector.
int32_t dxfg_InstrumentProfileCollector_setExecutor (graal_isolatethread_t *thread, dxfg_ipf_collector_t *collector, dxfg_executor_t *executor)
 Changes the executor that calls the update listeners of the collector.
int32_t dxfg_InstrumentProfileCollector_addUpdateListener (graal_isolatethread_t *thread, dxfg_ipf_collector_t *collector, dxfg_ipf_update_listener_t *listener)
 Adds a listener that is notified about any updates in the set of the instrument profiles.
int32_t dxfg_InstrumentProfileCollector_removeUpdateListener (graal_isolatethread_t *thread, dxfg_ipf_collector_t *collector, dxfg_ipf_update_listener_t *listener)
 Removes a listener that was added with dxfg_InstrumentProfileCollector_addUpdateListener().
int32_t dxfg_Iterable_InstrumentProfile_hasNext (graal_isolatethread_t *thread, dxfg_iterable_ip_t *iterable_ip)
 Checks whether the iterator has a next instrument profile.
dxfg_instrument_profile_t * dxfg_Iterable_InstrumentProfile_next (graal_isolatethread_t *thread, dxfg_iterable_ip_t *iterable_ip)
 Returns the next instrument profile of the iterator as a handle.
dxfg_ipf_update_listener_t * dxfg_InstrumentProfileUpdateListener_new (graal_isolatethread_t *thread, dxfg_ipf_update_listener_function user_func, void *user_data)
 Creates a listener of the updates of a collector that calls a C function.
dxfg_instrument_profile_reader_t * dxfg_InstrumentProfileReader_new (graal_isolatethread_t *thread)
 Creates an instrument profile reader.
int64_t dxfg_InstrumentProfileReader_getLastModified (graal_isolatethread_t *thread, dxfg_instrument_profile_reader_t *reader)
 Returns the last modification time in milliseconds from the last read from an address, or 0 if it is unknown.
int32_t dxfg_InstrumentProfileReader_wasComplete (graal_isolatethread_t *thread, dxfg_instrument_profile_reader_t *reader)
 Checks whether the instrument profile file was fully read by the last read operation.
dxfg_instrument_profile_list * dxfg_InstrumentProfileReader_readFromFile (graal_isolatethread_t *thread, dxfg_instrument_profile_reader_t *reader, const char *address)
 Reads and returns the instrument profiles from an address.
dxfg_instrument_profile_list * dxfg_InstrumentProfileReader_readFromFile2 (graal_isolatethread_t *thread, dxfg_instrument_profile_reader_t *reader, const char *address, const char *user, const char *password)
 Reads and returns the instrument profiles from an address with basic authentication credentials.
dxfg_instrument_profile_list * dxfg_InstrumentProfileReader_readFromFile3 (graal_isolatethread_t *thread, dxfg_instrument_profile_reader_t *reader, const char *address, dxfg_auth_token_t *token)
 Reads and returns the instrument profiles from an address with token credentials.
const char * dxfg_InstrumentProfileReader_resolveSourceURL (graal_isolatethread_t *thread, const char *address)
 Converts an address specification into the URL that is read by the dxfg_InstrumentProfileReader_readFromFile*() functions.
dxfg_instrument_profile_list * dxfg_InstrumentProfileReader_read2 (graal_isolatethread_t *thread, dxfg_instrument_profile_reader_t *reader, dxfg_input_stream_t *is, const char *address)
 Reads and returns the instrument profiles from an input stream.
dxfg_instrument_profile_list * dxfg_InstrumentProfileReader_readCompressed (graal_isolatethread_t *thread, dxfg_instrument_profile_reader_t *reader, dxfg_input_stream_t *is)
 Reads and returns the instrument profiles from a compressed input stream.
dxfg_instrument_profile_list * dxfg_InstrumentProfileReader_read (graal_isolatethread_t *thread, dxfg_instrument_profile_reader_t *reader, dxfg_input_stream_t *is)
 Reads and returns the instrument profiles from an input stream with plain (not compressed) data.
dxfg_instrument_profile_t * dxfg_InstrumentProfile_new (graal_isolatethread_t *thread)
 Creates an instrument profile with the default values: empty strings and zero numbers.
dxfg_instrument_profile_t * dxfg_InstrumentProfile_new2 (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Creates an instrument profile as a copy of another instrument profile.
const char * dxfg_InstrumentProfile_getType (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the type of the instrument of the instrument profile.
int32_t dxfg_InstrumentProfile_setType (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the type of the instrument of the instrument profile.
const char * dxfg_InstrumentProfile_getSymbol (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the identifier of the instrument of the instrument profile.
int32_t dxfg_InstrumentProfile_setSymbol (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the identifier of the instrument of the instrument profile.
const char * dxfg_InstrumentProfile_getDescription (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the description of the instrument of the instrument profile.
int32_t dxfg_InstrumentProfile_setDescription (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the description of the instrument of the instrument profile.
const char * dxfg_InstrumentProfile_getLocalSymbol (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the identifier of the instrument in the national language of the instrument profile.
int32_t dxfg_InstrumentProfile_setLocalSymbol (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the identifier of the instrument in the national language of the instrument profile.
const char * dxfg_InstrumentProfile_getLocalDescription (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the description of the instrument in the national language of the instrument profile.
int32_t dxfg_InstrumentProfile_setLocalDescription (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the description of the instrument in the national language of the instrument profile.
const char * dxfg_InstrumentProfile_getCountry (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the country of origin (incorporation) of the corresponding company or parent entity of the instrument profile.
int32_t dxfg_InstrumentProfile_setCountry (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the country of origin (incorporation) of the corresponding company or parent entity of the instrument profile.
const char * dxfg_InstrumentProfile_getOPOL (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the official Place Of Listing, the organization that has listed the instrument of the instrument profile.
int32_t dxfg_InstrumentProfile_setOPOL (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the official Place Of Listing, the organization that has listed the instrument of the instrument profile.
const char * dxfg_InstrumentProfile_getExchangeData (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the exchange-specific data required to identify the instrument when communicating with the exchange of the instrument profile.
int32_t dxfg_InstrumentProfile_setExchangeData (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the exchange-specific data required to identify the instrument when communicating with the exchange of the instrument profile.
const char * dxfg_InstrumentProfile_getExchanges (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the list of the exchanges where the instrument is quoted or traded of the instrument profile.
int32_t dxfg_InstrumentProfile_setExchanges (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the list of the exchanges where the instrument is quoted or traded of the instrument profile.
const char * dxfg_InstrumentProfile_getCurrency (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the currency of quotation, pricing and trading of the instrument profile.
int32_t dxfg_InstrumentProfile_setCurrency (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the currency of quotation, pricing and trading of the instrument profile.
const char * dxfg_InstrumentProfile_getBaseCurrency (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the base currency of a currency pair (FOREX instruments) of the instrument profile.
int32_t dxfg_InstrumentProfile_setBaseCurrency (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the base currency of a currency pair (FOREX instruments) of the instrument profile.
const char * dxfg_InstrumentProfile_getCFI (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the Classification of Financial Instruments code of the instrument profile.
int32_t dxfg_InstrumentProfile_setCFI (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the Classification of Financial Instruments code of the instrument profile.
const char * dxfg_InstrumentProfile_getISIN (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the International Securities Identifying Number of the instrument profile.
int32_t dxfg_InstrumentProfile_setISIN (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the International Securities Identifying Number of the instrument profile.
const char * dxfg_InstrumentProfile_getSEDOL (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the Stock Exchange Daily Official List code of the instrument profile.
int32_t dxfg_InstrumentProfile_setSEDOL (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the Stock Exchange Daily Official List code of the instrument profile.
const char * dxfg_InstrumentProfile_getCUSIP (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the Committee on Uniform Security Identification Procedures code of the instrument profile.
int32_t dxfg_InstrumentProfile_setCUSIP (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the Committee on Uniform Security Identification Procedures code of the instrument profile.
int32_t dxfg_InstrumentProfile_getICB (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the Industry Classification Benchmark of the instrument profile.
int32_t dxfg_InstrumentProfile_setICB (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, int32_t value)
 Sets the Industry Classification Benchmark of the instrument profile.
int32_t dxfg_InstrumentProfile_getSIC (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the Standard Industrial Classification of the instrument profile.
int32_t dxfg_InstrumentProfile_setSIC (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, int32_t value)
 Sets the Standard Industrial Classification of the instrument profile.
double dxfg_InstrumentProfile_getMultiplier (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the market value multiplier of the instrument profile.
int32_t dxfg_InstrumentProfile_setMultiplier (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, double value)
 Sets the market value multiplier of the instrument profile.
const char * dxfg_InstrumentProfile_getProduct (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the product for futures and options on futures (the name of the underlying asset) of the instrument profile.
int32_t dxfg_InstrumentProfile_setProduct (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the product for futures and options on futures (the name of the underlying asset) of the instrument profile.
const char * dxfg_InstrumentProfile_getUnderlying (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the primary underlying symbol for options of the instrument profile.
int32_t dxfg_InstrumentProfile_setUnderlying (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the primary underlying symbol for options of the instrument profile.
double dxfg_InstrumentProfile_getSPC (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the shares per contract for options of the instrument profile.
int32_t dxfg_InstrumentProfile_setSPC (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, double value)
 Sets the shares per contract for options of the instrument profile.
const char * dxfg_InstrumentProfile_getAdditionalUnderlyings (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the additional underlyings for options, including additional cash of the instrument profile.
int32_t dxfg_InstrumentProfile_setAdditionalUnderlyings (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the additional underlyings for options, including additional cash of the instrument profile.
const char * dxfg_InstrumentProfile_getMMY (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the maturity month-year as provided for the corresponding FIX tag (200) of the instrument profile.
int32_t dxfg_InstrumentProfile_setMMY (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the maturity month-year as provided for the corresponding FIX tag (200) of the instrument profile.
int32_t dxfg_InstrumentProfile_getExpiration (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the day id of the expiration of the instrument profile.
int32_t dxfg_InstrumentProfile_setExpiration (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, int32_t value)
 Sets the day id of the expiration of the instrument profile.
int32_t dxfg_InstrumentProfile_getLastTrade (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the day id of the last trading day of the instrument profile.
int32_t dxfg_InstrumentProfile_setLastTrade (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, int32_t value)
 Sets the day id of the last trading day of the instrument profile.
double dxfg_InstrumentProfile_getStrike (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the strike price for options of the instrument profile.
int32_t dxfg_InstrumentProfile_setStrike (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, double value)
 Sets the strike price for options of the instrument profile.
const char * dxfg_InstrumentProfile_getOptionType (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the type of the option of the instrument profile.
int32_t dxfg_InstrumentProfile_setOptionType (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the type of the option of the instrument profile.
const char * dxfg_InstrumentProfile_getExpirationStyle (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the expiration cycle style of the instrument profile.
int32_t dxfg_InstrumentProfile_setExpirationStyle (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the expiration cycle style of the instrument profile.
const char * dxfg_InstrumentProfile_getSettlementStyle (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the settlement price determination style of the instrument profile.
int32_t dxfg_InstrumentProfile_setSettlementStyle (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the settlement price determination style of the instrument profile.
const char * dxfg_InstrumentProfile_getPriceIncrements (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the minimum allowed price increments with the corresponding price ranges of the instrument profile.
int32_t dxfg_InstrumentProfile_setPriceIncrements (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the minimum allowed price increments with the corresponding price ranges of the instrument profile.
const char * dxfg_InstrumentProfile_getTradingHours (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the trading hours specification of the instrument profile.
int32_t dxfg_InstrumentProfile_setTradingHours (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *value)
 Sets the trading hours specification of the instrument profile.
const char * dxfg_InstrumentProfile_getField (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *name)
 Returns the value of a field of the instrument profile by the name of the field, in the text form.
int32_t dxfg_InstrumentProfile_setField (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *name, const char *value)
 Sets the value of a field of the instrument profile by the name of the field, in the text form.
double dxfg_InstrumentProfile_getNumericField (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *name)
 Returns the value of a field of the instrument profile by the name of the field, in the numeric form.
int32_t dxfg_InstrumentProfile_setNumericField (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *name, double value)
 Sets the value of a field of the instrument profile by the name of the field, in the numeric form.
int32_t dxfg_InstrumentProfile_getDateField (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *name)
 Returns the day id of a date field of the instrument profile by the name of the field.
int32_t dxfg_InstrumentProfile_setDateField (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip, const char *name, int32_t value)
 Sets the day id of a date field of the instrument profile by the name of the field.
dxfg_string_list * dxfg_InstrumentProfile_getNonEmptyCustomFieldNames (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Returns the names of the non-empty custom fields of the instrument profile.
int32_t dxfg_InstrumentProfile_release (graal_isolatethread_t *thread, dxfg_instrument_profile_t *ip)
 Releases an instrument profile handle.
int32_t dxfg_InstrumentProfileField_formatNumber (graal_isolatethread_t *thread, double number, DXFG_OUT char **result)
 Formats a number to the text form that is used in the instrument profile fields.
int32_t dxfg_InstrumentProfileField_parseNumber (graal_isolatethread_t *thread, const char *string, DXFG_OUT double *number)
 Parses a number from the text form that is used in the instrument profile fields.
int32_t dxfg_InstrumentProfileField_formatDate (graal_isolatethread_t *thread, int32_t date, DXFG_OUT char **result)
 Formats a day id to the text form that is used in the instrument profile fields.
int32_t dxfg_InstrumentProfileField_parseDate (graal_isolatethread_t *thread, const char *string, DXFG_OUT int32_t *date)
 Parses a day id from the text form that is used in the instrument profile fields.
int32_t dxfg_InstrumentProfileCustomFields_new (graal_isolatethread_t *thread, DXFG_OUT dxfg_instrument_profile_custom_fields_t **custom_fields)
 Creates empty custom fields.
int32_t dxfg_InstrumentProfileCustomFields_new2 (graal_isolatethread_t *thread, const char **custom_fields_array, int32_t size, DXFG_OUT dxfg_instrument_profile_custom_fields_t **custom_fields)
 Creates custom fields from an array of strings: the names and the values, consecutive.
int32_t dxfg_InstrumentProfileCustomFields_new3 (graal_isolatethread_t *thread, dxfg_instrument_profile_custom_fields_t *source, DXFG_OUT dxfg_instrument_profile_custom_fields_t **custom_fields)
 Creates custom fields as a copy of other custom fields.
int32_t dxfg_InstrumentProfileCustomFields_new4 (graal_isolatethread_t *thread, const dxfg_string_list *custom_fields_string_list, DXFG_OUT dxfg_instrument_profile_custom_fields_t **custom_fields)
 Creates custom fields from a list of strings: the names and the values, consecutive.
int32_t dxfg_InstrumentProfileCustomFields_getField (graal_isolatethread_t *thread, dxfg_instrument_profile_custom_fields_t *custom_fields, const char *name, DXFG_OUT char **result)
 Returns the value of a custom field by the name.
int32_t dxfg_InstrumentProfileCustomFields_setField (graal_isolatethread_t *thread, dxfg_instrument_profile_custom_fields_t *custom_fields, const char *name, const char *value)
 Sets the value of a custom field by the name.
int32_t dxfg_InstrumentProfileCustomFields_getNumericField (graal_isolatethread_t *thread, dxfg_instrument_profile_custom_fields_t *custom_fields, const char *name, DXFG_OUT double *result)
 Returns the numeric value of a custom field by the name.
int32_t dxfg_InstrumentProfileCustomFields_setNumericField (graal_isolatethread_t *thread, dxfg_instrument_profile_custom_fields_t *custom_fields, const char *name, double value)
 Sets the numeric value of a custom field by the name.
int32_t dxfg_InstrumentProfileCustomFields_getDateField (graal_isolatethread_t *thread, dxfg_instrument_profile_custom_fields_t *custom_fields, const char *name, DXFG_OUT int32_t *result)
 Returns the day id of a date custom field by the name.
int32_t dxfg_InstrumentProfileCustomFields_setDateField (graal_isolatethread_t *thread, dxfg_instrument_profile_custom_fields_t *custom_fields, const char *name, int32_t value)
 Sets the day id of a date custom field by the name.
int32_t dxfg_InstrumentProfileCustomFields_addNonEmptyFieldNames (graal_isolatethread_t *thread, dxfg_instrument_profile_custom_fields_t *custom_fields, DXFG_OUT dxfg_string_list **target_field_names, DXFG_OUT int32_t *updated)
 Returns the names of the non-empty custom fields.
int32_t dxfg_InstrumentProfileCustomFields_getNonEmptyFieldNames (graal_isolatethread_t *thread, dxfg_instrument_profile_custom_fields_t *custom_fields, DXFG_OUT dxfg_string_list **target_field_names)
 Returns the names of the non-empty custom fields.
int32_t dxfg_InstrumentProfileCollector_updateInstrumentProfile2 (graal_isolatethread_t *thread, dxfg_ipf_collector_t *collector, dxfg_instrument_profile2_t *instrument_profile)
 Updates one instrument profile in the collector from a structure.
int32_t dxfg_InstrumentProfileCollector_updateInstrumentProfiles2 (graal_isolatethread_t *thread, dxfg_ipf_collector_t *collector, const dxfg_instrument_profile2_t *instrument_profiles, int32_t size, dxfg_java_object_handler *generation)
 Updates an array of instrument profiles in the collector from structures and assigns them a generation tag.
int32_t dxfg_InstrumentProfileCollector_updateInstrumentProfiles3 (graal_isolatethread_t *thread, dxfg_ipf_collector_t *collector, const dxfg_instrument_profile2_list_t *instrument_profiles, dxfg_java_object_handler *generation)
 Updates a list of instrument profiles in the collector from structures and assigns them a generation tag.
int32_t dxfg_Iterable_InstrumentProfile_next2 (graal_isolatethread_t *thread, dxfg_iterable_ip_t *iterable_ip, DXFG_OUT dxfg_instrument_profile2_t **instrument_profile)
 Returns the next instrument profile of the iterator as a structure.
int32_t dxfg_InstrumentProfileReader_readFromFile4 (graal_isolatethread_t *thread, dxfg_instrument_profile_reader_t *reader, const char *address, DXFG_OUT dxfg_instrument_profile2_t **instrument_profiles, DXFG_OUT int32_t *size)
 Reads and returns the instrument profiles from an address as structures.
int32_t dxfg_InstrumentProfileReader_readFromFile5 (graal_isolatethread_t *thread, dxfg_instrument_profile_reader_t *reader, const char *address, const char *user, const char *password, DXFG_OUT dxfg_instrument_profile2_t **instrument_profiles, DXFG_OUT int32_t *size)
 Reads and returns the instrument profiles from an address with basic authentication credentials as structures.
int32_t dxfg_InstrumentProfileReader_readFromFile6 (graal_isolatethread_t *thread, dxfg_instrument_profile_reader_t *reader, const char *address, dxfg_auth_token_t *token, DXFG_OUT dxfg_instrument_profile2_t **instrument_profiles, DXFG_OUT int32_t *size)
 Reads and returns the instrument profiles from an address with token credentials as structures.
int32_t dxfg_InstrumentProfileReader_readFromFile7 (graal_isolatethread_t *thread, dxfg_instrument_profile_reader_t *reader, const char *address, DXFG_OUT dxfg_instrument_profile2_list_t **instrument_profiles)
 Reads and returns the instrument profiles from an address as structures.
int32_t dxfg_InstrumentProfileReader_readFromFile8 (graal_isolatethread_t *thread, dxfg_instrument_profile_reader_t *reader, const char *address, const char *user, const char *password, DXFG_OUT dxfg_instrument_profile2_list_t **instrument_profiles)
 Reads and returns the instrument profiles from an address with basic authentication credentials as structures.
int32_t dxfg_InstrumentProfileReader_readFromFile9 (graal_isolatethread_t *thread, dxfg_instrument_profile_reader_t *reader, const char *address, dxfg_auth_token_t *token, DXFG_OUT dxfg_instrument_profile2_list_t **instrument_profiles)
 Reads and returns the instrument profiles from an address with token credentials as structures.
int32_t dxfg_InstrumentProfileReader_read3 (graal_isolatethread_t *thread, dxfg_instrument_profile_reader_t *reader, dxfg_input_stream_t *is, DXFG_OUT dxfg_instrument_profile2_t **instrument_profiles, DXFG_OUT int32_t *size)
 Reads and returns the instrument profiles from an input stream with plain (not compressed) data as structures.
int32_t dxfg_InstrumentProfileReader_read4 (graal_isolatethread_t *thread, dxfg_instrument_profile_reader_t *reader, dxfg_input_stream_t *is, const char *address, DXFG_OUT dxfg_instrument_profile2_t **instrument_profiles, DXFG_OUT int32_t *size)
 Reads and returns the instrument profiles from an input stream as structures.
int32_t dxfg_InstrumentProfileReader_read5 (graal_isolatethread_t *thread, dxfg_instrument_profile_reader_t *reader, dxfg_input_stream_t *is, DXFG_OUT dxfg_instrument_profile2_list_t **instrument_profiles)
 Reads and returns the instrument profiles from an input stream with plain (not compressed) data as structures.
int32_t dxfg_InstrumentProfileReader_read6 (graal_isolatethread_t *thread, dxfg_instrument_profile_reader_t *reader, dxfg_input_stream_t *is, const char *address, DXFG_OUT dxfg_instrument_profile2_list_t **instrument_profiles)
 Reads and returns the instrument profiles from an input stream as structures.
int32_t dxfg_InstrumentProfileReader_readCompressed2 (graal_isolatethread_t *thread, dxfg_instrument_profile_reader_t *reader, dxfg_input_stream_t *is, DXFG_OUT dxfg_instrument_profile2_t **instrument_profiles, DXFG_OUT int32_t *size)
 Reads and returns the instrument profiles from a compressed input stream as structures.
int32_t dxfg_InstrumentProfileReader_readCompressed3 (graal_isolatethread_t *thread, dxfg_instrument_profile_reader_t *reader, dxfg_input_stream_t *is, DXFG_OUT dxfg_instrument_profile2_list_t **instrument_profiles)
 Reads and returns the instrument profiles from a compressed input stream as structures.
int32_t dxfg_instrument_profile_free (graal_isolatethread_t *thread, dxfg_instrument_profile2_t *instrument_profile)
 Frees the structure of an instrument profile that the SDK has filled, and releases its custom fields handle.
int32_t dxfg_instrument_profiles_array_free (graal_isolatethread_t *thread, dxfg_instrument_profile2_t *instrument_profiles, int32_t size)
 Frees an array of the structures of instrument profiles that the SDK has filled, with the strings of every structure, and releases their custom fields handles.
int32_t dxfg_instrument_profile2_list_free (graal_isolatethread_t *thread, dxfg_instrument_profile2_list_t *instrument_profiles)
 Frees a list of the structures of instrument profiles that the SDK has filled, with the structures in it, and releases their custom fields handles.

Detailed Description

Instrument profiles: reading of instrument profile files, live connections to an instrument profile source, the collector of the profiles, and the custom fields.

Typedef Documentation

◆ dxfg_instrument_profile2_list_t

typedef struct dxfg_instrument_profile2_list_t dxfg_instrument_profile2_list_t

A list of dxfg_instrument_profile2_t structures.

Release the list and the structures in it with dxfg_instrument_profile2_list_free().

◆ dxfg_instrument_profile2_t

typedef struct dxfg_instrument_profile2_t dxfg_instrument_profile2_t

The fields of an instrument profile in a plain C structure, with the handle of its custom fields.

The strings are UTF-8 null-terminated strings that belong to the structure (an empty string if the field is not set). A structure that the SDK fills is released with dxfg_instrument_profile_free() (a single profile, see dxfg_Iterable_InstrumentProfile_next2()), dxfg_instrument_profiles_array_free() (an array) or dxfg_instrument_profile2_list_free() (a list): that frees the strings and releases the custom fields handle.

A structure that is passed to the SDK, e.g. to dxfg_InstrumentProfileCollector_updateInstrumentProfile2(), is only read: the SDK copies the strings, does not keep or free the pointers, treats a NULL string as an empty one and ignores instrument_profile_custom_fields_hash.

The custom fields are not copied: the Java instrument profile and the custom fields handle of the structure start with the same storage of the fields, both in a structure that the SDK fills and in a structure passed to the SDK (the profile gets the storage the handle has at the call). The sharing lasts only while the storage has room: a change made with dxfg_InstrumentProfileCustomFields_setField() and the like through that handle may change the profile (e.g. the profile in a collector), but a change that adds a field may move the fields of the handle to a new, larger storage, and from then on the profile no longer sees the changes of the handle, nor the handle those of the profile. So do not rely on the sharing in either direction: to change the custom fields of a profile, pass the structure to the SDK again, and to change them independently, make a copy with dxfg_InstrumentProfileCustomFields_new3() first.

Every field is described with the corresponding dxfg_InstrumentProfile_get*() function.

◆ dxfg_instrument_profile_custom_fields_t

typedef struct dxfg_instrument_profile_custom_fields_t dxfg_instrument_profile_custom_fields_t

A handle of a Java InstrumentProfileCustomFields object; release it with dxfg_JavaObjectHandler_release().

The custom fields are the fields of an instrument profile that are not standard fields, as the name-value pairs of the text values. InstrumentProfileCustomFields is a class of the SDK, it does not belong to the dxFeed API. Use dxfg_JavaObjectHandler_clone() to extend the life of the handle (to clone the object reference).

◆ dxfg_instrument_profile_list

typedef struct dxfg_instrument_profile_list dxfg_instrument_profile_list

A list of instrument profile handles.

Release the list and all the profile handles in it with dxfg_CList_InstrumentProfile_release(), or only the list with dxfg_CList_InstrumentProfile_wrapper_release().

◆ dxfg_instrument_profile_reader_t

typedef struct dxfg_instrument_profile_reader_t dxfg_instrument_profile_reader_t

A handle of a Java InstrumentProfileReader object; release it with dxfg_JavaObjectHandler_release().

Create it with dxfg_InstrumentProfileReader_new().

Javadoc

◆ dxfg_instrument_profile_t

typedef struct dxfg_instrument_profile_t dxfg_instrument_profile_t

A handle of a Java InstrumentProfile object; release it with dxfg_JavaObjectHandler_release().

dxfg_InstrumentProfile_release() releases the handle as well. Create a profile with dxfg_InstrumentProfile_new(). A profile that is stored in a collector is the object itself, not a copy: do not modify it.

Javadoc

◆ dxfg_ipf_collector_t

typedef struct dxfg_ipf_collector_t dxfg_ipf_collector_t

A handle of a Java InstrumentProfileCollector object; release it with dxfg_JavaObjectHandler_release().

Create it with dxfg_InstrumentProfileCollector_new().

Javadoc

◆ dxfg_ipf_connection_state_change_listener_func

typedef void(*) dxfg_ipf_connection_state_change_listener_func(graal_isolatethread_t *thread, dxfg_ipf_connection_state_t old_state, dxfg_ipf_connection_state_t new_state, void *user_data)

The function of a dxfg_ipf_connection_state_change_listener_t: called when the state of the connection changes.

The function is called by the Java thread that changes the state, not by the thread that added the listener: CONNECTING and CLOSED by the thread that called dxfg_InstrumentProfileConnection_start() and dxfg_InstrumentProfileConnection_close() respectively, CONNECTED and COMPLETED by the background thread of the connection. The states are passed by value, there is nothing to release.

Java: PropertyChangeListener.propertyChange(PropertyChangeEvent).

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]old_stateThe previous state of the connection.
[in]new_stateThe new state of the connection.
[in]user_dataThe pointer that was passed to dxfg_IpfPropertyChangeListener_new(); the SDK does not use it.

◆ dxfg_ipf_connection_state_change_listener_t

typedef struct dxfg_ipf_connection_state_change_listener_t dxfg_ipf_connection_state_change_listener_t

A handle of a Java PropertyChangeListener object; release it with dxfg_JavaObjectHandler_release().

The listener calls a dxfg_ipf_connection_state_change_listener_func when the state of an instrument profile connection changes. Create it with dxfg_IpfPropertyChangeListener_new(). The last handle of the listener that is released deactivates the listener: its function is not called anymore.

Javadoc

◆ dxfg_ipf_connection_state_t

The state of an instrument profile connection.

Java: InstrumentProfileConnection.State. The state changes from NOT_CONNECTED to CONNECTING, CONNECTED and COMPLETED; CLOSED can follow any state.

Javadoc

◆ dxfg_ipf_connection_t

typedef struct dxfg_ipf_connection_t dxfg_ipf_connection_t

A handle of a Java InstrumentProfileConnection object; release it with dxfg_JavaObjectHandler_release().

Create it with dxfg_InstrumentProfileConnection_createConnection(). Releasing the handle does not close the connection: call dxfg_InstrumentProfileConnection_close().

Javadoc

◆ dxfg_ipf_update_listener_function

typedef void(*) dxfg_ipf_update_listener_function(graal_isolatethread_t *thread, dxfg_iterable_ip_t *profiles, void *user_data)

The function of a dxfg_ipf_update_listener_t: called when the set of the instrument profiles of the collector changes.

The function is called by the executor of the collector (a single-threaded executor by default, see dxfg_InstrumentProfileCollector_setExecutor()), not by the thread that added the listener. A listener that is added to a collector that is not empty is called for the existing profiles as well. A removed instrument profile is passed as a profile whose type is REMOVED.

The SDK releases the passed iterator right after the function returns: the callee must not release it and must not use it after the return. The profiles that the callee gets from it with dxfg_Iterable_InstrumentProfile_next() belong to the callee and are released with dxfg_JavaObjectHandler_release(); the structures that dxfg_Iterable_InstrumentProfile_next2() returns belong to the callee too and are released with dxfg_instrument_profile_free().

Java: InstrumentProfileUpdateListener.instrumentProfilesUpdated(Iterator).

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]profilesThe iterator over the changed instrument profiles. It belongs to the SDK and is valid during the call only.
[in]user_dataThe pointer that was passed to dxfg_InstrumentProfileUpdateListener_new(); the SDK does not use it.

◆ dxfg_ipf_update_listener_t

typedef struct dxfg_ipf_update_listener_t dxfg_ipf_update_listener_t

A handle of a Java InstrumentProfileUpdateListener object; release it with dxfg_JavaObjectHandler_release().

The listener calls a dxfg_ipf_update_listener_function when the set of the instrument profiles of a collector changes. Create it with dxfg_InstrumentProfileUpdateListener_new(). The last handle of the listener that is released deactivates the listener: its function is not called anymore.

Javadoc

◆ dxfg_iterable_ip_t

typedef struct dxfg_iterable_ip_t dxfg_iterable_ip_t

Enumeration Type Documentation

◆ dxfg_ipf_connection_state_t

The state of an instrument profile connection.

Java: InstrumentProfileConnection.State. The state changes from NOT_CONNECTED to CONNECTING, CONNECTED and COMPLETED; CLOSED can follow any state.

Javadoc

Enumerator
DXFG_IPF_CONNECTION_STATE_NOT_CONNECTED 

The connection is not started yet: dxfg_InstrumentProfileConnection_start() was not called.

DXFG_IPF_CONNECTION_STATE_CONNECTING 

The connection is being established.

DXFG_IPF_CONNECTION_STATE_CONNECTED 

The connection was established.

DXFG_IPF_CONNECTION_STATE_COMPLETED 

The initial snapshot of the instrument profiles was fully read (this state is set only once).

DXFG_IPF_CONNECTION_STATE_CLOSED 

The connection was closed by dxfg_InstrumentProfileConnection_close().

Function Documentation

◆ dxfg_CList_InstrumentProfile_release()

int32_t dxfg_CList_InstrumentProfile_release ( graal_isolatethread_t * thread,
dxfg_instrument_profile_list * ips )

Releases the list and all the instrument profile handles in it.

Deprecated
Use dxfg_v4_instrument_profile_list_release().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipsThe list of the instrument profile handles.
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_CList_InstrumentProfile_wrapper_release()

int32_t dxfg_CList_InstrumentProfile_wrapper_release ( graal_isolatethread_t * thread,
dxfg_instrument_profile_list * ips )

Releases the list structure only and keeps the instrument profile handles in it.

The array of the elements and the dxfg_instrument_profile_list structure are freed. The profile handles stay valid: release each of them with dxfg_JavaObjectHandler_release().

Deprecated
Use dxfg_v4_instrument_profile_list_wrapper_release().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipsThe list of the instrument profile handles.
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_instrument_profile2_list_free()

int32_t dxfg_instrument_profile2_list_free ( graal_isolatethread_t * thread,
dxfg_instrument_profile2_list_t * instrument_profiles )

Frees a list of the structures of instrument profiles that the SDK has filled, with the structures in it, and releases their custom fields handles.

Deprecated
Use dxfg_v4_instrument_profile_data_list_release().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]instrument_profilesThe list of the structures.
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_instrument_profile_free()

int32_t dxfg_instrument_profile_free ( graal_isolatethread_t * thread,
dxfg_instrument_profile2_t * instrument_profile )

Frees the structure of an instrument profile that the SDK has filled, and releases its custom fields handle.

The structure itself is freed as well: use it for a structure that was returned by dxfg_Iterable_InstrumentProfile_next2(), not for an element of an array or a list.

Deprecated
Use dxfg_v4_instrument_profile_data_release().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]instrument_profileThe structure of the instrument profile; NULL does nothing.
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_instrument_profiles_array_free()

int32_t dxfg_instrument_profiles_array_free ( graal_isolatethread_t * thread,
dxfg_instrument_profile2_t * instrument_profiles,
int32_t size )

Frees an array of the structures of instrument profiles that the SDK has filled, with the strings of every structure, and releases their custom fields handles.

Deprecated
Use dxfg_v4_instrument_profile_data_list_release().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]instrument_profilesThe array of the structures; NULL does nothing.
[in]sizeThe number of the structures in the array.
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_InstrumentProfile_getAdditionalUnderlyings()

const char * dxfg_InstrumentProfile_getAdditionalUnderlyings ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the additional underlyings for options, including additional cash of the instrument profile.

The format is a list of <UNDERLYING> <SPC> items separated by ; and sorted by underlying. Examples: SE 50, FIS 53; US$ 45.46.

Java: InstrumentProfile.getAdditionalUnderlyings().

Deprecated
Use dxfg_v4_InstrumentProfile_getAdditionalUnderlyings().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The additional underlyings (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getBaseCurrency()

const char * dxfg_InstrumentProfile_getBaseCurrency ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the base currency of a currency pair (FOREX instruments) of the instrument profile.

It uses the three-letter currency code like the currency.

Java: InstrumentProfile.getBaseCurrency().

Deprecated
Use dxfg_v4_InstrumentProfile_getBaseCurrency().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The base currency (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getCFI()

const char * dxfg_InstrumentProfile_getCFI ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the Classification of Financial Instruments code of the instrument profile.

It is a mandatory field for OPTION instruments: it is the only way to distinguish Call/Put, American/European exercise and Cash/Physical delivery. It uses the six-letter code of ISO 10962; X can be used extensively and trailing letters can be omitted (they are assumed to be X). Examples: ESNTPB, ESXXXX, ES, OPASPS.

Java: InstrumentProfile.getCFI().

Deprecated
Use dxfg_v4_InstrumentProfile_getCFI().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The CFI (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getCountry()

const char * dxfg_InstrumentProfile_getCountry ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the country of origin (incorporation) of the corresponding company or parent entity of the instrument profile.

It uses the two-letter country code of ISO 3166-1. Examples: US, RU.

Java: InstrumentProfile.getCountry().

Deprecated
Use dxfg_v4_InstrumentProfile_getCountry().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The country (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getCurrency()

const char * dxfg_InstrumentProfile_getCurrency ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the currency of quotation, pricing and trading of the instrument profile.

It uses the three-letter currency code of ISO 4217. Examples: USD, RUB.

Java: InstrumentProfile.getCurrency().

Deprecated
Use dxfg_v4_InstrumentProfile_getCurrency().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The currency (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getCUSIP()

const char * dxfg_InstrumentProfile_getCUSIP ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the Committee on Uniform Security Identification Procedures code of the instrument profile.

It uses the nine-letter code assigned by the CUSIP Services Bureau. Example: 38259P508.

Java: InstrumentProfile.getCUSIP().

Deprecated
Use dxfg_v4_InstrumentProfile_getCUSIP().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The CUSIP (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getDateField()

int32_t dxfg_InstrumentProfile_getDateField ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * name )

Returns the day id of a date field of the instrument profile by the name of the field.

The day id is the number of days since January 1, 1970, 00:00:00 GMT. A custom field that is not set gives 0.

Java: InstrumentProfile.getDateField(String).

Deprecated
Use dxfg_v4_InstrumentProfile_getDateField().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]nameThe name of the field, a UTF-8 string.
Returns
The day id (the number of days since January 1, 1970, 00:00:00 GMT; 0 if it is not set), or -1 on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown.

◆ dxfg_InstrumentProfile_getDescription()

const char * dxfg_InstrumentProfile_getDescription ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the description of the instrument of the instrument profile.

It is preferably an international one in the Latin alphabet. Examples: Google Inc., Mini Gold Futures,Jun-2009,ETH.

Java: InstrumentProfile.getDescription().

Deprecated
Use dxfg_v4_InstrumentProfile_getDescription().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The description (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getExchangeData()

const char * dxfg_InstrumentProfile_getExchangeData ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the exchange-specific data required to identify the instrument when communicating with the exchange of the instrument profile.

It uses an exchange-specific format.

Java: InstrumentProfile.getExchangeData().

Deprecated
Use dxfg_v4_InstrumentProfile_getExchangeData().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The exchange data (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getExchanges()

const char * dxfg_InstrumentProfile_getExchanges ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the list of the exchanges where the instrument is quoted or traded of the instrument profile.

The list is a sequence of MICs separated by semicolons and sorted by MIC. Example: ARCX;CBSX;XNAS;XNYS.

Java: InstrumentProfile.getExchanges().

Deprecated
Use dxfg_v4_InstrumentProfile_getExchanges().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The exchanges (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getExpiration()

int32_t dxfg_InstrumentProfile_getExpiration ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the day id of the expiration of the instrument profile.

The day id is the number of days since January 1, 1970, 00:00:00 GMT; 0 if it is not set.

Java: InstrumentProfile.getExpiration().

Deprecated
Use dxfg_v4_InstrumentProfile_getExpiration().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The day id of the expiration (the number of days since January 1, 1970, 00:00:00 GMT; 0 if it is not set), or -1 on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown.

◆ dxfg_InstrumentProfile_getExpirationStyle()

const char * dxfg_InstrumentProfile_getExpirationStyle ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the expiration cycle style of the instrument profile.

Examples: Weeklys, Quarterlys.

Java: InstrumentProfile.getExpirationStyle().

Deprecated
Use dxfg_v4_InstrumentProfile_getExpirationStyle().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The expiration style (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getField()

const char * dxfg_InstrumentProfile_getField ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * name )

Returns the value of a field of the instrument profile by the name of the field, in the text form.

The field is a standard field of the profile (TYPE, SYMBOL, DESCRIPTION, LOCAL_SYMBOL, LOCAL_DESCRIPTION, COUNTRY, OPOL, EXCHANGE_DATA, EXCHANGES, CURRENCY, BASE_CURRENCY, CFI, ISIN, SEDOL, CUSIP, ICB, SIC, MULTIPLIER, PRODUCT, UNDERLYING, SPC, ADDITIONAL_UNDERLYINGS, MMY, EXPIRATION, LAST_TRADE, STRIKE, OPTION_TYPE, EXPIRATION_STYLE, SETTLEMENT_STYLE, PRICE_INCREMENTS, TRADING_HOURS) or, for any other name, a custom field. The numeric fields are formatted like dxfg_InstrumentProfileField_formatNumber() does, the date fields like dxfg_InstrumentProfileField_formatDate() does (a zero value is an empty string).

Java: InstrumentProfile.getField(String).

Deprecated
Use dxfg_v4_InstrumentProfile_getField().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]nameThe name of the field, a UTF-8 string; the standard field names are case sensitive.
Returns
The value (a UTF-8 string, empty if a custom field is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getICB()

int32_t dxfg_InstrumentProfile_getICB ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the Industry Classification Benchmark of the instrument profile.

It uses a four-digit number from the ICB catalog. Example: 9535.

Java: InstrumentProfile.getICB().

Deprecated
Use dxfg_v4_InstrumentProfile_getICB().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The ICB number, or -1 on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown.

◆ dxfg_InstrumentProfile_getISIN()

const char * dxfg_InstrumentProfile_getISIN ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the International Securities Identifying Number of the instrument profile.

It uses the twelve-letter code of ISO 6166. Examples: DE0007100000, US38259P5089.

Java: InstrumentProfile.getISIN().

Deprecated
Use dxfg_v4_InstrumentProfile_getISIN().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The ISIN (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getLastTrade()

int32_t dxfg_InstrumentProfile_getLastTrade ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the day id of the last trading day of the instrument profile.

The day id is the number of days since January 1, 1970, 00:00:00 GMT; 0 if it is not set.

Java: InstrumentProfile.getLastTrade().

Deprecated
Use dxfg_v4_InstrumentProfile_getLastTrade().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The day id of the last trading day (the number of days since January 1, 1970, 00:00:00 GMT; 0 if it is not set), or -1 on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown.

◆ dxfg_InstrumentProfile_getLocalDescription()

const char * dxfg_InstrumentProfile_getLocalDescription ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the description of the instrument in the national language of the instrument profile.

It is empty if it is the same as the description.

Java: InstrumentProfile.getLocalDescription().

Deprecated
Use dxfg_v4_InstrumentProfile_getLocalDescription().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The local description (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getLocalSymbol()

const char * dxfg_InstrumentProfile_getLocalSymbol ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the identifier of the instrument in the national language of the instrument profile.

It is empty if it is the same as the symbol.

Java: InstrumentProfile.getLocalSymbol().

Deprecated
Use dxfg_v4_InstrumentProfile_getLocalSymbol().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The local symbol (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getMMY()

const char * dxfg_InstrumentProfile_getMMY ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the maturity month-year as provided for the corresponding FIX tag (200) of the instrument profile.

Depending on the data source it uses YYYYMM (year and month), YYYYMMDD (full date) or YYYYMMwN (week number within the month).

Java: InstrumentProfile.getMMY().

Deprecated
Use dxfg_v4_InstrumentProfile_getMMY().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The MMY (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getMultiplier()

double dxfg_InstrumentProfile_getMultiplier ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the market value multiplier of the instrument profile.

Examples: 100, 33.2.

Java: InstrumentProfile.getMultiplier().

Deprecated
Use dxfg_v4_InstrumentProfile_getMultiplier().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The multiplier, or negative infinity on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown.

◆ dxfg_InstrumentProfile_getNonEmptyCustomFieldNames()

dxfg_string_list * dxfg_InstrumentProfile_getNonEmptyCustomFieldNames ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the names of the non-empty custom fields of the instrument profile.

Java: InstrumentProfile.addNonEmptyCustomFieldNames(Collection).

Deprecated
Use dxfg_v4_InstrumentProfile_getNonEmptyCustomFieldNames().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The list of the names (release it with dxfg_CList_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getNumericField()

double dxfg_InstrumentProfile_getNumericField ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * name )

Returns the value of a field of the instrument profile by the name of the field, in the numeric form.

The standard numeric fields are ICB, SIC, MULTIPLIER, SPC, EXPIRATION, LAST_TRADE and STRIKE; the function fails for the other standard fields. A custom field that is not set gives 0, a custom field whose text looks like a date (yyyy-MM-dd) gives the day id, any other text is parsed as a number.

Java: InstrumentProfile.getNumericField(String).

Deprecated
Use dxfg_v4_InstrumentProfile_getNumericField().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]nameThe name of the field, a UTF-8 string.
Returns
The value, or negative infinity on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown.

◆ dxfg_InstrumentProfile_getOPOL()

const char * dxfg_InstrumentProfile_getOPOL ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the official Place Of Listing, the organization that has listed the instrument of the instrument profile.

An instrument with multiple listings uses a separate profile for each listing. It uses the Market Identifier Code (MIC) of ISO 10383. Examples: XNAS, RTSX.

Java: InstrumentProfile.getOPOL().

Deprecated
Use dxfg_v4_InstrumentProfile_getOPOL().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The OPOL (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getOptionType()

const char * dxfg_InstrumentProfile_getOptionType ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the type of the option of the instrument profile.

It is one of STAN (Standard Options), LEAP (Long-term Equity AnticiPation Securities), SDO (Special Dated Options), BINY (Binary Options), FLEX (FLexible EXchange Options), VSO (Variable Start Options), RNGE (Range).

Java: InstrumentProfile.getOptionType().

Deprecated
Use dxfg_v4_InstrumentProfile_getOptionType().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The option type (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getPriceIncrements()

const char * dxfg_InstrumentProfile_getPriceIncrements ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the minimum allowed price increments with the corresponding price ranges of the instrument profile.

The format is an increment, or a list of <INCREMENT> <UPPER_LIMIT> ranges separated by ; and sorted by upper limit. Examples: 0.25, 0.01 3; 0.05.

Java: InstrumentProfile.getPriceIncrements().

Deprecated
Use dxfg_v4_InstrumentProfile_getPriceIncrements().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The price increments (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getProduct()

const char * dxfg_InstrumentProfile_getProduct ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the product for futures and options on futures (the name of the underlying asset) of the instrument profile.

Example: /YG.

Java: InstrumentProfile.getProduct().

Deprecated
Use dxfg_v4_InstrumentProfile_getProduct().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The product (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getSEDOL()

const char * dxfg_InstrumentProfile_getSEDOL ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the Stock Exchange Daily Official List code of the instrument profile.

It uses the seven-letter code assigned by the London Stock Exchange. Examples: 2310967, 5766857.

Java: InstrumentProfile.getSEDOL().

Deprecated
Use dxfg_v4_InstrumentProfile_getSEDOL().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The SEDOL (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getSettlementStyle()

const char * dxfg_InstrumentProfile_getSettlementStyle ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the settlement price determination style of the instrument profile.

Examples: Open, Close.

Java: InstrumentProfile.getSettlementStyle().

Deprecated
Use dxfg_v4_InstrumentProfile_getSettlementStyle().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The settlement style (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getSIC()

int32_t dxfg_InstrumentProfile_getSIC ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the Standard Industrial Classification of the instrument profile.

It uses a four-digit number from the SIC catalog. Example: 7371.

Java: InstrumentProfile.getSIC().

Deprecated
Use dxfg_v4_InstrumentProfile_getSIC().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The SIC number, or -1 on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown.

◆ dxfg_InstrumentProfile_getSPC()

double dxfg_InstrumentProfile_getSPC ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the shares per contract for options of the instrument profile.

Examples: 1, 100.

Java: InstrumentProfile.getSPC().

Deprecated
Use dxfg_v4_InstrumentProfile_getSPC().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The SPC, or negative infinity on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown.

◆ dxfg_InstrumentProfile_getStrike()

double dxfg_InstrumentProfile_getStrike ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the strike price for options of the instrument profile.

Examples: 80, 22.5.

Java: InstrumentProfile.getStrike().

Deprecated
Use dxfg_v4_InstrumentProfile_getStrike().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The strike, or negative infinity on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown.

◆ dxfg_InstrumentProfile_getSymbol()

const char * dxfg_InstrumentProfile_getSymbol ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the identifier of the instrument of the instrument profile.

It is preferably an international one in the Latin alphabet. It is a mandatory field and must not be empty. Examples: GOOG, /YGM9, .ZYEAD.

Java: InstrumentProfile.getSymbol().

Deprecated
Use dxfg_v4_InstrumentProfile_getSymbol().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The symbol (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getTradingHours()

const char * dxfg_InstrumentProfile_getTradingHours ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the trading hours specification of the instrument profile.

The format is the one of Schedule.getInstance(String) of the dxFeed API.

Java: InstrumentProfile.getTradingHours().

Deprecated
Use dxfg_v4_InstrumentProfile_getTradingHours().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The trading hours (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getType()

const char * dxfg_InstrumentProfile_getType ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the type of the instrument of the instrument profile.

It takes precedence over the other fields in conflict cases. It is a mandatory field and must not be empty. Examples: STOCK, FUTURE, OPTION.

Java: InstrumentProfile.getType().

Deprecated
Use dxfg_v4_InstrumentProfile_getType().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The type (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_getUnderlying()

const char * dxfg_InstrumentProfile_getUnderlying ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Returns the primary underlying symbol for options of the instrument profile.

Examples: C, /YGM9.

Java: InstrumentProfile.getUnderlying().

Deprecated
Use dxfg_v4_InstrumentProfile_getUnderlying().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
Returns
The underlying (a UTF-8 string, empty if it is not set; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_new()

dxfg_instrument_profile_t * dxfg_InstrumentProfile_new ( graal_isolatethread_t * thread)

Creates an instrument profile with the default values: empty strings and zero numbers.

Java: new InstrumentProfile.

Deprecated
Use dxfg_v4_InstrumentProfile_new().
Parameters
[in]threadThe current GraalVM Isolate's thread.
Returns
The instrument profile (release it with dxfg_JavaObjectHandler_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_new2()

dxfg_instrument_profile_t * dxfg_InstrumentProfile_new2 ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Creates an instrument profile as a copy of another instrument profile.

Java: new InstrumentProfile.

Deprecated
Use dxfg_v4_InstrumentProfile_newCopy().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe handle of the instrument profile to copy.
Returns
The instrument profile (release it with dxfg_JavaObjectHandler_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfile_release()

int32_t dxfg_InstrumentProfile_release ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip )

Releases an instrument profile handle.

It is the same as dxfg_JavaObjectHandler_release() for the handle.

Deprecated
Use dxfg_v4_InstrumentProfile_release().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
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_InstrumentProfile_setAdditionalUnderlyings()

int32_t dxfg_InstrumentProfile_setAdditionalUnderlyings ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the additional underlyings for options, including additional cash of the instrument profile.

The format is a list of <UNDERLYING> <SPC> items separated by ; and sorted by underlying. Examples: SE 50, FIS 53; US$ 45.46.

Java: InstrumentProfile.setAdditionalUnderlyings(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setAdditionalUnderlyings().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe additional underlyings, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setBaseCurrency()

int32_t dxfg_InstrumentProfile_setBaseCurrency ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the base currency of a currency pair (FOREX instruments) of the instrument profile.

It uses the three-letter currency code like the currency.

Java: InstrumentProfile.setBaseCurrency(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setBaseCurrency().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe base currency, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setCFI()

int32_t dxfg_InstrumentProfile_setCFI ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the Classification of Financial Instruments code of the instrument profile.

It is a mandatory field for OPTION instruments: it is the only way to distinguish Call/Put, American/European exercise and Cash/Physical delivery. It uses the six-letter code of ISO 10962; X can be used extensively and trailing letters can be omitted (they are assumed to be X). Examples: ESNTPB, ESXXXX, ES, OPASPS.

Java: InstrumentProfile.setCFI(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setCFI().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe CFI, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setCountry()

int32_t dxfg_InstrumentProfile_setCountry ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the country of origin (incorporation) of the corresponding company or parent entity of the instrument profile.

It uses the two-letter country code of ISO 3166-1. Examples: US, RU.

Java: InstrumentProfile.setCountry(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setCountry().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe country, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setCurrency()

int32_t dxfg_InstrumentProfile_setCurrency ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the currency of quotation, pricing and trading of the instrument profile.

It uses the three-letter currency code of ISO 4217. Examples: USD, RUB.

Java: InstrumentProfile.setCurrency(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setCurrency().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe currency, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setCUSIP()

int32_t dxfg_InstrumentProfile_setCUSIP ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the Committee on Uniform Security Identification Procedures code of the instrument profile.

It uses the nine-letter code assigned by the CUSIP Services Bureau. Example: 38259P508.

Java: InstrumentProfile.setCUSIP(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setCUSIP().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe CUSIP, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setDateField()

int32_t dxfg_InstrumentProfile_setDateField ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * name,
int32_t value )

Sets the day id of a date field of the instrument profile by the name of the field.

The day id is the number of days since January 1, 1970, 00:00:00 GMT. A custom field is stored as the text yyyy-MM-dd (an empty string for 0).

Java: InstrumentProfile.setDateField(String, int).

Deprecated
Use dxfg_v4_InstrumentProfile_setDateField().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]nameThe name of the field, a UTF-8 string.
[in]valueThe day id (the number of days since January 1, 1970, 00:00:00 GMT).
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_InstrumentProfile_setDescription()

int32_t dxfg_InstrumentProfile_setDescription ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the description of the instrument of the instrument profile.

It is preferably an international one in the Latin alphabet. Examples: Google Inc., Mini Gold Futures,Jun-2009,ETH.

Java: InstrumentProfile.setDescription(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setDescription().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe description, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setExchangeData()

int32_t dxfg_InstrumentProfile_setExchangeData ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the exchange-specific data required to identify the instrument when communicating with the exchange of the instrument profile.

It uses an exchange-specific format.

Java: InstrumentProfile.setExchangeData(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setExchangeData().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe exchange data, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setExchanges()

int32_t dxfg_InstrumentProfile_setExchanges ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the list of the exchanges where the instrument is quoted or traded of the instrument profile.

The list is a sequence of MICs separated by semicolons and sorted by MIC. Example: ARCX;CBSX;XNAS;XNYS.

Java: InstrumentProfile.setExchanges(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setExchanges().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe exchanges, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setExpiration()

int32_t dxfg_InstrumentProfile_setExpiration ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
int32_t value )

Sets the day id of the expiration of the instrument profile.

The day id is the number of days since January 1, 1970, 00:00:00 GMT; 0 if it is not set.

Java: InstrumentProfile.setExpiration(int).

Deprecated
Use dxfg_v4_InstrumentProfile_setExpiration().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe expiration.
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_InstrumentProfile_setExpirationStyle()

int32_t dxfg_InstrumentProfile_setExpirationStyle ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the expiration cycle style of the instrument profile.

Examples: Weeklys, Quarterlys.

Java: InstrumentProfile.setExpirationStyle(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setExpirationStyle().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe expiration style, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setField()

int32_t dxfg_InstrumentProfile_setField ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * name,
const char * value )

Sets the value of a field of the instrument profile by the name of the field, in the text form.

The field is a standard field of the profile (TYPE, SYMBOL, DESCRIPTION, LOCAL_SYMBOL, LOCAL_DESCRIPTION, COUNTRY, OPOL, EXCHANGE_DATA, EXCHANGES, CURRENCY, BASE_CURRENCY, CFI, ISIN, SEDOL, CUSIP, ICB, SIC, MULTIPLIER, PRODUCT, UNDERLYING, SPC, ADDITIONAL_UNDERLYINGS, MMY, EXPIRATION, LAST_TRADE, STRIKE, OPTION_TYPE, EXPIRATION_STYLE, SETTLEMENT_STYLE, PRICE_INCREMENTS, TRADING_HOURS) or, for any other name, a custom field. The text of a numeric or a date field is parsed like dxfg_InstrumentProfileField_parseNumber() and dxfg_InstrumentProfileField_parseDate() do; the function fails if the text has a wrong format.

Java: InstrumentProfile.setField(String, String).

Deprecated
Use dxfg_v4_InstrumentProfile_setField().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]nameThe name of the field, a UTF-8 string; the standard field names are case sensitive.
[in]valueThe value, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setICB()

int32_t dxfg_InstrumentProfile_setICB ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
int32_t value )

Sets the Industry Classification Benchmark of the instrument profile.

It uses a four-digit number from the ICB catalog. Example: 9535.

Java: InstrumentProfile.setICB(int).

Deprecated
Use dxfg_v4_InstrumentProfile_setICB().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe ICB.
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_InstrumentProfile_setISIN()

int32_t dxfg_InstrumentProfile_setISIN ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the International Securities Identifying Number of the instrument profile.

It uses the twelve-letter code of ISO 6166. Examples: DE0007100000, US38259P5089.

Java: InstrumentProfile.setISIN(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setISIN().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe ISIN, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setLastTrade()

int32_t dxfg_InstrumentProfile_setLastTrade ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
int32_t value )

Sets the day id of the last trading day of the instrument profile.

The day id is the number of days since January 1, 1970, 00:00:00 GMT; 0 if it is not set.

Java: InstrumentProfile.setLastTrade(int).

Deprecated
Use dxfg_v4_InstrumentProfile_setLastTrade().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe last trade.
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_InstrumentProfile_setLocalDescription()

int32_t dxfg_InstrumentProfile_setLocalDescription ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the description of the instrument in the national language of the instrument profile.

It is empty if it is the same as the description.

Java: InstrumentProfile.setLocalDescription(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setLocalDescription().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe local description, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setLocalSymbol()

int32_t dxfg_InstrumentProfile_setLocalSymbol ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the identifier of the instrument in the national language of the instrument profile.

It is empty if it is the same as the symbol.

Java: InstrumentProfile.setLocalSymbol(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setLocalSymbol().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe local symbol, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setMMY()

int32_t dxfg_InstrumentProfile_setMMY ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the maturity month-year as provided for the corresponding FIX tag (200) of the instrument profile.

Depending on the data source it uses YYYYMM (year and month), YYYYMMDD (full date) or YYYYMMwN (week number within the month).

Java: InstrumentProfile.setMMY(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setMMY().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe MMY, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setMultiplier()

int32_t dxfg_InstrumentProfile_setMultiplier ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
double value )

Sets the market value multiplier of the instrument profile.

Examples: 100, 33.2.

Java: InstrumentProfile.setMultiplier(double).

Deprecated
Use dxfg_v4_InstrumentProfile_setMultiplier().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe multiplier.
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_InstrumentProfile_setNumericField()

int32_t dxfg_InstrumentProfile_setNumericField ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * name,
double value )

Sets the value of a field of the instrument profile by the name of the field, in the numeric form.

The function fails for the standard fields that are not numeric (see dxfg_InstrumentProfile_getNumericField()). A custom field is stored as the text of the number.

Java: InstrumentProfile.setNumericField(String, double).

Deprecated
Use dxfg_v4_InstrumentProfile_setNumericField().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]nameThe name of the field, a UTF-8 string.
[in]valueThe value.
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_InstrumentProfile_setOPOL()

int32_t dxfg_InstrumentProfile_setOPOL ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the official Place Of Listing, the organization that has listed the instrument of the instrument profile.

An instrument with multiple listings uses a separate profile for each listing. It uses the Market Identifier Code (MIC) of ISO 10383. Examples: XNAS, RTSX.

Java: InstrumentProfile.setOPOL(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setOPOL().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe OPOL, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setOptionType()

int32_t dxfg_InstrumentProfile_setOptionType ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the type of the option of the instrument profile.

It is one of STAN (Standard Options), LEAP (Long-term Equity AnticiPation Securities), SDO (Special Dated Options), BINY (Binary Options), FLEX (FLexible EXchange Options), VSO (Variable Start Options), RNGE (Range).

Java: InstrumentProfile.setOptionType(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setOptionType().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe option type, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setPriceIncrements()

int32_t dxfg_InstrumentProfile_setPriceIncrements ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the minimum allowed price increments with the corresponding price ranges of the instrument profile.

The format is an increment, or a list of <INCREMENT> <UPPER_LIMIT> ranges separated by ; and sorted by upper limit. Examples: 0.25, 0.01 3; 0.05.

Java: InstrumentProfile.setPriceIncrements(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setPriceIncrements().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe price increments, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setProduct()

int32_t dxfg_InstrumentProfile_setProduct ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the product for futures and options on futures (the name of the underlying asset) of the instrument profile.

Example: /YG.

Java: InstrumentProfile.setProduct(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setProduct().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe product, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setSEDOL()

int32_t dxfg_InstrumentProfile_setSEDOL ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the Stock Exchange Daily Official List code of the instrument profile.

It uses the seven-letter code assigned by the London Stock Exchange. Examples: 2310967, 5766857.

Java: InstrumentProfile.setSEDOL(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setSEDOL().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe SEDOL, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setSettlementStyle()

int32_t dxfg_InstrumentProfile_setSettlementStyle ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the settlement price determination style of the instrument profile.

Examples: Open, Close.

Java: InstrumentProfile.setSettlementStyle(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setSettlementStyle().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe settlement style, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setSIC()

int32_t dxfg_InstrumentProfile_setSIC ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
int32_t value )

Sets the Standard Industrial Classification of the instrument profile.

It uses a four-digit number from the SIC catalog. Example: 7371.

Java: InstrumentProfile.setSIC(int).

Deprecated
Use dxfg_v4_InstrumentProfile_setSIC().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe SIC.
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_InstrumentProfile_setSPC()

int32_t dxfg_InstrumentProfile_setSPC ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
double value )

Sets the shares per contract for options of the instrument profile.

Examples: 1, 100.

Java: InstrumentProfile.setSPC(double).

Deprecated
Use dxfg_v4_InstrumentProfile_setSPC().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe SPC.
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_InstrumentProfile_setStrike()

int32_t dxfg_InstrumentProfile_setStrike ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
double value )

Sets the strike price for options of the instrument profile.

Examples: 80, 22.5.

Java: InstrumentProfile.setStrike(double).

Deprecated
Use dxfg_v4_InstrumentProfile_setStrike().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe strike.
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_InstrumentProfile_setSymbol()

int32_t dxfg_InstrumentProfile_setSymbol ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the identifier of the instrument of the instrument profile.

It is preferably an international one in the Latin alphabet. It is a mandatory field and must not be empty. Examples: GOOG, /YGM9, .ZYEAD.

Java: InstrumentProfile.setSymbol(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setSymbol().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe symbol, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setTradingHours()

int32_t dxfg_InstrumentProfile_setTradingHours ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the trading hours specification of the instrument profile.

The format is the one of Schedule.getInstance(String) of the dxFeed API.

Java: InstrumentProfile.setTradingHours(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setTradingHours().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe trading hours, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setType()

int32_t dxfg_InstrumentProfile_setType ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the type of the instrument of the instrument profile.

It takes precedence over the other fields in conflict cases. It is a mandatory field and must not be empty. Examples: STOCK, FUTURE, OPTION.

Java: InstrumentProfile.setType(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setType().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe type, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfile_setUnderlying()

int32_t dxfg_InstrumentProfile_setUnderlying ( graal_isolatethread_t * thread,
dxfg_instrument_profile_t * ip,
const char * value )

Sets the primary underlying symbol for options of the instrument profile.

Examples: C, /YGM9.

Java: InstrumentProfile.setUnderlying(String).

Deprecated
Use dxfg_v4_InstrumentProfile_setUnderlying().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]ipThe instrument profile handle.
[in]valueThe underlying, a UTF-8 string; NULL is treated as an empty string.
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_InstrumentProfileCollector_addUpdateListener()

int32_t dxfg_InstrumentProfileCollector_addUpdateListener ( graal_isolatethread_t * thread,
dxfg_ipf_collector_t * collector,
dxfg_ipf_update_listener_t * listener )

Adds a listener that is notified about any updates in the set of the instrument profiles.

If the set of the profiles is not empty, the listener is notified about it as well (by the executor of the collector). Remove the listener with dxfg_InstrumentProfileCollector_removeUpdateListener().

Java: InstrumentProfileCollector.addUpdateListener(InstrumentProfileUpdateListener).

Deprecated
Use dxfg_v4_InstrumentProfileCollector_addUpdateListener().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]collectorThe collector handle.
[in]listenerThe listener handle, see dxfg_InstrumentProfileUpdateListener_new().
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_InstrumentProfileCollector_getExecutor()

dxfg_executor_t * dxfg_InstrumentProfileCollector_getExecutor ( graal_isolatethread_t * thread,
dxfg_ipf_collector_t * collector )

Returns the executor that calls the update listeners of the collector.

By default a single-threaded executor is used to process the updates asynchronously.

Java: InstrumentProfileCollector.getExecutor().

Deprecated
Use dxfg_v4_InstrumentProfileCollector_getExecutor().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]collectorThe collector handle.
Returns
The executor (release it with dxfg_JavaObjectHandler_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfileCollector_getLastUpdateTime()

int64_t dxfg_InstrumentProfileCollector_getLastUpdateTime ( graal_isolatethread_t * thread,
dxfg_ipf_collector_t * collector )

Returns the last modification time of the instrument profiles of the collector in milliseconds.

The time is in milliseconds, but the actual granularity of the time is a second.

Java: InstrumentProfileCollector.getLastUpdateTime().

Deprecated
Use dxfg_v4_InstrumentProfileCollector_getLastUpdateTime().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]collectorThe collector handle.
Returns
The last modification time in milliseconds, or -1 on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown.

◆ dxfg_InstrumentProfileCollector_new()

dxfg_ipf_collector_t * dxfg_InstrumentProfileCollector_new ( graal_isolatethread_t * thread)

Creates an instrument profile collector.

The collector keeps one instrument profile per symbol and notifies its listeners about the updates.

Java: new InstrumentProfileCollector().

Deprecated
Use dxfg_v4_InstrumentProfileCollector_new().
Parameters
[in]threadThe current GraalVM Isolate's thread.
Returns
The collector (release it with dxfg_JavaObjectHandler_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfileCollector_removeGenerations()

int32_t dxfg_InstrumentProfileCollector_removeGenerations ( graal_isolatethread_t * thread,
dxfg_ipf_collector_t * collector,
dxfg_java_object_handler_list * generations )

Removes the instrument profiles whose generation tags are in a list.

The profiles without a generation tag are not removed. The time of the call grows with the number of the profiles in the collector: use it sparingly. The list and its handles still belong to the caller.

Java: InstrumentProfileCollector.removeGenerations(Set).

Deprecated
Use dxfg_v4_InstrumentProfileCollector_removeGenerations().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]collectorThe collector handle.
[in]generationsThe list of the generation tags, the handles of Java objects.
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_InstrumentProfileCollector_removeUpdateListener()

int32_t dxfg_InstrumentProfileCollector_removeUpdateListener ( graal_isolatethread_t * thread,
dxfg_ipf_collector_t * collector,
dxfg_ipf_update_listener_t * listener )

Removes a listener that was added with dxfg_InstrumentProfileCollector_addUpdateListener().

The listener handle is not released.

Java: InstrumentProfileCollector.removeUpdateListener(InstrumentProfileUpdateListener).

Deprecated
Use dxfg_v4_InstrumentProfileCollector_removeUpdateListener().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]collectorThe collector handle.
[in]listenerThe listener handle.
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_InstrumentProfileCollector_setExecutor()

int32_t dxfg_InstrumentProfileCollector_setExecutor ( graal_isolatethread_t * thread,
dxfg_ipf_collector_t * collector,
dxfg_executor_t * executor )

Changes the executor that calls the update listeners of the collector.

Java: InstrumentProfileCollector.setExecutor(Executor).

Deprecated
Use dxfg_v4_InstrumentProfileCollector_setExecutor().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]collectorThe collector handle.
[in]executorThe executor handle; it must not be NULL (the function fails otherwise).
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_InstrumentProfileCollector_updateInstrumentProfile()

int32_t dxfg_InstrumentProfileCollector_updateInstrumentProfile ( graal_isolatethread_t * thread,
dxfg_ipf_collector_t * collector,
dxfg_instrument_profile_t * ip )

Updates one instrument profile in the collector.

The collector stores the Java instrument profile object behind the handle, not a copy: do not modify the profile after the call. It is the same as dxfg_InstrumentProfileCollector_updateInstrumentProfiles() with one profile and no generation.

Java: InstrumentProfileCollector.updateInstrumentProfile(InstrumentProfile).

Deprecated
Use dxfg_v4_InstrumentProfileCollector_updateInstrumentProfileHandle().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]collectorThe collector handle.
[in]ipThe instrument profile handle.
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_InstrumentProfileCollector_updateInstrumentProfile2()

int32_t dxfg_InstrumentProfileCollector_updateInstrumentProfile2 ( graal_isolatethread_t * thread,
dxfg_ipf_collector_t * collector,
dxfg_instrument_profile2_t * instrument_profile )

Updates one instrument profile in the collector from a structure.

The collector gets a new Java instrument profile built from the structure: the structure is only read and can be released after the call. The custom fields are shared, not copied (see dxfg_instrument_profile2_t): do not change them through instrument_profile_custom_fields after the call.

Java: InstrumentProfileCollector.updateInstrumentProfile(InstrumentProfile).

Deprecated
Use dxfg_v4_InstrumentProfileCollector_updateInstrumentProfile().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]collectorThe collector handle.
[in]instrument_profileThe structure with the fields of the instrument profile.
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_InstrumentProfileCollector_updateInstrumentProfiles()

int32_t dxfg_InstrumentProfileCollector_updateInstrumentProfiles ( graal_isolatethread_t * thread,
dxfg_ipf_collector_t * collector,
dxfg_instrument_profile_list * ips,
dxfg_java_object_handler * generation )

Updates a list of instrument profiles in the collector and assigns them a generation tag.

The removal of an instrument profile is represented by a profile whose type is REMOVED. The collector stores the Java instrument profile objects behind the handles, not copies: do not modify the profiles after the call. The list and its handles still belong to the caller.

Java: InstrumentProfileCollector.updateInstrumentProfiles(List, Object).

Deprecated
Use dxfg_v4_InstrumentProfileCollector_updateInstrumentProfileHandles().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]collectorThe collector handle.
[in]ipsThe list of the instrument profile handles.
[in]generationThe generation tag, the handle of a Java object, or NULL for none. The tag is used by dxfg_InstrumentProfileCollector_removeGenerations().
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_InstrumentProfileCollector_updateInstrumentProfiles2()

int32_t dxfg_InstrumentProfileCollector_updateInstrumentProfiles2 ( graal_isolatethread_t * thread,
dxfg_ipf_collector_t * collector,
const dxfg_instrument_profile2_t * instrument_profiles,
int32_t size,
dxfg_java_object_handler * generation )

Updates an array of instrument profiles in the collector from structures and assigns them a generation tag.

The collector gets new Java instrument profiles built from the structures: the structures are only read and can be released after the call; the custom fields are shared, not copied (see dxfg_instrument_profile2_t). The call does nothing if the array is NULL or the size is not positive. The removal of an instrument profile is represented by a profile whose type is REMOVED.

Java: InstrumentProfileCollector.updateInstrumentProfiles(List, Object).

Deprecated
Use dxfg_v4_InstrumentProfileCollector_updateInstrumentProfiles().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]collectorThe collector handle.
[in]instrument_profilesThe array of the structures with the fields of the instrument profiles.
[in]sizeThe number of the structures in the array.
[in]generationThe generation tag, the handle of a Java object, or NULL for none. The tag is used by dxfg_InstrumentProfileCollector_removeGenerations().
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_InstrumentProfileCollector_updateInstrumentProfiles3()

int32_t dxfg_InstrumentProfileCollector_updateInstrumentProfiles3 ( graal_isolatethread_t * thread,
dxfg_ipf_collector_t * collector,
const dxfg_instrument_profile2_list_t * instrument_profiles,
dxfg_java_object_handler * generation )

Updates a list of instrument profiles in the collector from structures and assigns them a generation tag.

The collector gets new Java instrument profiles built from the structures: the structures are only read and can be released after the call; the custom fields are shared, not copied (see dxfg_instrument_profile2_t). The removal of an instrument profile is represented by a profile whose type is REMOVED.

Java: InstrumentProfileCollector.updateInstrumentProfiles(List, Object).

Deprecated
Use dxfg_v4_InstrumentProfileCollector_updateInstrumentProfiles().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]collectorThe collector handle.
[in]instrument_profilesThe list of the structures with the fields of the instrument profiles.
[in]generationThe generation tag, the handle of a Java object, or NULL for none. The tag is used by dxfg_InstrumentProfileCollector_removeGenerations().
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_InstrumentProfileCollector_view()

dxfg_iterable_ip_t * dxfg_InstrumentProfileCollector_view ( graal_isolatethread_t * thread,
dxfg_ipf_collector_t * collector )

Returns an iterator over the instrument profiles of the collector.

The iterator is a concurrent view of the set of the profiles. It exposes the profiles that are not removed; however, if the iteration is concurrent with a removal, a removed profile (its type is REMOVED) can be exposed.

Java: InstrumentProfileCollector.view(). The SDK returns the iterator of the view.

Deprecated
Use dxfg_v4_InstrumentProfileCollector_view().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]collectorThe collector handle.
Returns
The iterator (release it with dxfg_JavaObjectHandler_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfileConnection_addStateChangeListener()

int32_t dxfg_InstrumentProfileConnection_addStateChangeListener ( graal_isolatethread_t * thread,
dxfg_ipf_connection_t * connection,
dxfg_ipf_connection_state_change_listener_t * listener )

Adds a listener of the state changes of the connection.

The listener is called for the following state changes only, not for the current state. Remove it with dxfg_InstrumentProfileConnection_removeStateChangeListener().

Java: InstrumentProfileConnection.addStateChangeListener(PropertyChangeListener).

Deprecated
Use dxfg_v4_InstrumentProfileConnection_addStateChangeListener().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]connectionThe connection handle.
[in]listenerThe listener handle, see dxfg_IpfPropertyChangeListener_new().
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_InstrumentProfileConnection_close()

int32_t dxfg_InstrumentProfileConnection_close ( graal_isolatethread_t * thread,
dxfg_ipf_connection_t * connection )

Closes the connection.

The state of the connection immediately changes to DXFG_IPF_CONNECTION_STATE_CLOSED and the background update is terminated. Closing a closed connection does nothing.

Java: InstrumentProfileConnection.close().

Deprecated
Use dxfg_v4_InstrumentProfileConnection_close().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]connectionThe connection handle.
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_InstrumentProfileConnection_createConnection()

dxfg_ipf_connection_t * dxfg_InstrumentProfileConnection_createConnection ( graal_isolatethread_t * thread,
const char * address,
dxfg_ipf_collector_t * collector )

Creates an instrument profile connection to an address that pushes the profiles into a collector.

The address is <host>:<port> of a server, a URL, or a file path. The clause [update=<period>] can be added at the end of the address to set the update period (see dxfg_InstrumentProfileConnection_getUpdatePeriod()); the default period is 1 minute. The connection is not started: call dxfg_InstrumentProfileConnection_start().

Java: InstrumentProfileConnection.createConnection(String, InstrumentProfileCollector).

Deprecated
Use dxfg_v4_InstrumentProfileConnection_createConnection().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]addressThe address, a UTF-8 string.
[in]collectorThe collector handle that the connection pushes the updates into.
Returns
The connection (release it with dxfg_JavaObjectHandler_release(); that does not close the connection), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfileConnection_getAddress()

const char * dxfg_InstrumentProfileConnection_getAddress ( graal_isolatethread_t * thread,
dxfg_ipf_connection_t * connection )

Returns the address of the connection, without the additional options given as a part of it.

Java: InstrumentProfileConnection.getAddress().

Deprecated
Use dxfg_v4_InstrumentProfileConnection_getAddress().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]connectionThe connection handle.
Returns
The address (a UTF-8 string; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfileConnection_getLastModified()

int64_t dxfg_InstrumentProfileConnection_getLastModified ( graal_isolatethread_t * thread,
dxfg_ipf_connection_t * connection )

Returns the last modification time of the instrument profiles in milliseconds, or 0 if it is unknown.

The time is in milliseconds, but the actual granularity of the time is a second.

Java: InstrumentProfileConnection.getLastModified().

Deprecated
Use dxfg_v4_InstrumentProfileConnection_getLastModified().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]connectionThe connection handle.
Returns
The last modification time in milliseconds, or 0 if it is unknown, or -1 on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown.

◆ dxfg_InstrumentProfileConnection_getState()

dxfg_ipf_connection_state_t dxfg_InstrumentProfileConnection_getState ( graal_isolatethread_t * thread,
dxfg_ipf_connection_t * connection )

Returns the state of the connection.

Java: InstrumentProfileConnection.getState().

Deprecated
Use dxfg_v4_InstrumentProfileConnection_getState().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]connectionThe connection handle.
Returns
The state, or -1 (it is not a dxfg_ipf_connection_state_t value) on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown.

◆ dxfg_InstrumentProfileConnection_getUpdatePeriod()

int64_t dxfg_InstrumentProfileConnection_getUpdatePeriod ( graal_isolatethread_t * thread,
dxfg_ipf_connection_t * connection )

Returns the update period of the connection in milliseconds.

It is the period of an update check when the instrument profile source does not support live updates and when the connection is dropped. The default period is 1 minute unless the address of the connection sets another one.

Java: InstrumentProfileConnection.getUpdatePeriod().

Deprecated
Use dxfg_v4_InstrumentProfileConnection_getUpdatePeriod().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]connectionThe connection handle.
Returns
The update period in milliseconds, or -1 on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown.

◆ dxfg_InstrumentProfileConnection_removeStateChangeListener()

int32_t dxfg_InstrumentProfileConnection_removeStateChangeListener ( graal_isolatethread_t * thread,
dxfg_ipf_connection_t * connection,
dxfg_ipf_connection_state_change_listener_t * listener )

Removes a listener of the state changes of the connection.

The listener handle is not released.

Java: InstrumentProfileConnection.removeStateChangeListener(PropertyChangeListener).

Deprecated
Use dxfg_v4_InstrumentProfileConnection_removeStateChangeListener().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]connectionThe connection handle.
[in]listenerThe listener handle that was added with dxfg_InstrumentProfileConnection_addStateChangeListener().
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_InstrumentProfileConnection_setUpdatePeriod()

int32_t dxfg_InstrumentProfileConnection_setUpdatePeriod ( graal_isolatethread_t * thread,
dxfg_ipf_connection_t * connection,
int64_t newValue )

Changes the update period of the connection.

Java: InstrumentProfileConnection.setUpdatePeriod(long).

Deprecated
Use dxfg_v4_InstrumentProfileConnection_setUpdatePeriod().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]connectionThe connection handle.
[in]newValueThe update period in milliseconds; it must not be negative (the function fails otherwise).
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_InstrumentProfileConnection_start()

int32_t dxfg_InstrumentProfileConnection_start ( graal_isolatethread_t * thread,
dxfg_ipf_connection_t * connection )

Starts the connection.

The state of the connection immediately changes to DXFG_IPF_CONNECTION_STATE_CONNECTING and the actual connection is established in the background. The function fails if the state is not DXFG_IPF_CONNECTION_STATE_NOT_CONNECTED (the connection is already started or closed).

Java: InstrumentProfileConnection.start().

Deprecated
Use dxfg_v4_InstrumentProfileConnection_start().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]connectionThe connection handle.
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_InstrumentProfileConnection_waitUntilCompleted()

int32_t dxfg_InstrumentProfileConnection_waitUntilCompleted ( graal_isolatethread_t * thread,
dxfg_ipf_connection_t * connection,
int64_t timeoutInMs )

Waits until the initial snapshot of the instrument profiles is fully read, for at most the timeout.

The calling thread is blocked until the state DXFG_IPF_CONNECTION_STATE_COMPLETED is reached, the connection is closed, or the timeout elapses.

Java: InstrumentProfileConnection.waitUntilCompleted(long, TimeUnit). The timeout is in milliseconds.

Deprecated
Use dxfg_v4_InstrumentProfileConnection_waitUntilCompleted().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]connectionThe connection handle.
[in]timeoutInMsThe maximum time to wait in milliseconds.
Returns
1 if the state DXFG_IPF_CONNECTION_STATE_COMPLETED was reached, 0 if the time elapsed or the connection was closed before the snapshot was fully read, or -1 on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown.

◆ dxfg_InstrumentProfileCustomFields_addNonEmptyFieldNames()

int32_t dxfg_InstrumentProfileCustomFields_addNonEmptyFieldNames ( graal_isolatethread_t * thread,
dxfg_instrument_profile_custom_fields_t * custom_fields,
DXFG_OUT dxfg_string_list ** target_field_names,
DXFG_OUT int32_t * updated )

Returns the names of the non-empty custom fields.

Deprecated
The updated parameter is useless. Use dxfg_v4_InstrumentProfileCustomFields_getNonEmptyFieldNames() instead.

Java: InstrumentProfileCustomFields.addNonEmptyFieldNames(Collection).

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]custom_fieldsThe custom fields handle.
[out]target_field_namesThe list of the names (empty if there are none); release it with dxfg_CList_String_release().
[out]updated1 if any name was written to the list, 0 otherwise. The pointer may be NULL if the flag is not needed.
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_InstrumentProfileCustomFields_getDateField()

int32_t dxfg_InstrumentProfileCustomFields_getDateField ( graal_isolatethread_t * thread,
dxfg_instrument_profile_custom_fields_t * custom_fields,
const char * name,
DXFG_OUT int32_t * result )

Returns the day id of a date custom field by the name.

A field that is not set or is empty gives 0. The function fails if the text of the field is not a date, see dxfg_InstrumentProfileField_parseDate().

Java: InstrumentProfileCustomFields.getDateField(String).

Deprecated
Use dxfg_v4_InstrumentProfileCustomFields_getDateField().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]custom_fieldsThe custom fields handle.
[in]nameThe name of the field, a UTF-8 string.
[out]resultThe day id: the number of days since January 1, 1970, 00:00:00 GMT.
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_InstrumentProfileCustomFields_getField()

int32_t dxfg_InstrumentProfileCustomFields_getField ( graal_isolatethread_t * thread,
dxfg_instrument_profile_custom_fields_t * custom_fields,
const char * name,
DXFG_OUT char ** result )

Returns the value of a custom field by the name.

Java: InstrumentProfileCustomFields.getField(String).

Deprecated
Use dxfg_v4_InstrumentProfileCustomFields_getField().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]custom_fieldsThe custom fields handle.
[in]nameThe name of the field, a UTF-8 string.
[out]resultThe value, a UTF-8 string; release it with dxfg_String_release(). It is NULL if there is no such field.
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_InstrumentProfileCustomFields_getNonEmptyFieldNames()

int32_t dxfg_InstrumentProfileCustomFields_getNonEmptyFieldNames ( graal_isolatethread_t * thread,
dxfg_instrument_profile_custom_fields_t * custom_fields,
DXFG_OUT dxfg_string_list ** target_field_names )

Returns the names of the non-empty custom fields.

Java: InstrumentProfileCustomFields.addNonEmptyFieldNames(Collection).

Deprecated
Use dxfg_v4_InstrumentProfileCustomFields_getNonEmptyFieldNames().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]custom_fieldsThe custom fields handle.
[out]target_field_namesThe list of the names (empty if there are none); release it with dxfg_CList_String_release().
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_InstrumentProfileCustomFields_getNumericField()

int32_t dxfg_InstrumentProfileCustomFields_getNumericField ( graal_isolatethread_t * thread,
dxfg_instrument_profile_custom_fields_t * custom_fields,
const char * name,
DXFG_OUT double * result )

Returns the numeric value of a custom field by the name.

A field that is not set or is empty gives 0. A field whose text looks like a date (yyyy-MM-dd) gives the day id (the number of days since January 1, 1970, 00:00:00 GMT); the text of any other field is parsed as a number.

Java: InstrumentProfileCustomFields.getNumericField(String).

Deprecated
Use dxfg_v4_InstrumentProfileCustomFields_getNumericField().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]custom_fieldsThe custom fields handle.
[in]nameThe name of the field, a UTF-8 string.
[out]resultThe numeric value of the field.
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_InstrumentProfileCustomFields_new()

int32_t dxfg_InstrumentProfileCustomFields_new ( graal_isolatethread_t * thread,
DXFG_OUT dxfg_instrument_profile_custom_fields_t ** custom_fields )

Creates empty custom fields.

Java: new InstrumentProfileCustomFields().

Deprecated
Use dxfg_v4_InstrumentProfileCustomFields_new().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[out]custom_fieldsThe handle of the new custom fields; release it with dxfg_JavaObjectHandler_release().
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_InstrumentProfileCustomFields_new2()

int32_t dxfg_InstrumentProfileCustomFields_new2 ( graal_isolatethread_t * thread,
const char ** custom_fields_array,
int32_t size,
DXFG_OUT dxfg_instrument_profile_custom_fields_t ** custom_fields )

Creates custom fields from an array of strings: the names and the values, consecutive.

The array is name 0, value 0, name 1, value 1 and so on. If the array is NULL or the size is not positive, empty custom fields are created.

Java: new InstrumentProfileCustomFields(String[]).

Deprecated
Use dxfg_v4_InstrumentProfileCustomFields_newWithNamesAndValues().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]custom_fields_arrayThe array of the UTF-8 strings: names and values, consecutive.
[in]sizeThe number of the strings in the array.
[out]custom_fieldsThe handle of the new custom fields; release it with dxfg_JavaObjectHandler_release().
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_InstrumentProfileCustomFields_new3()

int32_t dxfg_InstrumentProfileCustomFields_new3 ( graal_isolatethread_t * thread,
dxfg_instrument_profile_custom_fields_t * source,
DXFG_OUT dxfg_instrument_profile_custom_fields_t ** custom_fields )

Creates custom fields as a copy of other custom fields.

Java: new InstrumentProfileCustomFields(InstrumentProfileCustomFields).

Deprecated
Use dxfg_v4_InstrumentProfileCustomFields_newCopy().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]sourceThe handle of the custom fields to copy.
[out]custom_fieldsThe handle of the new custom fields; release it with dxfg_JavaObjectHandler_release().
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_InstrumentProfileCustomFields_new4()

int32_t dxfg_InstrumentProfileCustomFields_new4 ( graal_isolatethread_t * thread,
const dxfg_string_list * custom_fields_string_list,
DXFG_OUT dxfg_instrument_profile_custom_fields_t ** custom_fields )

Creates custom fields from a list of strings: the names and the values, consecutive.

The list is name 0, value 0, name 1, value 1 and so on. If the list is NULL or empty, empty custom fields are created.

Java: new InstrumentProfileCustomFields(String[]).

Deprecated
Use dxfg_v4_InstrumentProfileCustomFields_newWithNamesAndValues().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]custom_fields_string_listThe list of the UTF-8 strings: names and values, consecutive.
[out]custom_fieldsThe handle of the new custom fields; release it with dxfg_JavaObjectHandler_release().
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_InstrumentProfileCustomFields_setDateField()

int32_t dxfg_InstrumentProfileCustomFields_setDateField ( graal_isolatethread_t * thread,
dxfg_instrument_profile_custom_fields_t * custom_fields,
const char * name,
int32_t value )

Sets the day id of a date custom field by the name.

The field is stored as the text of the date, see dxfg_InstrumentProfileField_formatDate().

Java: InstrumentProfileCustomFields.setDateField(String, int).

Deprecated
Use dxfg_v4_InstrumentProfileCustomFields_setDateField().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]custom_fieldsThe custom fields handle.
[in]nameThe name of the field, a UTF-8 string.
[in]valueThe day id: the number of days since January 1, 1970, 00:00:00 GMT.
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_InstrumentProfileCustomFields_setField()

int32_t dxfg_InstrumentProfileCustomFields_setField ( graal_isolatethread_t * thread,
dxfg_instrument_profile_custom_fields_t * custom_fields,
const char * name,
const char * value )

Sets the value of a custom field by the name.

An empty value clears the field: it is not listed by dxfg_InstrumentProfileCustomFields_getNonEmptyFieldNames() anymore.

Java: InstrumentProfileCustomFields.setField(String, String).

Deprecated
Use dxfg_v4_InstrumentProfileCustomFields_setField().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]custom_fieldsThe custom fields handle.
[in]nameThe name of the field, a UTF-8 string.
[in]valueThe value, a UTF-8 string; it must not be NULL.
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_InstrumentProfileCustomFields_setNumericField()

int32_t dxfg_InstrumentProfileCustomFields_setNumericField ( graal_isolatethread_t * thread,
dxfg_instrument_profile_custom_fields_t * custom_fields,
const char * name,
double value )

Sets the numeric value of a custom field by the name.

The field is stored as the text of the number, see dxfg_InstrumentProfileField_formatNumber().

Java: InstrumentProfileCustomFields.setNumericField(String, double).

Deprecated
Use dxfg_v4_InstrumentProfileCustomFields_setNumericField().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]custom_fieldsThe custom fields handle.
[in]nameThe name of the field, a UTF-8 string.
[in]valueThe value.
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_InstrumentProfileField_formatDate()

int32_t dxfg_InstrumentProfileField_formatDate ( graal_isolatethread_t * thread,
int32_t date,
DXFG_OUT char ** result )

Formats a day id to the text form that is used in the instrument profile fields.

The text is yyyy-MM-dd for the GMT time zone; 0 is formatted as an empty string.

Java: InstrumentProfileField.formatDate(int).

Deprecated
Use dxfg_v4_InstrumentProfileField_formatDate().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]dateThe day id: the number of days since January 1, 1970, 00:00:00 GMT.
[out]resultThe formatted date, a UTF-8 string; release it with dxfg_String_release().
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_InstrumentProfileField_formatNumber()

int32_t dxfg_InstrumentProfileField_formatNumber ( graal_isolatethread_t * thread,
double number,
DXFG_OUT char ** result )

Formats a number to the text form that is used in the instrument profile fields.

The text has no digit grouping; 0 is formatted as an empty string.

Java: InstrumentProfileField.formatNumber(double).

Deprecated
Use dxfg_v4_InstrumentProfileField_formatNumber().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]numberThe number to format.
[out]resultThe formatted number, a UTF-8 string; release it with dxfg_String_release().
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_InstrumentProfileField_parseDate()

int32_t dxfg_InstrumentProfileField_parseDate ( graal_isolatethread_t * thread,
const char * string,
DXFG_OUT int32_t * date )

Parses a day id from the text form that is used in the instrument profile fields.

The text is yyyy-MM-dd for the GMT time zone. A NULL or an empty string gives 0. The function fails if the text is not a date of this format.

Java: InstrumentProfileField.parseDate(String).

Deprecated
Use dxfg_v4_InstrumentProfileField_parseDate().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]stringThe text to parse, a UTF-8 string.
[out]dateThe parsed day id: the number of days since January 1, 1970, 00:00:00 GMT.
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_InstrumentProfileField_parseNumber()

int32_t dxfg_InstrumentProfileField_parseNumber ( graal_isolatethread_t * thread,
const char * string,
DXFG_OUT double * number )

Parses a number from the text form that is used in the instrument profile fields.

A NULL or an empty string gives 0. The function fails if the text is not a number.

Java: InstrumentProfileField.parseNumber(String).

Deprecated
Use dxfg_v4_InstrumentProfileField_parseNumber().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]stringThe text to parse, a UTF-8 string.
[out]numberThe parsed number.
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_InstrumentProfileReader_getLastModified()

int64_t dxfg_InstrumentProfileReader_getLastModified ( graal_isolatethread_t * thread,
dxfg_instrument_profile_reader_t * reader )

Returns the last modification time in milliseconds from the last read from an address, or 0 if it is unknown.

Java: InstrumentProfileReader.getLastModified().

Deprecated
Use dxfg_v4_InstrumentProfileReader_getLastModified().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]readerThe reader handle.
Returns
The last modification time in milliseconds, or 0 if it is unknown, or -1 on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown.

◆ dxfg_InstrumentProfileReader_new()

dxfg_instrument_profile_reader_t * dxfg_InstrumentProfileReader_new ( graal_isolatethread_t * thread)

Creates an instrument profile reader.

Java: new InstrumentProfileReader().

Deprecated
Use dxfg_v4_InstrumentProfileReader_new().
Parameters
[in]threadThe current GraalVM Isolate's thread.
Returns
The reader (release it with dxfg_JavaObjectHandler_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfileReader_read()

dxfg_instrument_profile_list * dxfg_InstrumentProfileReader_read ( graal_isolatethread_t * thread,
dxfg_instrument_profile_reader_t * reader,
dxfg_input_stream_t * is )

Reads and returns the instrument profiles from an input stream with plain (not compressed) data.

It is deprecated in Java; use dxfg_InstrumentProfileReader_read2(). Unlike it, the function does not decompress the stream and does not report an incomplete one. The function fails if the data does not conform to the Instrument Profile Format or on an I/O error.

Java: InstrumentProfileReader.read(InputStream).

Deprecated
Use dxfg_v4_InstrumentProfileReader_readAsHandles().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]readerThe reader handle.
[in]isThe input stream handle.
Returns
The list of the instrument profiles (release it and the profiles in it with dxfg_CList_InstrumentProfile_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfileReader_read2()

dxfg_instrument_profile_list * dxfg_InstrumentProfileReader_read2 ( graal_isolatethread_t * thread,
dxfg_instrument_profile_reader_t * reader,
dxfg_input_stream_t * is,
const char * address )

Reads and returns the instrument profiles from an input stream.

The data compression formats "zip" and "gzip" are recognized automatically: for zip the first file entry is read as a plain data stream, other data is parsed as is. The stream is not closed. The operation updates the value of dxfg_InstrumentProfileReader_wasComplete(). The function fails if the data does not conform to the Instrument Profile Format or on an I/O error.

Java: InstrumentProfileReader.read(InputStream, String).

Deprecated
Use dxfg_v4_InstrumentProfileReader_readWithAddressAsHandles().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]readerThe reader handle.
[in]isThe input stream handle.
[in]addressThe origin of the stream for debugging purposes, a UTF-8 string.
Returns
The list of the instrument profiles (release it and the profiles in it with dxfg_CList_InstrumentProfile_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfileReader_read3()

int32_t dxfg_InstrumentProfileReader_read3 ( graal_isolatethread_t * thread,
dxfg_instrument_profile_reader_t * reader,
dxfg_input_stream_t * is,
DXFG_OUT dxfg_instrument_profile2_t ** instrument_profiles,
DXFG_OUT int32_t * size )

Reads and returns the instrument profiles from an input stream with plain (not compressed) data as structures.

It is deprecated in Java. Use dxfg_InstrumentProfileReader_read4() or dxfg_InstrumentProfileReader_read6(). Unlike dxfg_InstrumentProfileReader_read4(), the function does not decompress the stream and does not report an incomplete one. The function fails if the data does not conform to the Instrument Profile Format or on an I/O error.

Java: InstrumentProfileReader.read(InputStream).

Deprecated
Use dxfg_v4_InstrumentProfileReader_read().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]readerThe reader handle.
[in]isThe input stream handle.
[out]instrument_profilesThe array of the structures with the instrument profiles, NULL if there are none; release it with dxfg_instrument_profiles_array_free().
[out]sizeThe number of the structures in the array.
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_InstrumentProfileReader_read4()

int32_t dxfg_InstrumentProfileReader_read4 ( graal_isolatethread_t * thread,
dxfg_instrument_profile_reader_t * reader,
dxfg_input_stream_t * is,
const char * address,
DXFG_OUT dxfg_instrument_profile2_t ** instrument_profiles,
DXFG_OUT int32_t * size )

Reads and returns the instrument profiles from an input stream as structures.

The data compression formats "zip" and "gzip" are recognized automatically: for zip the first file entry is read as a plain data stream, other data is parsed as is. The stream is not closed. The operation updates the value of dxfg_InstrumentProfileReader_wasComplete(). The function fails if the data does not conform to the Instrument Profile Format or on an I/O error.

Java: InstrumentProfileReader.read(InputStream, String).

Deprecated
Use dxfg_v4_InstrumentProfileReader_readWithAddress().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]readerThe reader handle.
[in]isThe input stream handle.
[in]addressThe origin of the stream for debugging purposes, a UTF-8 string.
[out]instrument_profilesThe array of the structures with the instrument profiles, NULL if there are none; release it with dxfg_instrument_profiles_array_free().
[out]sizeThe number of the structures in the array.
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_InstrumentProfileReader_read5()

int32_t dxfg_InstrumentProfileReader_read5 ( graal_isolatethread_t * thread,
dxfg_instrument_profile_reader_t * reader,
dxfg_input_stream_t * is,
DXFG_OUT dxfg_instrument_profile2_list_t ** instrument_profiles )

Reads and returns the instrument profiles from an input stream with plain (not compressed) data as structures.

It is deprecated in Java. Use dxfg_InstrumentProfileReader_read4() or dxfg_InstrumentProfileReader_read6(). Unlike dxfg_InstrumentProfileReader_read4(), the function does not decompress the stream and does not report an incomplete one. The function fails if the data does not conform to the Instrument Profile Format or on an I/O error.

Java: InstrumentProfileReader.read(InputStream).

Deprecated
Use dxfg_v4_InstrumentProfileReader_read().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]readerThe reader handle.
[in]isThe input stream handle.
[out]instrument_profilesThe list of the structures with the instrument profiles; release it with dxfg_instrument_profile2_list_free().
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_InstrumentProfileReader_read6()

int32_t dxfg_InstrumentProfileReader_read6 ( graal_isolatethread_t * thread,
dxfg_instrument_profile_reader_t * reader,
dxfg_input_stream_t * is,
const char * address,
DXFG_OUT dxfg_instrument_profile2_list_t ** instrument_profiles )

Reads and returns the instrument profiles from an input stream as structures.

The data compression formats "zip" and "gzip" are recognized automatically: for zip the first file entry is read as a plain data stream, other data is parsed as is. The stream is not closed. The operation updates the value of dxfg_InstrumentProfileReader_wasComplete(). The function fails if the data does not conform to the Instrument Profile Format or on an I/O error.

Java: InstrumentProfileReader.read(InputStream, String).

Deprecated
Use dxfg_v4_InstrumentProfileReader_readWithAddress().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]readerThe reader handle.
[in]isThe input stream handle.
[in]addressThe origin of the stream for debugging purposes, a UTF-8 string.
[out]instrument_profilesThe list of the structures with the instrument profiles; release it with dxfg_instrument_profile2_list_free().
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_InstrumentProfileReader_readCompressed()

dxfg_instrument_profile_list * dxfg_InstrumentProfileReader_readCompressed ( graal_isolatethread_t * thread,
dxfg_instrument_profile_reader_t * reader,
dxfg_input_stream_t * is )

Reads and returns the instrument profiles from a compressed input stream.

It is deprecated in Java; use dxfg_InstrumentProfileReader_read2(). The data compression formats "zip" and "gzip" are recognized automatically: for zip the first file entry is read as a plain data stream, other data is parsed as is. The stream is not closed. The operation updates the value of dxfg_InstrumentProfileReader_wasComplete(). The function fails if the data does not conform to the Instrument Profile Format or on an I/O error.

Java: InstrumentProfileReader.readCompressed(InputStream).

Deprecated
Use dxfg_v4_InstrumentProfileReader_readCompressedAsHandles().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]readerThe reader handle.
[in]isThe input stream handle.
Returns
The list of the instrument profiles (release it and the profiles in it with dxfg_CList_InstrumentProfile_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfileReader_readCompressed2()

int32_t dxfg_InstrumentProfileReader_readCompressed2 ( graal_isolatethread_t * thread,
dxfg_instrument_profile_reader_t * reader,
dxfg_input_stream_t * is,
DXFG_OUT dxfg_instrument_profile2_t ** instrument_profiles,
DXFG_OUT int32_t * size )

Reads and returns the instrument profiles from a compressed input stream as structures.

It is deprecated in Java. The data compression formats "zip" and "gzip" are recognized automatically: for zip the first file entry is read as a plain data stream, other data is parsed as is. The stream is not closed. The operation updates the value of dxfg_InstrumentProfileReader_wasComplete(). The function fails if the data does not conform to the Instrument Profile Format or on an I/O error.

Java: InstrumentProfileReader.readCompressed(InputStream).

Deprecated
Use dxfg_v4_InstrumentProfileReader_readCompressed().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]readerThe reader handle.
[in]isThe input stream handle.
[out]instrument_profilesThe array of the structures with the instrument profiles, NULL if there are none; release it with dxfg_instrument_profiles_array_free().
[out]sizeThe number of the structures in the array.
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_InstrumentProfileReader_readCompressed3()

int32_t dxfg_InstrumentProfileReader_readCompressed3 ( graal_isolatethread_t * thread,
dxfg_instrument_profile_reader_t * reader,
dxfg_input_stream_t * is,
DXFG_OUT dxfg_instrument_profile2_list_t ** instrument_profiles )

Reads and returns the instrument profiles from a compressed input stream as structures.

It is deprecated in Java. The data compression formats "zip" and "gzip" are recognized automatically: for zip the first file entry is read as a plain data stream, other data is parsed as is. The stream is not closed. The operation updates the value of dxfg_InstrumentProfileReader_wasComplete(). The function fails if the data does not conform to the Instrument Profile Format or on an I/O error.

Java: InstrumentProfileReader.readCompressed(InputStream).

Deprecated
Use dxfg_v4_InstrumentProfileReader_readCompressed().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]readerThe reader handle.
[in]isThe input stream handle.
[out]instrument_profilesThe list of the structures with the instrument profiles; release it with dxfg_instrument_profile2_list_free().
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_InstrumentProfileReader_readFromFile()

dxfg_instrument_profile_list * dxfg_InstrumentProfileReader_readFromFile ( graal_isolatethread_t * thread,
dxfg_instrument_profile_reader_t * reader,
const char * address )

Reads and returns the instrument profiles from an address.

The data compression formats "zip" and "gzip" are recognized automatically: for zip the first file entry is read as a plain data stream, other data is parsed as is. The address is a URL, a file path or <host>:<port> (see dxfg_InstrumentProfileReader_resolveSourceURL()). Authentication information can be passed as a part of the URL, for example http://user:password@host:port/path/file.ipf. The operation updates the values of dxfg_InstrumentProfileReader_getLastModified() and dxfg_InstrumentProfileReader_wasComplete(). The function fails if the data does not conform to the Instrument Profile Format or on an I/O error.

Java: InstrumentProfileReader.readFromFile(String).

Deprecated
Use dxfg_v4_InstrumentProfileReader_readFromFileAsHandles().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]readerThe reader handle.
[in]addressThe address, a UTF-8 string.
Returns
The list of the instrument profiles (release it and the profiles in it with dxfg_CList_InstrumentProfile_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfileReader_readFromFile2()

dxfg_instrument_profile_list * dxfg_InstrumentProfileReader_readFromFile2 ( graal_isolatethread_t * thread,
dxfg_instrument_profile_reader_t * reader,
const char * address,
const char * user,
const char * password )

Reads and returns the instrument profiles from an address with basic authentication credentials.

The data compression formats "zip" and "gzip" are recognized automatically: for zip the first file entry is read as a plain data stream, other data is parsed as is. The address is a URL, a file path or <host>:<port> (see dxfg_InstrumentProfileReader_resolveSourceURL()). Authentication information can be passed as a part of the URL, for example http://user:password@host:port/path/file.ipf. The user and the password take precedence over the authentication information of the URL. The operation updates the values of dxfg_InstrumentProfileReader_getLastModified() and dxfg_InstrumentProfileReader_wasComplete(). The function fails if the data does not conform to the Instrument Profile Format or on an I/O error.

Java: InstrumentProfileReader.readFromFile(String, String, String).

Deprecated
Use dxfg_v4_InstrumentProfileReader_readFromFileWithUserAndPasswordAsHandles().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]readerThe reader handle.
[in]addressThe address, a UTF-8 string.
[in]userThe user name of the basic authentication, a UTF-8 string, or NULL.
[in]passwordThe password of the basic authentication, a UTF-8 string, or NULL.
Returns
The list of the instrument profiles (release it and the profiles in it with dxfg_CList_InstrumentProfile_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfileReader_readFromFile3()

dxfg_instrument_profile_list * dxfg_InstrumentProfileReader_readFromFile3 ( graal_isolatethread_t * thread,
dxfg_instrument_profile_reader_t * reader,
const char * address,
dxfg_auth_token_t * token )

Reads and returns the instrument profiles from an address with token credentials.

The data compression formats "zip" and "gzip" are recognized automatically: for zip the first file entry is read as a plain data stream, other data is parsed as is. The address is a URL, a file path or <host>:<port> (see dxfg_InstrumentProfileReader_resolveSourceURL()). Authentication information can be passed as a part of the URL, for example http://user:password@host:port/path/file.ipf. The token takes precedence over the authentication information of the URL. The operation updates the values of dxfg_InstrumentProfileReader_getLastModified() and dxfg_InstrumentProfileReader_wasComplete(). The function fails if the data does not conform to the Instrument Profile Format or on an I/O error.

Java: InstrumentProfileReader.readFromFile(String, AuthToken).

Deprecated
Use dxfg_v4_InstrumentProfileReader_readFromFileWithTokenAsHandles().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]readerThe reader handle.
[in]addressThe address, a UTF-8 string.
[in]tokenThe token handle, or NULL.
Returns
The list of the instrument profiles (release it and the profiles in it with dxfg_CList_InstrumentProfile_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfileReader_readFromFile4()

int32_t dxfg_InstrumentProfileReader_readFromFile4 ( graal_isolatethread_t * thread,
dxfg_instrument_profile_reader_t * reader,
const char * address,
DXFG_OUT dxfg_instrument_profile2_t ** instrument_profiles,
DXFG_OUT int32_t * size )

Reads and returns the instrument profiles from an address as structures.

The data compression formats "zip" and "gzip" are recognized automatically: for zip the first file entry is read as a plain data stream, other data is parsed as is. The address is a URL, a file path or <host>:<port> (see dxfg_InstrumentProfileReader_resolveSourceURL()). Authentication information can be passed as a part of the URL, for example http://user:password@host:port/path/file.ipf. The operation updates the values of dxfg_InstrumentProfileReader_getLastModified() and dxfg_InstrumentProfileReader_wasComplete(). The function fails if the data does not conform to the Instrument Profile Format or on an I/O error.

Java: InstrumentProfileReader.readFromFile(String).

Deprecated
Use dxfg_v4_InstrumentProfileReader_readFromFile().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]readerThe reader handle.
[in]addressThe address, a UTF-8 string.
[out]instrument_profilesThe array of the structures with the instrument profiles, NULL if there are none; release it with dxfg_instrument_profiles_array_free().
[out]sizeThe number of the structures in the array.
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_InstrumentProfileReader_readFromFile5()

int32_t dxfg_InstrumentProfileReader_readFromFile5 ( graal_isolatethread_t * thread,
dxfg_instrument_profile_reader_t * reader,
const char * address,
const char * user,
const char * password,
DXFG_OUT dxfg_instrument_profile2_t ** instrument_profiles,
DXFG_OUT int32_t * size )

Reads and returns the instrument profiles from an address with basic authentication credentials as structures.

The data compression formats "zip" and "gzip" are recognized automatically: for zip the first file entry is read as a plain data stream, other data is parsed as is. The address is a URL, a file path or <host>:<port> (see dxfg_InstrumentProfileReader_resolveSourceURL()). Authentication information can be passed as a part of the URL, for example http://user:password@host:port/path/file.ipf. The user and the password take precedence over the authentication information of the URL. The operation updates the values of dxfg_InstrumentProfileReader_getLastModified() and dxfg_InstrumentProfileReader_wasComplete(). The function fails if the data does not conform to the Instrument Profile Format or on an I/O error.

Java: InstrumentProfileReader.readFromFile(String, String, String).

Deprecated
Use dxfg_v4_InstrumentProfileReader_readFromFileWithUserAndPassword().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]readerThe reader handle.
[in]addressThe address, a UTF-8 string.
[in]userThe user name of the basic authentication, a UTF-8 string, or NULL.
[in]passwordThe password of the basic authentication, a UTF-8 string, or NULL.
[out]instrument_profilesThe array of the structures with the instrument profiles, NULL if there are none; release it with dxfg_instrument_profiles_array_free().
[out]sizeThe number of the structures in the array.
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_InstrumentProfileReader_readFromFile6()

int32_t dxfg_InstrumentProfileReader_readFromFile6 ( graal_isolatethread_t * thread,
dxfg_instrument_profile_reader_t * reader,
const char * address,
dxfg_auth_token_t * token,
DXFG_OUT dxfg_instrument_profile2_t ** instrument_profiles,
DXFG_OUT int32_t * size )

Reads and returns the instrument profiles from an address with token credentials as structures.

The data compression formats "zip" and "gzip" are recognized automatically: for zip the first file entry is read as a plain data stream, other data is parsed as is. The address is a URL, a file path or <host>:<port> (see dxfg_InstrumentProfileReader_resolveSourceURL()). Authentication information can be passed as a part of the URL, for example http://user:password@host:port/path/file.ipf. The token takes precedence over the authentication information of the URL. The operation updates the values of dxfg_InstrumentProfileReader_getLastModified() and dxfg_InstrumentProfileReader_wasComplete(). The function fails if the data does not conform to the Instrument Profile Format or on an I/O error.

Java: InstrumentProfileReader.readFromFile(String, AuthToken).

Deprecated
Use dxfg_v4_InstrumentProfileReader_readFromFileWithToken().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]readerThe reader handle.
[in]addressThe address, a UTF-8 string.
[in]tokenThe token handle, or NULL.
[out]instrument_profilesThe array of the structures with the instrument profiles, NULL if there are none; release it with dxfg_instrument_profiles_array_free().
[out]sizeThe number of the structures in the array.
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_InstrumentProfileReader_readFromFile7()

int32_t dxfg_InstrumentProfileReader_readFromFile7 ( graal_isolatethread_t * thread,
dxfg_instrument_profile_reader_t * reader,
const char * address,
DXFG_OUT dxfg_instrument_profile2_list_t ** instrument_profiles )

Reads and returns the instrument profiles from an address as structures.

The data compression formats "zip" and "gzip" are recognized automatically: for zip the first file entry is read as a plain data stream, other data is parsed as is. The address is a URL, a file path or <host>:<port> (see dxfg_InstrumentProfileReader_resolveSourceURL()). Authentication information can be passed as a part of the URL, for example http://user:password@host:port/path/file.ipf. The operation updates the values of dxfg_InstrumentProfileReader_getLastModified() and dxfg_InstrumentProfileReader_wasComplete(). The function fails if the data does not conform to the Instrument Profile Format or on an I/O error.

Java: InstrumentProfileReader.readFromFile(String).

Deprecated
Use dxfg_v4_InstrumentProfileReader_readFromFile().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]readerThe reader handle.
[in]addressThe address, a UTF-8 string.
[out]instrument_profilesThe list of the structures with the instrument profiles; release it with dxfg_instrument_profile2_list_free().
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_InstrumentProfileReader_readFromFile8()

int32_t dxfg_InstrumentProfileReader_readFromFile8 ( graal_isolatethread_t * thread,
dxfg_instrument_profile_reader_t * reader,
const char * address,
const char * user,
const char * password,
DXFG_OUT dxfg_instrument_profile2_list_t ** instrument_profiles )

Reads and returns the instrument profiles from an address with basic authentication credentials as structures.

The data compression formats "zip" and "gzip" are recognized automatically: for zip the first file entry is read as a plain data stream, other data is parsed as is. The address is a URL, a file path or <host>:<port> (see dxfg_InstrumentProfileReader_resolveSourceURL()). Authentication information can be passed as a part of the URL, for example http://user:password@host:port/path/file.ipf. The user and the password take precedence over the authentication information of the URL. The operation updates the values of dxfg_InstrumentProfileReader_getLastModified() and dxfg_InstrumentProfileReader_wasComplete(). The function fails if the data does not conform to the Instrument Profile Format or on an I/O error.

Java: InstrumentProfileReader.readFromFile(String, String, String).

Deprecated
Use dxfg_v4_InstrumentProfileReader_readFromFileWithUserAndPassword().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]readerThe reader handle.
[in]addressThe address, a UTF-8 string.
[in]userThe user name of the basic authentication, a UTF-8 string, or NULL.
[in]passwordThe password of the basic authentication, a UTF-8 string, or NULL.
[out]instrument_profilesThe list of the structures with the instrument profiles; release it with dxfg_instrument_profile2_list_free().
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_InstrumentProfileReader_readFromFile9()

int32_t dxfg_InstrumentProfileReader_readFromFile9 ( graal_isolatethread_t * thread,
dxfg_instrument_profile_reader_t * reader,
const char * address,
dxfg_auth_token_t * token,
DXFG_OUT dxfg_instrument_profile2_list_t ** instrument_profiles )

Reads and returns the instrument profiles from an address with token credentials as structures.

The data compression formats "zip" and "gzip" are recognized automatically: for zip the first file entry is read as a plain data stream, other data is parsed as is. The address is a URL, a file path or <host>:<port> (see dxfg_InstrumentProfileReader_resolveSourceURL()). Authentication information can be passed as a part of the URL, for example http://user:password@host:port/path/file.ipf. The token takes precedence over the authentication information of the URL. The operation updates the values of dxfg_InstrumentProfileReader_getLastModified() and dxfg_InstrumentProfileReader_wasComplete(). The function fails if the data does not conform to the Instrument Profile Format or on an I/O error.

Java: InstrumentProfileReader.readFromFile(String, AuthToken).

Deprecated
Use dxfg_v4_InstrumentProfileReader_readFromFileWithToken().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]readerThe reader handle.
[in]addressThe address, a UTF-8 string.
[in]tokenThe token handle, or NULL.
[out]instrument_profilesThe list of the structures with the instrument profiles; release it with dxfg_instrument_profile2_list_free().
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_InstrumentProfileReader_resolveSourceURL()

const char * dxfg_InstrumentProfileReader_resolveSourceURL ( graal_isolatethread_t * thread,
const char * address )

Converts an address specification into the URL that is read by the dxfg_InstrumentProfileReader_readFromFile*() functions.

An address of the form <host>:<port> (it contains a colon, no slash and ends with a valid port number) becomes http://<host>:<port>/ipf/all.ipf.gz, the query part of the address is kept; any other address is returned as is.

Java: InstrumentProfileReader.resolveSourceURL(String).

Deprecated
Use dxfg_v4_InstrumentProfileReader_resolveSourceURL().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]addressThe address, a UTF-8 string.
Returns
The URL (a UTF-8 string; release it with dxfg_String_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_InstrumentProfileReader_wasComplete()

int32_t dxfg_InstrumentProfileReader_wasComplete ( graal_isolatethread_t * thread,
dxfg_instrument_profile_reader_t * reader )

Checks whether the instrument profile file was fully read by the last read operation.

Java: InstrumentProfileReader.wasComplete().

Deprecated
Use dxfg_v4_InstrumentProfileReader_wasComplete().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]readerThe reader handle.
Returns
1 if the file was fully read, 0 if it was not, or -1 on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown.

◆ dxfg_InstrumentProfileUpdateListener_new()

dxfg_ipf_update_listener_t * dxfg_InstrumentProfileUpdateListener_new ( graal_isolatethread_t * thread,
dxfg_ipf_update_listener_function user_func,
void * user_data )

Creates a listener of the updates of a collector that calls a C function.

Add the listener with dxfg_InstrumentProfileCollector_addUpdateListener(). The function is called by the executor of the collector, see dxfg_ipf_update_listener_function. Releasing the last handle of the listener deactivates it: after dxfg_JavaObjectHandler_release() returns the function is not called anymore, so user_data can be freed.

Java: InstrumentProfileUpdateListener.instrumentProfilesUpdated(Iterator).

Deprecated
Use dxfg_v4_InstrumentProfileUpdateListener_new().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]user_funcThe function to call when the set of the instrument profiles changes.
[in]user_dataThe pointer that is passed to user_func as is; the SDK does not use it.
Returns
The listener (release it with dxfg_JavaObjectHandler_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_IpfPropertyChangeListener_new()

dxfg_ipf_connection_state_change_listener_t * dxfg_IpfPropertyChangeListener_new ( graal_isolatethread_t * thread,
dxfg_ipf_connection_state_change_listener_func user_func,
void * user_data )

Creates a listener of the state changes of a connection that calls a C function.

Add the listener with dxfg_InstrumentProfileConnection_addStateChangeListener(). The function is called by a Java thread, see dxfg_ipf_connection_state_change_listener_func. Releasing the last handle of the listener deactivates it: after dxfg_JavaObjectHandler_release() returns the function is not called anymore, so user_data can be freed.

Java: PropertyChangeListener.propertyChange(PropertyChangeEvent).

Deprecated
Use dxfg_v4_IpfPropertyChangeListener_new().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]user_funcThe function to call when the state of the connection changes.
[in]user_dataThe pointer that is passed to user_func as is; the SDK does not use it.
Returns
The listener (release it with dxfg_JavaObjectHandler_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_Iterable_InstrumentProfile_hasNext()

int32_t dxfg_Iterable_InstrumentProfile_hasNext ( graal_isolatethread_t * thread,
dxfg_iterable_ip_t * iterable_ip )

Checks whether the iterator has a next instrument profile.

Java: Iterator.hasNext().

Deprecated
Use dxfg_v4_Iterable_InstrumentProfile_hasNext().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]iterable_ipThe iterator handle.
Returns
1 if the iterator has a next instrument profile, 0 if it has not, or -1 on error. Use dxfg_get_and_clear_thread_exception_t() to determine if an exception was thrown.

◆ dxfg_Iterable_InstrumentProfile_next()

dxfg_instrument_profile_t * dxfg_Iterable_InstrumentProfile_next ( graal_isolatethread_t * thread,
dxfg_iterable_ip_t * iterable_ip )

Returns the next instrument profile of the iterator as a handle.

Check dxfg_Iterable_InstrumentProfile_hasNext() first: the function fails if there is no next profile. The handle refers to the profile object itself (the collector stores the profiles, not copies): do not modify it. Use dxfg_Iterable_InstrumentProfile_next2() to get a copy.

Java: Iterator.next().

Deprecated
Use dxfg_v4_Iterable_InstrumentProfile_nextHandle().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]iterable_ipThe iterator handle.
Returns
The instrument profile (release it with dxfg_JavaObjectHandler_release()), or NULL on error. Use dxfg_get_and_clear_thread_exception_t() to get the exception.

◆ dxfg_Iterable_InstrumentProfile_next2()

int32_t dxfg_Iterable_InstrumentProfile_next2 ( graal_isolatethread_t * thread,
dxfg_iterable_ip_t * iterable_ip,
DXFG_OUT dxfg_instrument_profile2_t ** instrument_profile )

Returns the next instrument profile of the iterator as a structure.

Check dxfg_Iterable_InstrumentProfile_hasNext() first: the function fails if there is no next profile. The strings of the structure are copies; its custom fields handle shares the custom fields of the profile in the collector (see dxfg_instrument_profile2_t).

Java: Iterator.next().

Deprecated
Use dxfg_v4_Iterable_InstrumentProfile_next().
Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]iterable_ipThe iterator handle.
[out]instrument_profileThe next instrument profile; release it with dxfg_instrument_profile_free().
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.