|
dxFeed Graal Native SDK 3.12.0
|
The v4 functions and type names of the group InstrumentProfile. Every function returns DXFG_EXECUTE_SUCCESSFULLY or DXFG_EXECUTE_FAIL and writes its result to a DXFG_OUT parameter, see The v4 functions. More...
Functions | |
| int32_t | dxfg_v4_InstrumentProfileConnection_createConnection (graal_isolatethread_t *thread, const char *address, dxfg_v4_ipf_collector_t *collector, DXFG_OUT dxfg_v4_ipf_connection_t **ipfConnection) |
| Creates an instrument profile connection to an address that pushes the profiles into a collector. | |
| int32_t | dxfg_v4_InstrumentProfileConnection_getAddress (graal_isolatethread_t *thread, dxfg_v4_ipf_connection_t *connection, DXFG_OUT const char **address) |
| Returns the address of the connection, without the additional options given as a part of it. | |
| int32_t | dxfg_v4_InstrumentProfileConnection_getUpdatePeriod (graal_isolatethread_t *thread, dxfg_v4_ipf_connection_t *connection, DXFG_OUT int64_t *updatePeriod) |
| Returns the update period of the connection in milliseconds. | |
| int32_t | dxfg_v4_InstrumentProfileConnection_setUpdatePeriod (graal_isolatethread_t *thread, dxfg_v4_ipf_connection_t *connection, int64_t newValue) |
| Changes the update period of the connection. | |
| int32_t | dxfg_v4_InstrumentProfileConnection_getState (graal_isolatethread_t *thread, dxfg_v4_ipf_connection_t *connection, DXFG_OUT dxfg_v4_ipf_connection_state_t *state) |
| Returns the state of the connection. | |
| int32_t | dxfg_v4_InstrumentProfileConnection_getLastModified (graal_isolatethread_t *thread, dxfg_v4_ipf_connection_t *connection, DXFG_OUT int64_t *lastModified) |
| Returns the last modification time of the instrument profiles in milliseconds, or 0 if it is unknown. | |
| int32_t | dxfg_v4_InstrumentProfileConnection_start (graal_isolatethread_t *thread, dxfg_v4_ipf_connection_t *connection) |
| Starts the connection. | |
| int32_t | dxfg_v4_InstrumentProfileConnection_close (graal_isolatethread_t *thread, dxfg_v4_ipf_connection_t *connection) |
| Closes the connection. | |
| int32_t | dxfg_v4_IpfPropertyChangeListener_new (graal_isolatethread_t *thread, dxfg_v4_ipf_connection_state_change_listener_func user_func, void *user_data, DXFG_OUT dxfg_v4_ipf_connection_state_change_listener_t **ipfConnectionStateChangeListener) |
| Creates a listener of the state changes of a connection that calls a C function. | |
| int32_t | dxfg_v4_InstrumentProfileConnection_addStateChangeListener (graal_isolatethread_t *thread, dxfg_v4_ipf_connection_t *connection, dxfg_v4_ipf_connection_state_change_listener_t *listener) |
| Adds a listener of the state changes of the connection. | |
| int32_t | dxfg_v4_InstrumentProfileConnection_removeStateChangeListener (graal_isolatethread_t *thread, dxfg_v4_ipf_connection_t *connection, dxfg_v4_ipf_connection_state_change_listener_t *listener) |
| Removes a listener of the state changes of the connection. | |
| int32_t | dxfg_v4_InstrumentProfileConnection_waitUntilCompleted (graal_isolatethread_t *thread, dxfg_v4_ipf_connection_t *connection, int64_t timeoutInMs, DXFG_OUT int32_t *completed) |
| Waits until the initial snapshot of the instrument profiles is fully read, for at most the timeout. | |
| int32_t | dxfg_v4_instrument_profile_list_wrapper_release (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_list *ips) |
| Releases the list structure only and keeps the instrument profile handles in it. | |
| int32_t | dxfg_v4_instrument_profile_list_release (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_list *ips) |
| Releases the list and all the instrument profile handles in it. | |
| int32_t | dxfg_v4_InstrumentProfileCollector_new (graal_isolatethread_t *thread, DXFG_OUT dxfg_v4_ipf_collector_t **ipfCollector) |
| Creates an instrument profile collector. | |
| int32_t | dxfg_v4_InstrumentProfileCollector_getLastUpdateTime (graal_isolatethread_t *thread, dxfg_v4_ipf_collector_t *collector, DXFG_OUT int64_t *lastUpdateTime) |
| Returns the last modification time of the instrument profiles of the collector in milliseconds. | |
| int32_t | dxfg_v4_InstrumentProfileCollector_updateInstrumentProfileHandle (graal_isolatethread_t *thread, dxfg_v4_ipf_collector_t *collector, dxfg_v4_instrument_profile_t *ip) |
| Updates one instrument profile in the collector. | |
| int32_t | dxfg_v4_InstrumentProfileCollector_updateInstrumentProfileHandles (graal_isolatethread_t *thread, dxfg_v4_ipf_collector_t *collector, dxfg_v4_instrument_profile_list *ips, dxfg_v4_java_object_handler *generation) |
| Updates a list of instrument profiles in the collector and assigns them a generation tag. | |
| int32_t | dxfg_v4_InstrumentProfileCollector_removeGenerations (graal_isolatethread_t *thread, dxfg_v4_ipf_collector_t *collector, dxfg_v4_java_object_handler_list *generations) |
| Removes the instrument profiles whose generation tags are in a list. | |
| int32_t | dxfg_v4_InstrumentProfileCollector_view (graal_isolatethread_t *thread, dxfg_v4_ipf_collector_t *collector, DXFG_OUT dxfg_v4_iterable_ip_t **iterableIp) |
| Returns an iterator over the instrument profiles of the collector. | |
| int32_t | dxfg_v4_InstrumentProfileCollector_getExecutor (graal_isolatethread_t *thread, dxfg_v4_ipf_collector_t *collector, DXFG_OUT dxfg_v4_executor_t **executor) |
| Returns the executor that calls the update listeners of the collector. | |
| int32_t | dxfg_v4_InstrumentProfileCollector_setExecutor (graal_isolatethread_t *thread, dxfg_v4_ipf_collector_t *collector, dxfg_v4_executor_t *executor) |
| Changes the executor that calls the update listeners of the collector. | |
| int32_t | dxfg_v4_InstrumentProfileCollector_addUpdateListener (graal_isolatethread_t *thread, dxfg_v4_ipf_collector_t *collector, dxfg_v4_ipf_update_listener_t *listener) |
| Adds a listener that is notified about any updates in the set of the instrument profiles. | |
| int32_t | dxfg_v4_InstrumentProfileCollector_removeUpdateListener (graal_isolatethread_t *thread, dxfg_v4_ipf_collector_t *collector, dxfg_v4_ipf_update_listener_t *listener) |
| Removes a listener that was added with dxfg_v4_InstrumentProfileCollector_addUpdateListener(). | |
| int32_t | dxfg_v4_Iterable_InstrumentProfile_hasNext (graal_isolatethread_t *thread, dxfg_v4_iterable_ip_t *iterable_ip, DXFG_OUT int32_t *hasNext) |
| Checks whether the iterator has a next instrument profile. | |
| int32_t | dxfg_v4_Iterable_InstrumentProfile_nextHandle (graal_isolatethread_t *thread, dxfg_v4_iterable_ip_t *iterable_ip, DXFG_OUT dxfg_v4_instrument_profile_t **instrumentProfile) |
| Returns the next instrument profile of the iterator as a handle. | |
| int32_t | dxfg_v4_InstrumentProfileUpdateListener_new (graal_isolatethread_t *thread, dxfg_v4_ipf_update_listener_function user_func, void *user_data, DXFG_OUT dxfg_v4_ipf_update_listener_t **ipfUpdateListener) |
| Creates a listener of the updates of a collector that calls a C function. | |
| int32_t | dxfg_v4_InstrumentProfileReader_new (graal_isolatethread_t *thread, DXFG_OUT dxfg_v4_instrument_profile_reader_t **instrumentProfileReader) |
| Creates an instrument profile reader. | |
| int32_t | dxfg_v4_InstrumentProfileReader_getLastModified (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_reader_t *reader, DXFG_OUT int64_t *lastModified) |
| Returns the last modification time in milliseconds from the last read from an address, or 0 if it is unknown. | |
| int32_t | dxfg_v4_InstrumentProfileReader_wasComplete (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_reader_t *reader, DXFG_OUT int32_t *complete) |
| Checks whether the instrument profile file was fully read by the last read operation. | |
| int32_t | dxfg_v4_InstrumentProfileReader_readFromFileAsHandles (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_reader_t *reader, const char *address, DXFG_OUT dxfg_v4_instrument_profile_list **instrumentProfileList) |
| Reads and returns the instrument profiles from an address. | |
| int32_t | dxfg_v4_InstrumentProfileReader_readFromFileWithUserAndPasswordAsHandles (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_reader_t *reader, const char *address, const char *user, const char *password, DXFG_OUT dxfg_v4_instrument_profile_list **instrumentProfileList) |
| Reads and returns the instrument profiles from an address with basic authentication credentials. | |
| int32_t | dxfg_v4_InstrumentProfileReader_readFromFileWithTokenAsHandles (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_reader_t *reader, const char *address, dxfg_v4_auth_token_t *token, DXFG_OUT dxfg_v4_instrument_profile_list **instrumentProfileList) |
| Reads and returns the instrument profiles from an address with token credentials. | |
| int32_t | dxfg_v4_InstrumentProfileReader_resolveSourceURL (graal_isolatethread_t *thread, const char *address, DXFG_OUT const char **url) |
| Converts an address specification into the URL that is read by the dxfg_v4_InstrumentProfileReader_readFromFile*() functions. | |
| int32_t | dxfg_v4_InstrumentProfileReader_readWithAddressAsHandles (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_reader_t *reader, dxfg_v4_input_stream_t *is, const char *address, DXFG_OUT dxfg_v4_instrument_profile_list **instrumentProfileList) |
| Reads and returns the instrument profiles from an input stream. | |
| int32_t | dxfg_v4_InstrumentProfileReader_readCompressedAsHandles (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_reader_t *reader, dxfg_v4_input_stream_t *is, DXFG_OUT dxfg_v4_instrument_profile_list **instrumentProfileList) |
| Reads and returns the instrument profiles from a compressed input stream. | |
| int32_t | dxfg_v4_InstrumentProfileReader_readAsHandles (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_reader_t *reader, dxfg_v4_input_stream_t *is, DXFG_OUT dxfg_v4_instrument_profile_list **instrumentProfileList) |
| Reads and returns the instrument profiles from an input stream with plain (not compressed) data. | |
| int32_t | dxfg_v4_InstrumentProfile_new (graal_isolatethread_t *thread, DXFG_OUT dxfg_v4_instrument_profile_t **instrumentProfile) |
| Creates an instrument profile with the default values: empty strings and zero numbers. | |
| int32_t | dxfg_v4_InstrumentProfile_newCopy (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT dxfg_v4_instrument_profile_t **instrumentProfile) |
| Creates an instrument profile as a copy of another instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getType (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **type) |
| Returns the type of the instrument of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setType (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *value) |
| Sets the type of the instrument of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getSymbol (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **symbol) |
| Returns the identifier of the instrument of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setSymbol (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *value) |
| Sets the identifier of the instrument of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getDescription (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **description) |
| Returns the description of the instrument of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setDescription (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *value) |
| Sets the description of the instrument of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getLocalSymbol (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **localSymbol) |
| Returns the identifier of the instrument in the national language of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setLocalSymbol (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *value) |
| Sets the identifier of the instrument in the national language of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getLocalDescription (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **localDescription) |
| Returns the description of the instrument in the national language of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setLocalDescription (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *value) |
| Sets the description of the instrument in the national language of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getCountry (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **country) |
| Returns the country of origin (incorporation) of the corresponding company or parent entity of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setCountry (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *value) |
| Sets the country of origin (incorporation) of the corresponding company or parent entity of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getOPOL (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **opol) |
| Returns the official Place Of Listing, the organization that has listed the instrument of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setOPOL (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *value) |
| Sets the official Place Of Listing, the organization that has listed the instrument of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getExchangeData (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **exchangeData) |
| Returns the exchange-specific data required to identify the instrument when communicating with the exchange of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setExchangeData (graal_isolatethread_t *thread, dxfg_v4_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. | |
| int32_t | dxfg_v4_InstrumentProfile_getExchanges (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **exchanges) |
| Returns the list of the exchanges where the instrument is quoted or traded of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setExchanges (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *value) |
| Sets the list of the exchanges where the instrument is quoted or traded of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getCurrency (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **currency) |
| Returns the currency of quotation, pricing and trading of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setCurrency (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *value) |
| Sets the currency of quotation, pricing and trading of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getBaseCurrency (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **baseCurrency) |
| Returns the base currency of a currency pair (FOREX instruments) of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setBaseCurrency (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *value) |
| Sets the base currency of a currency pair (FOREX instruments) of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getCFI (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **cfi) |
| Returns the Classification of Financial Instruments code of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setCFI (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *value) |
| Sets the Classification of Financial Instruments code of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getISIN (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **isin) |
| Returns the International Securities Identifying Number of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setISIN (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *value) |
| Sets the International Securities Identifying Number of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getSEDOL (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **sedol) |
| Returns the Stock Exchange Daily Official List code of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setSEDOL (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *value) |
| Sets the Stock Exchange Daily Official List code of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getCUSIP (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **cusip) |
| Returns the Committee on Uniform Security Identification Procedures code of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setCUSIP (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *value) |
| Sets the Committee on Uniform Security Identification Procedures code of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getICB (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT int32_t *icb) |
| Returns the Industry Classification Benchmark of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setICB (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, int32_t value) |
| Sets the Industry Classification Benchmark of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getSIC (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT int32_t *sic) |
| Returns the Standard Industrial Classification of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setSIC (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, int32_t value) |
| Sets the Standard Industrial Classification of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getMultiplier (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT double *multiplier) |
| Returns the market value multiplier of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setMultiplier (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, double value) |
| Sets the market value multiplier of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getProduct (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **product) |
| Returns the product for futures and options on futures (the name of the underlying asset) of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setProduct (graal_isolatethread_t *thread, dxfg_v4_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. | |
| int32_t | dxfg_v4_InstrumentProfile_getUnderlying (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **underlying) |
| Returns the primary underlying symbol for options of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setUnderlying (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *value) |
| Sets the primary underlying symbol for options of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getSPC (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT double *spc) |
| Returns the shares per contract for options of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setSPC (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, double value) |
| Sets the shares per contract for options of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getAdditionalUnderlyings (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **additionalUnderlyings) |
| Returns the additional underlyings for options, including additional cash of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setAdditionalUnderlyings (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *value) |
| Sets the additional underlyings for options, including additional cash of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getMMY (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **mmy) |
| Returns the maturity month-year as provided for the corresponding FIX tag (200) of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setMMY (graal_isolatethread_t *thread, dxfg_v4_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_v4_InstrumentProfile_getExpiration (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT int32_t *expiration) |
| Returns the day id of the expiration of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setExpiration (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, int32_t value) |
| Sets the day id of the expiration of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getLastTrade (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT int32_t *lastTrade) |
| Returns the day id of the last trading day of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setLastTrade (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, int32_t value) |
| Sets the day id of the last trading day of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getStrike (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT double *strike) |
| Returns the strike price for options of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setStrike (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, double value) |
| Sets the strike price for options of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getOptionType (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **optionType) |
| Returns the type of the option of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setOptionType (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *value) |
| Sets the type of the option of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getExpirationStyle (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **expirationStyle) |
| Returns the expiration cycle style of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setExpirationStyle (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *value) |
| Sets the expiration cycle style of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getSettlementStyle (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **settlementStyle) |
| Returns the settlement price determination style of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setSettlementStyle (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *value) |
| Sets the settlement price determination style of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getPriceIncrements (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **priceIncrements) |
| Returns the minimum allowed price increments with the corresponding price ranges of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setPriceIncrements (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *value) |
| Sets the minimum allowed price increments with the corresponding price ranges of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getTradingHours (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT const char **tradingHours) |
| Returns the trading hours specification of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_setTradingHours (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *value) |
| Sets the trading hours specification of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_getField (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *name, DXFG_OUT const char **field) |
| Returns the value of a field of the instrument profile by the name of the field, in the text form. | |
| int32_t | dxfg_v4_InstrumentProfile_setField (graal_isolatethread_t *thread, dxfg_v4_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. | |
| int32_t | dxfg_v4_InstrumentProfile_getNumericField (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *name, DXFG_OUT double *numericField) |
| Returns the value of a field of the instrument profile by the name of the field, in the numeric form. | |
| int32_t | dxfg_v4_InstrumentProfile_setNumericField (graal_isolatethread_t *thread, dxfg_v4_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_v4_InstrumentProfile_getDateField (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, const char *name, DXFG_OUT int32_t *dateField) |
| Returns the day id of a date field of the instrument profile by the name of the field. | |
| int32_t | dxfg_v4_InstrumentProfile_setDateField (graal_isolatethread_t *thread, dxfg_v4_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. | |
| int32_t | dxfg_v4_InstrumentProfile_getNonEmptyCustomFieldNames (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip, DXFG_OUT dxfg_v4_string_list **stringList) |
| Returns the names of the non-empty custom fields of the instrument profile. | |
| int32_t | dxfg_v4_InstrumentProfile_release (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_t *ip) |
| Releases an instrument profile handle. | |
| int32_t | dxfg_v4_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_v4_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_v4_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_v4_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_v4_InstrumentProfileCustomFields_new (graal_isolatethread_t *thread, DXFG_OUT dxfg_v4_instrument_profile_custom_fields_t **custom_fields) |
| Creates empty custom fields. | |
| int32_t | dxfg_v4_InstrumentProfileCustomFields_newCopy (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_custom_fields_t *source, DXFG_OUT dxfg_v4_instrument_profile_custom_fields_t **custom_fields) |
| Creates custom fields as a copy of other custom fields. | |
| int32_t | dxfg_v4_InstrumentProfileCustomFields_newWithNamesAndValues (graal_isolatethread_t *thread, const dxfg_v4_string_list *custom_fields_string_list, DXFG_OUT dxfg_v4_instrument_profile_custom_fields_t **custom_fields) |
| Creates custom fields from a list of strings: the names and the values, consecutive. | |
| int32_t | dxfg_v4_InstrumentProfileCustomFields_getField (graal_isolatethread_t *thread, dxfg_v4_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_v4_InstrumentProfileCustomFields_setField (graal_isolatethread_t *thread, dxfg_v4_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_v4_InstrumentProfileCustomFields_getNumericField (graal_isolatethread_t *thread, dxfg_v4_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_v4_InstrumentProfileCustomFields_setNumericField (graal_isolatethread_t *thread, dxfg_v4_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_v4_InstrumentProfileCustomFields_getDateField (graal_isolatethread_t *thread, dxfg_v4_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_v4_InstrumentProfileCustomFields_setDateField (graal_isolatethread_t *thread, dxfg_v4_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_v4_InstrumentProfileCustomFields_getNonEmptyFieldNames (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_custom_fields_t *custom_fields, DXFG_OUT dxfg_v4_string_list **target_field_names) |
| Returns the names of the non-empty custom fields. | |
| int32_t | dxfg_v4_InstrumentProfileCollector_updateInstrumentProfile (graal_isolatethread_t *thread, dxfg_v4_ipf_collector_t *collector, dxfg_v4_instrument_profile_data_t *instrument_profile) |
| Updates one instrument profile in the collector from a structure. | |
| int32_t | dxfg_v4_InstrumentProfileCollector_updateInstrumentProfiles (graal_isolatethread_t *thread, dxfg_v4_ipf_collector_t *collector, const dxfg_v4_instrument_profile_data_list *instrument_profiles, dxfg_v4_java_object_handler *generation) |
| Updates a list of instrument profiles in the collector from structures and assigns them a generation tag. | |
| int32_t | dxfg_v4_Iterable_InstrumentProfile_next (graal_isolatethread_t *thread, dxfg_v4_iterable_ip_t *iterable_ip, DXFG_OUT dxfg_v4_instrument_profile_data_t **instrument_profile) |
| Returns the next instrument profile of the iterator as a structure. | |
| int32_t | dxfg_v4_InstrumentProfileReader_readFromFile (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_reader_t *reader, const char *address, DXFG_OUT dxfg_v4_instrument_profile_data_list **instrument_profiles) |
| Reads and returns the instrument profiles from an address as structures. | |
| int32_t | dxfg_v4_InstrumentProfileReader_readFromFileWithUserAndPassword (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_reader_t *reader, const char *address, const char *user, const char *password, DXFG_OUT dxfg_v4_instrument_profile_data_list **instrument_profiles) |
| Reads and returns the instrument profiles from an address with basic authentication credentials as structures. | |
| int32_t | dxfg_v4_InstrumentProfileReader_readFromFileWithToken (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_reader_t *reader, const char *address, dxfg_v4_auth_token_t *token, DXFG_OUT dxfg_v4_instrument_profile_data_list **instrument_profiles) |
| Reads and returns the instrument profiles from an address with token credentials as structures. | |
| int32_t | dxfg_v4_InstrumentProfileReader_read (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_reader_t *reader, dxfg_v4_input_stream_t *is, DXFG_OUT dxfg_v4_instrument_profile_data_list **instrument_profiles) |
| Reads and returns the instrument profiles from an input stream with plain (not compressed) data as structures. | |
| int32_t | dxfg_v4_InstrumentProfileReader_readWithAddress (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_reader_t *reader, dxfg_v4_input_stream_t *is, const char *address, DXFG_OUT dxfg_v4_instrument_profile_data_list **instrument_profiles) |
| Reads and returns the instrument profiles from an input stream as structures. | |
| int32_t | dxfg_v4_InstrumentProfileReader_readCompressed (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_reader_t *reader, dxfg_v4_input_stream_t *is, DXFG_OUT dxfg_v4_instrument_profile_data_list **instrument_profiles) |
| Reads and returns the instrument profiles from a compressed input stream as structures. | |
| int32_t | dxfg_v4_instrument_profile_data_release (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_data_t *instrument_profile) |
| Frees the structure of an instrument profile that the SDK has filled, and releases its custom fields handle. | |
| int32_t | dxfg_v4_instrument_profile_data_list_release (graal_isolatethread_t *thread, dxfg_v4_instrument_profile_data_list *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. | |
The v4 functions and type names of the group InstrumentProfile. Every function returns DXFG_EXECUTE_SUCCESSFULLY or DXFG_EXECUTE_FAIL and writes its result to a DXFG_OUT parameter, see The v4 functions.
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).
A list of dxfg_instrument_profile2_t structures.
Release the list and the structures in it with dxfg_instrument_profile2_list_free().
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 share the same storage of the fields, both in a structure that the SDK fills and in a structure passed to the SDK. A change made with dxfg_InstrumentProfileCustomFields_setField() and the like through that handle may change the profile (e.g. the profile in a collector). To change the custom fields independently, make a copy with dxfg_InstrumentProfileCustomFields_new3() first.
Every field is described with the corresponding dxfg_InstrumentProfile_get*() function.
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().
A handle of a Java InstrumentProfileReader object; release it with dxfg_JavaObjectHandler_release().
Create it with dxfg_InstrumentProfileReader_new().
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.
A handle of a Java InstrumentProfileCollector object; release it with dxfg_JavaObjectHandler_release().
Create it with dxfg_InstrumentProfileCollector_new().
| typedef dxfg_ipf_connection_state_change_listener_func dxfg_v4_ipf_connection_state_change_listener_func |
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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | old_state | The previous state of the connection. |
| [in] | new_state | The new state of the connection. |
| [in] | user_data | The pointer that was passed to dxfg_IpfPropertyChangeListener_new(); the SDK does not use it. |
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.
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.
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().
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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | profiles | The iterator over the changed instrument profiles. It belongs to the SDK and is valid during the call only. |
| [in] | user_data | The pointer that was passed to dxfg_InstrumentProfileUpdateListener_new(); the SDK does not use it. |
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.
A handle of a Java Iterator object over instrument profiles; release it with dxfg_JavaObjectHandler_release().
It is returned by dxfg_InstrumentProfileCollector_view() and passed to a dxfg_ipf_update_listener_function. Read it with dxfg_Iterable_InstrumentProfile_hasNext() and dxfg_Iterable_InstrumentProfile_next() or dxfg_Iterable_InstrumentProfile_next2().
| int32_t dxfg_v4_instrument_profile_data_list_release | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_data_list * | 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.
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | instrument_profiles | The list of the structures. |
| int32_t dxfg_v4_instrument_profile_data_release | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_data_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_v4_Iterable_InstrumentProfile_next(), not for an element of an array or a list.
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | instrument_profile | The structure of the instrument profile; NULL does nothing. |
| int32_t dxfg_v4_instrument_profile_list_release | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_list * | ips ) |
Releases the list and all the instrument profile handles in it.
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ips | The list of the instrument profile handles. |
| int32_t dxfg_v4_instrument_profile_list_wrapper_release | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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_v4_instrument_profile_list structure are freed. The profile handles stay valid: release each of them with dxfg_v4_JavaObjectHandler_release().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ips | The list of the instrument profile handles. |
| int32_t dxfg_v4_InstrumentProfile_getAdditionalUnderlyings | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | additionalUnderlyings ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | additionalUnderlyings | The pointer to the variable that receives the additional underlyings (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getBaseCurrency | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | baseCurrency ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | baseCurrency | The pointer to the variable that receives the base currency (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getCFI | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | cfi ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | cfi | The pointer to the variable that receives the CFI (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getCountry | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | country ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | country | The pointer to the variable that receives the country (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getCurrency | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | currency ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | currency | The pointer to the variable that receives the currency (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getCUSIP | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | cusip ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | cusip | The pointer to the variable that receives the CUSIP (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getDateField | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| const char * | name, | ||
| DXFG_OUT int32_t * | dateField ) |
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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | name | The name of the field, a UTF-8 string. |
| [out] | dateField | The pointer to the variable that receives the day id (the number of days since January 1, 1970, 00:00:00 GMT; 0 if it is not set); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getDescription | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | description ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | description | The pointer to the variable that receives the description (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getExchangeData | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | exchangeData ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | exchangeData | The pointer to the variable that receives the exchange data (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getExchanges | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | exchanges ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | exchanges | The pointer to the variable that receives the exchanges (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getExpiration | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT int32_t * | expiration ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | expiration | The pointer to the variable that receives the day id of the expiration (the number of days since January 1, 1970, 00:00:00 GMT; 0 if it is not set); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getExpirationStyle | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | expirationStyle ) |
Returns the expiration cycle style of the instrument profile.
Examples: Weeklys, Quarterlys.
Java: InstrumentProfile.getExpirationStyle().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | expirationStyle | The pointer to the variable that receives the expiration style (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getField | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| const char * | name, | ||
| DXFG_OUT const char ** | field ) |
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_v4_InstrumentProfileField_formatNumber() does, the date fields like dxfg_v4_InstrumentProfileField_formatDate() does (a zero value is an empty string).
Java: InstrumentProfile.getField(String).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | name | The name of the field, a UTF-8 string; the standard field names are case sensitive. |
| [out] | field | The pointer to the variable that receives the value (a UTF-8 string, empty if a custom field is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getICB | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT int32_t * | icb ) |
Returns the Industry Classification Benchmark of the instrument profile.
It uses a four-digit number from the ICB catalog. Example: 9535.
Java: InstrumentProfile.getICB().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | icb | The pointer to the variable that receives the ICB number; must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getISIN | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | isin ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | isin | The pointer to the variable that receives the ISIN (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getLastTrade | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT int32_t * | lastTrade ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | lastTrade | The pointer to the variable that receives 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); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getLocalDescription | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | localDescription ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | localDescription | The pointer to the variable that receives the local description (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getLocalSymbol | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | localSymbol ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | localSymbol | The pointer to the variable that receives the local symbol (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getMMY | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | mmy ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | mmy | The pointer to the variable that receives the MMY (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getMultiplier | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT double * | multiplier ) |
Returns the market value multiplier of the instrument profile.
Examples: 100, 33.2.
Java: InstrumentProfile.getMultiplier().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | multiplier | The pointer to the variable that receives the multiplier; must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getNonEmptyCustomFieldNames | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT dxfg_v4_string_list ** | stringList ) |
Returns the names of the non-empty custom fields of the instrument profile.
Java: InstrumentProfile.addNonEmptyCustomFieldNames(Collection).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | stringList | The pointer to the variable that receives the list of the names (release it with dxfg_v4_string_list_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getNumericField | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| const char * | name, | ||
| DXFG_OUT double * | numericField ) |
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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | name | The name of the field, a UTF-8 string. |
| [out] | numericField | The pointer to the variable that receives the value; must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getOPOL | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | opol ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | opol | The pointer to the variable that receives the OPOL (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getOptionType | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | optionType ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | optionType | The pointer to the variable that receives the option type (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getPriceIncrements | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | priceIncrements ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | priceIncrements | The pointer to the variable that receives the price increments (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getProduct | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | product ) |
Returns the product for futures and options on futures (the name of the underlying asset) of the instrument profile.
Example: /YG.
Java: InstrumentProfile.getProduct().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | product | The pointer to the variable that receives the product (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getSEDOL | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | sedol ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | sedol | The pointer to the variable that receives the SEDOL (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getSettlementStyle | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | settlementStyle ) |
Returns the settlement price determination style of the instrument profile.
Examples: Open, Close.
Java: InstrumentProfile.getSettlementStyle().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | settlementStyle | The pointer to the variable that receives the settlement style (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getSIC | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT int32_t * | sic ) |
Returns the Standard Industrial Classification of the instrument profile.
It uses a four-digit number from the SIC catalog. Example: 7371.
Java: InstrumentProfile.getSIC().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | sic | The pointer to the variable that receives the SIC number; must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getSPC | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT double * | spc ) |
Returns the shares per contract for options of the instrument profile.
Examples: 1, 100.
Java: InstrumentProfile.getSPC().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | spc | The pointer to the variable that receives the SPC; must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getStrike | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT double * | strike ) |
Returns the strike price for options of the instrument profile.
Examples: 80, 22.5.
Java: InstrumentProfile.getStrike().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | strike | The pointer to the variable that receives the strike; must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getSymbol | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | symbol ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | symbol | The pointer to the variable that receives the symbol (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getTradingHours | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | tradingHours ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | tradingHours | The pointer to the variable that receives the trading hours (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getType | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | type ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | type | The pointer to the variable that receives the type (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_getUnderlying | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT const char ** | underlying ) |
Returns the primary underlying symbol for options of the instrument profile.
Examples: C, /YGM9.
Java: InstrumentProfile.getUnderlying().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [out] | underlying | The pointer to the variable that receives the underlying (a UTF-8 string, empty if it is not set; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_new | ( | graal_isolatethread_t * | thread, |
| DXFG_OUT dxfg_v4_instrument_profile_t ** | instrumentProfile ) |
Creates an instrument profile with the default values: empty strings and zero numbers.
Java: new InstrumentProfile.
| [in] | thread | The current GraalVM Isolate's thread. |
| [out] | instrumentProfile | The pointer to the variable that receives the instrument profile (release it with dxfg_v4_JavaObjectHandler_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_newCopy | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| DXFG_OUT dxfg_v4_instrument_profile_t ** | instrumentProfile ) |
Creates an instrument profile as a copy of another instrument profile.
Java: new InstrumentProfile.
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The handle of the instrument profile to copy. |
| [out] | instrumentProfile | The pointer to the variable that receives the instrument profile (release it with dxfg_v4_JavaObjectHandler_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfile_release | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip ) |
Releases an instrument profile handle.
It is the same as dxfg_v4_JavaObjectHandler_release() for the handle.
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| int32_t dxfg_v4_InstrumentProfile_setAdditionalUnderlyings | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The additional underlyings, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setBaseCurrency | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The base currency, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setCFI | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The CFI, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setCountry | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The country, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setCurrency | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The currency, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setCUSIP | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The CUSIP, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setDateField | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | name | The name of the field, a UTF-8 string. |
| [in] | value | The day id (the number of days since January 1, 1970, 00:00:00 GMT). |
| int32_t dxfg_v4_InstrumentProfile_setDescription | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The description, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setExchangeData | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The exchange data, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setExchanges | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The exchanges, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setExpiration | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The expiration. |
| int32_t dxfg_v4_InstrumentProfile_setExpirationStyle | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| const char * | value ) |
Sets the expiration cycle style of the instrument profile.
Examples: Weeklys, Quarterlys.
Java: InstrumentProfile.setExpirationStyle(String).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The expiration style, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setField | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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_v4_InstrumentProfileField_parseNumber() and dxfg_v4_InstrumentProfileField_parseDate() do; the function fails if the text has a wrong format.
Java: InstrumentProfile.setField(String, String).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | name | The name of the field, a UTF-8 string; the standard field names are case sensitive. |
| [in] | value | The value, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setICB | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The ICB. |
| int32_t dxfg_v4_InstrumentProfile_setISIN | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The ISIN, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setLastTrade | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The last trade. |
| int32_t dxfg_v4_InstrumentProfile_setLocalDescription | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The local description, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setLocalSymbol | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The local symbol, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setMMY | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The MMY, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setMultiplier | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| double | value ) |
Sets the market value multiplier of the instrument profile.
Examples: 100, 33.2.
Java: InstrumentProfile.setMultiplier(double).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The multiplier. |
| int32_t dxfg_v4_InstrumentProfile_setNumericField | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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_v4_InstrumentProfile_getNumericField()). A custom field is stored as the text of the number.
Java: InstrumentProfile.setNumericField(String, double).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | name | The name of the field, a UTF-8 string. |
| [in] | value | The value. |
| int32_t dxfg_v4_InstrumentProfile_setOPOL | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The OPOL, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setOptionType | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The option type, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setPriceIncrements | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The price increments, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setProduct | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The product, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setSEDOL | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The SEDOL, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setSettlementStyle | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| const char * | value ) |
Sets the settlement price determination style of the instrument profile.
Examples: Open, Close.
Java: InstrumentProfile.setSettlementStyle(String).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The settlement style, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setSIC | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The SIC. |
| int32_t dxfg_v4_InstrumentProfile_setSPC | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| double | value ) |
Sets the shares per contract for options of the instrument profile.
Examples: 1, 100.
Java: InstrumentProfile.setSPC(double).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The SPC. |
| int32_t dxfg_v4_InstrumentProfile_setStrike | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_t * | ip, | ||
| double | value ) |
Sets the strike price for options of the instrument profile.
Examples: 80, 22.5.
Java: InstrumentProfile.setStrike(double).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The strike. |
| int32_t dxfg_v4_InstrumentProfile_setSymbol | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The symbol, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setTradingHours | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The trading hours, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setType | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The type, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfile_setUnderlying | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | ip | The instrument profile handle. |
| [in] | value | The underlying, a UTF-8 string; NULL is treated as an empty string. |
| int32_t dxfg_v4_InstrumentProfileCollector_addUpdateListener | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_ipf_collector_t * | collector, | ||
| dxfg_v4_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_v4_InstrumentProfileCollector_removeUpdateListener().
Java: InstrumentProfileCollector.addUpdateListener(InstrumentProfileUpdateListener).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | collector | The collector handle. |
| [in] | listener | The listener handle, see dxfg_v4_InstrumentProfileUpdateListener_new(). |
| int32_t dxfg_v4_InstrumentProfileCollector_getExecutor | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_ipf_collector_t * | collector, | ||
| DXFG_OUT dxfg_v4_executor_t ** | executor ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | collector | The collector handle. |
| [out] | executor | The pointer to the variable that receives the executor (release it with dxfg_v4_JavaObjectHandler_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfileCollector_getLastUpdateTime | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_ipf_collector_t * | collector, | ||
| DXFG_OUT int64_t * | lastUpdateTime ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | collector | The collector handle. |
| [out] | lastUpdateTime | The pointer to the variable that receives the last modification time in milliseconds; must not be NULL. |
| int32_t dxfg_v4_InstrumentProfileCollector_new | ( | graal_isolatethread_t * | thread, |
| DXFG_OUT dxfg_v4_ipf_collector_t ** | ipfCollector ) |
Creates an instrument profile collector.
The collector keeps one instrument profile per symbol and notifies its listeners about the updates.
Java: new InstrumentProfileCollector().
| [in] | thread | The current GraalVM Isolate's thread. |
| [out] | ipfCollector | The pointer to the variable that receives the collector (release it with dxfg_v4_JavaObjectHandler_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfileCollector_removeGenerations | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_ipf_collector_t * | collector, | ||
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | collector | The collector handle. |
| [in] | generations | The list of the generation tags, the handles of Java objects. |
| int32_t dxfg_v4_InstrumentProfileCollector_removeUpdateListener | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_ipf_collector_t * | collector, | ||
| dxfg_v4_ipf_update_listener_t * | listener ) |
Removes a listener that was added with dxfg_v4_InstrumentProfileCollector_addUpdateListener().
The listener handle is not released.
Java: InstrumentProfileCollector.removeUpdateListener(InstrumentProfileUpdateListener).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | collector | The collector handle. |
| [in] | listener | The listener handle. |
| int32_t dxfg_v4_InstrumentProfileCollector_setExecutor | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_ipf_collector_t * | collector, | ||
| dxfg_v4_executor_t * | executor ) |
Changes the executor that calls the update listeners of the collector.
Java: InstrumentProfileCollector.setExecutor(Executor).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | collector | The collector handle. |
| [in] | executor | The executor handle; it must not be NULL (the function fails otherwise). |
| int32_t dxfg_v4_InstrumentProfileCollector_updateInstrumentProfile | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_ipf_collector_t * | collector, | ||
| dxfg_v4_instrument_profile_data_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_v4_instrument_profile_data_t): do not change them through instrument_profile_custom_fields after the call.
Java: InstrumentProfileCollector.updateInstrumentProfile(InstrumentProfile).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | collector | The collector handle. |
| [in] | instrument_profile | The structure with the fields of the instrument profile. |
| int32_t dxfg_v4_InstrumentProfileCollector_updateInstrumentProfileHandle | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_ipf_collector_t * | collector, | ||
| dxfg_v4_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_v4_InstrumentProfileCollector_updateInstrumentProfileHandles() with one profile and no generation.
Java: InstrumentProfileCollector.updateInstrumentProfile(InstrumentProfile).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | collector | The collector handle. |
| [in] | ip | The instrument profile handle. |
| int32_t dxfg_v4_InstrumentProfileCollector_updateInstrumentProfileHandles | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_ipf_collector_t * | collector, | ||
| dxfg_v4_instrument_profile_list * | ips, | ||
| dxfg_v4_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.
A list with a NULL element, or with a positive size and NULL elements, is an error: the function fails before it updates any profile. A NULL list or a list of size 0 updates nothing.
Java: InstrumentProfileCollector.updateInstrumentProfiles(List, Object).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | collector | The collector handle. |
| [in] | ips | The list of the instrument profile handles. |
| [in] | generation | The generation tag, the handle of a Java object, or NULL for none. The tag is used by dxfg_v4_InstrumentProfileCollector_removeGenerations(). |
| int32_t dxfg_v4_InstrumentProfileCollector_updateInstrumentProfiles | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_ipf_collector_t * | collector, | ||
| const dxfg_v4_instrument_profile_data_list * | instrument_profiles, | ||
| dxfg_v4_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_v4_instrument_profile_data_t). The removal of an instrument profile is represented by a profile whose type is REMOVED.
A list with a NULL element, or with a positive size and NULL elements, is an error: the function fails before it updates any profile. A NULL list or a list of size 0 updates nothing.
Java: InstrumentProfileCollector.updateInstrumentProfiles(List, Object).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | collector | The collector handle. |
| [in] | instrument_profiles | The list of the structures with the fields of the instrument profiles. |
| [in] | generation | The generation tag, the handle of a Java object, or NULL for none. The tag is used by dxfg_v4_InstrumentProfileCollector_removeGenerations(). |
| int32_t dxfg_v4_InstrumentProfileCollector_view | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_ipf_collector_t * | collector, | ||
| DXFG_OUT dxfg_v4_iterable_ip_t ** | iterableIp ) |
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.
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | collector | The collector handle. |
| [out] | iterableIp | The pointer to the variable that receives the iterator (release it with dxfg_v4_JavaObjectHandler_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfileConnection_addStateChangeListener | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_ipf_connection_t * | connection, | ||
| dxfg_v4_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_v4_InstrumentProfileConnection_removeStateChangeListener().
Java: InstrumentProfileConnection.addStateChangeListener(PropertyChangeListener).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | connection | The connection handle. |
| [in] | listener | The listener handle, see dxfg_v4_IpfPropertyChangeListener_new(). |
| int32_t dxfg_v4_InstrumentProfileConnection_close | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | connection | The connection handle. |
| int32_t dxfg_v4_InstrumentProfileConnection_createConnection | ( | graal_isolatethread_t * | thread, |
| const char * | address, | ||
| dxfg_v4_ipf_collector_t * | collector, | ||
| DXFG_OUT dxfg_v4_ipf_connection_t ** | ipfConnection ) |
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_v4_InstrumentProfileConnection_getUpdatePeriod()); the default period is 1 minute. The connection is not started: call dxfg_v4_InstrumentProfileConnection_start().
Java: InstrumentProfileConnection.createConnection(String, InstrumentProfileCollector).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | address | The address, a UTF-8 string. |
| [in] | collector | The collector handle that the connection pushes the updates into. |
| [out] | ipfConnection | The pointer to the variable that receives the connection (release it with dxfg_v4_JavaObjectHandler_release(); that does not close the connection); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfileConnection_getAddress | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_ipf_connection_t * | connection, | ||
| DXFG_OUT const char ** | address ) |
Returns the address of the connection, without the additional options given as a part of it.
Java: InstrumentProfileConnection.getAddress().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | connection | The connection handle. |
| [out] | address | The pointer to the variable that receives the address (a UTF-8 string; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfileConnection_getLastModified | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_ipf_connection_t * | connection, | ||
| DXFG_OUT int64_t * | lastModified ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | connection | The connection handle. |
| [out] | lastModified | The pointer to the variable that receives the last modification time in milliseconds, or 0 if it is unknown; must not be NULL. |
| int32_t dxfg_v4_InstrumentProfileConnection_getState | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_ipf_connection_t * | connection, | ||
| DXFG_OUT dxfg_v4_ipf_connection_state_t * | state ) |
Returns the state of the connection.
Java: InstrumentProfileConnection.getState().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | connection | The connection handle. |
| [out] | state | The pointer to the variable that receives the state; must not be NULL. |
| int32_t dxfg_v4_InstrumentProfileConnection_getUpdatePeriod | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_ipf_connection_t * | connection, | ||
| DXFG_OUT int64_t * | updatePeriod ) |
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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | connection | The connection handle. |
| [out] | updatePeriod | The pointer to the variable that receives the update period in milliseconds; must not be NULL. |
| int32_t dxfg_v4_InstrumentProfileConnection_removeStateChangeListener | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_ipf_connection_t * | connection, | ||
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | connection | The connection handle. |
| [in] | listener | The listener handle that was added with dxfg_v4_InstrumentProfileConnection_addStateChangeListener(). |
| int32_t dxfg_v4_InstrumentProfileConnection_setUpdatePeriod | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_ipf_connection_t * | connection, | ||
| int64_t | newValue ) |
Changes the update period of the connection.
Java: InstrumentProfileConnection.setUpdatePeriod(long).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | connection | The connection handle. |
| [in] | newValue | The update period in milliseconds; it must not be negative (the function fails otherwise). |
| int32_t dxfg_v4_InstrumentProfileConnection_start | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | connection | The connection handle. |
| int32_t dxfg_v4_InstrumentProfileConnection_waitUntilCompleted | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_ipf_connection_t * | connection, | ||
| int64_t | timeoutInMs, | ||
| DXFG_OUT int32_t * | completed ) |
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.
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | connection | The connection handle. |
| [in] | timeoutInMs | The maximum time to wait in milliseconds. |
| [out] | completed | The pointer to the variable that receives 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; must not be NULL. |
| int32_t dxfg_v4_InstrumentProfileCustomFields_getDateField | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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_v4_InstrumentProfileField_parseDate().
Java: InstrumentProfileCustomFields.getDateField(String).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | custom_fields | The custom fields handle. |
| [in] | name | The name of the field, a UTF-8 string. |
| [out] | result | The day id: the number of days since January 1, 1970, 00:00:00 GMT. |
| int32_t dxfg_v4_InstrumentProfileCustomFields_getField | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | custom_fields | The custom fields handle. |
| [in] | name | The name of the field, a UTF-8 string. |
| [out] | result | The value, a UTF-8 string; release it with dxfg_v4_String_release(). It is NULL if there is no such field. |
| int32_t dxfg_v4_InstrumentProfileCustomFields_getNonEmptyFieldNames | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_custom_fields_t * | custom_fields, | ||
| DXFG_OUT dxfg_v4_string_list ** | target_field_names ) |
Returns the names of the non-empty custom fields.
Java: InstrumentProfileCustomFields.addNonEmptyFieldNames(Collection).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | custom_fields | The custom fields handle. |
| [out] | target_field_names | The list of the names (empty if there are none); release it with dxfg_v4_string_list_release(). |
| int32_t dxfg_v4_InstrumentProfileCustomFields_getNumericField | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | custom_fields | The custom fields handle. |
| [in] | name | The name of the field, a UTF-8 string. |
| [out] | result | The numeric value of the field. |
| int32_t dxfg_v4_InstrumentProfileCustomFields_new | ( | graal_isolatethread_t * | thread, |
| DXFG_OUT dxfg_v4_instrument_profile_custom_fields_t ** | custom_fields ) |
Creates empty custom fields.
Java: new InstrumentProfileCustomFields().
| [in] | thread | The current GraalVM Isolate's thread. |
| [out] | custom_fields | The handle of the new custom fields; release it with dxfg_v4_JavaObjectHandler_release(). |
| int32_t dxfg_v4_InstrumentProfileCustomFields_newCopy | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_custom_fields_t * | source, | ||
| DXFG_OUT dxfg_v4_instrument_profile_custom_fields_t ** | custom_fields ) |
Creates custom fields as a copy of other custom fields.
Java: new InstrumentProfileCustomFields(InstrumentProfileCustomFields).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | source | The handle of the custom fields to copy. |
| [out] | custom_fields | The handle of the new custom fields; release it with dxfg_v4_JavaObjectHandler_release(). |
| int32_t dxfg_v4_InstrumentProfileCustomFields_newWithNamesAndValues | ( | graal_isolatethread_t * | thread, |
| const dxfg_v4_string_list * | custom_fields_string_list, | ||
| DXFG_OUT dxfg_v4_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[]).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | custom_fields_string_list | The list of the UTF-8 strings: names and values, consecutive. |
| [out] | custom_fields | The handle of the new custom fields; release it with dxfg_v4_JavaObjectHandler_release(). |
| int32_t dxfg_v4_InstrumentProfileCustomFields_setDateField | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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_v4_InstrumentProfileField_formatDate().
Java: InstrumentProfileCustomFields.setDateField(String, int).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | custom_fields | The custom fields handle. |
| [in] | name | The name of the field, a UTF-8 string. |
| [in] | value | The day id: the number of days since January 1, 1970, 00:00:00 GMT. |
| int32_t dxfg_v4_InstrumentProfileCustomFields_setField | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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_v4_InstrumentProfileCustomFields_getNonEmptyFieldNames() anymore.
Java: InstrumentProfileCustomFields.setField(String, String).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | custom_fields | The custom fields handle. |
| [in] | name | The name of the field, a UTF-8 string. |
| [in] | value | The value, a UTF-8 string; it must not be NULL. |
| int32_t dxfg_v4_InstrumentProfileCustomFields_setNumericField | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_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_v4_InstrumentProfileField_formatNumber().
Java: InstrumentProfileCustomFields.setNumericField(String, double).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | custom_fields | The custom fields handle. |
| [in] | name | The name of the field, a UTF-8 string. |
| [in] | value | The value. |
| int32_t dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | date | The day id: the number of days since January 1, 1970, 00:00:00 GMT. |
| [out] | result | The formatted date, a UTF-8 string; release it with dxfg_v4_String_release(). |
| int32_t dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | number | The number to format. |
| [out] | result | The formatted number, a UTF-8 string; release it with dxfg_v4_String_release(). |
| int32_t dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | string | The text to parse, a UTF-8 string. |
| [out] | date | The parsed day id: the number of days since January 1, 1970, 00:00:00 GMT. |
| int32_t dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | string | The text to parse, a UTF-8 string. |
| [out] | number | The parsed number. |
| int32_t dxfg_v4_InstrumentProfileReader_getLastModified | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_reader_t * | reader, | ||
| DXFG_OUT int64_t * | lastModified ) |
Returns the last modification time in milliseconds from the last read from an address, or 0 if it is unknown.
Java: InstrumentProfileReader.getLastModified().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | reader | The reader handle. |
| [out] | lastModified | The pointer to the variable that receives the last modification time in milliseconds, or 0 if it is unknown; must not be NULL. |
| int32_t dxfg_v4_InstrumentProfileReader_new | ( | graal_isolatethread_t * | thread, |
| DXFG_OUT dxfg_v4_instrument_profile_reader_t ** | instrumentProfileReader ) |
Creates an instrument profile reader.
Java: new InstrumentProfileReader().
| [in] | thread | The current GraalVM Isolate's thread. |
| [out] | instrumentProfileReader | The pointer to the variable that receives the reader (release it with dxfg_v4_JavaObjectHandler_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfileReader_read | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_reader_t * | reader, | ||
| dxfg_v4_input_stream_t * | is, | ||
| DXFG_OUT dxfg_v4_instrument_profile_data_list ** | 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_v4_InstrumentProfileReader_readWithAddress(). Unlike dxfg_v4_InstrumentProfileReader_readWithAddress(), 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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | reader | The reader handle. |
| [in] | is | The input stream handle. |
| [out] | instrument_profiles | The list of the structures with the instrument profiles; release it with dxfg_v4_instrument_profile_data_list_release(). |
| int32_t dxfg_v4_InstrumentProfileReader_readAsHandles | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_reader_t * | reader, | ||
| dxfg_v4_input_stream_t * | is, | ||
| DXFG_OUT dxfg_v4_instrument_profile_list ** | instrumentProfileList ) |
Reads and returns the instrument profiles from an input stream with plain (not compressed) data.
It is deprecated in Java; use dxfg_v4_InstrumentProfileReader_readWithAddressAsHandles(). 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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | reader | The reader handle. |
| [in] | is | The input stream handle. |
| [out] | instrumentProfileList | The pointer to the variable that receives the list of the instrument profiles (release it and the profiles in it with dxfg_v4_instrument_profile_list_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfileReader_readCompressed | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_reader_t * | reader, | ||
| dxfg_v4_input_stream_t * | is, | ||
| DXFG_OUT dxfg_v4_instrument_profile_data_list ** | 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_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | reader | The reader handle. |
| [in] | is | The input stream handle. |
| [out] | instrument_profiles | The list of the structures with the instrument profiles; release it with dxfg_v4_instrument_profile_data_list_release(). |
| int32_t dxfg_v4_InstrumentProfileReader_readCompressedAsHandles | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_reader_t * | reader, | ||
| dxfg_v4_input_stream_t * | is, | ||
| DXFG_OUT dxfg_v4_instrument_profile_list ** | instrumentProfileList ) |
Reads and returns the instrument profiles from a compressed input stream.
It is deprecated in Java; use dxfg_v4_InstrumentProfileReader_readWithAddressAsHandles(). 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_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | reader | The reader handle. |
| [in] | is | The input stream handle. |
| [out] | instrumentProfileList | The pointer to the variable that receives the list of the instrument profiles (release it and the profiles in it with dxfg_v4_instrument_profile_list_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfileReader_readFromFile | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_reader_t * | reader, | ||
| const char * | address, | ||
| DXFG_OUT dxfg_v4_instrument_profile_data_list ** | 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_v4_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_v4_InstrumentProfileReader_getLastModified() and dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | reader | The reader handle. |
| [in] | address | The address, a UTF-8 string. |
| [out] | instrument_profiles | The list of the structures with the instrument profiles; release it with dxfg_v4_instrument_profile_data_list_release(). |
| int32_t dxfg_v4_InstrumentProfileReader_readFromFileAsHandles | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_reader_t * | reader, | ||
| const char * | address, | ||
| DXFG_OUT dxfg_v4_instrument_profile_list ** | instrumentProfileList ) |
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_v4_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_v4_InstrumentProfileReader_getLastModified() and dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | reader | The reader handle. |
| [in] | address | The address, a UTF-8 string. |
| [out] | instrumentProfileList | The pointer to the variable that receives the list of the instrument profiles (release it and the profiles in it with dxfg_v4_instrument_profile_list_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfileReader_readFromFileWithToken | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_reader_t * | reader, | ||
| const char * | address, | ||
| dxfg_v4_auth_token_t * | token, | ||
| DXFG_OUT dxfg_v4_instrument_profile_data_list ** | 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_v4_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_v4_InstrumentProfileReader_getLastModified() and dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | reader | The reader handle. |
| [in] | address | The address, a UTF-8 string. |
| [in] | token | The token handle, or NULL. |
| [out] | instrument_profiles | The list of the structures with the instrument profiles; release it with dxfg_v4_instrument_profile_data_list_release(). |
| int32_t dxfg_v4_InstrumentProfileReader_readFromFileWithTokenAsHandles | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_reader_t * | reader, | ||
| const char * | address, | ||
| dxfg_v4_auth_token_t * | token, | ||
| DXFG_OUT dxfg_v4_instrument_profile_list ** | instrumentProfileList ) |
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_v4_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_v4_InstrumentProfileReader_getLastModified() and dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | reader | The reader handle. |
| [in] | address | The address, a UTF-8 string. |
| [in] | token | The token handle, or NULL. |
| [out] | instrumentProfileList | The pointer to the variable that receives the list of the instrument profiles (release it and the profiles in it with dxfg_v4_instrument_profile_list_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfileReader_readFromFileWithUserAndPassword | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_reader_t * | reader, | ||
| const char * | address, | ||
| const char * | user, | ||
| const char * | password, | ||
| DXFG_OUT dxfg_v4_instrument_profile_data_list ** | 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_v4_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_v4_InstrumentProfileReader_getLastModified() and dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | reader | The reader handle. |
| [in] | address | The address, a UTF-8 string. |
| [in] | user | The user name of the basic authentication, a UTF-8 string, or NULL. |
| [in] | password | The password of the basic authentication, a UTF-8 string, or NULL. |
| [out] | instrument_profiles | The list of the structures with the instrument profiles; release it with dxfg_v4_instrument_profile_data_list_release(). |
| int32_t dxfg_v4_InstrumentProfileReader_readFromFileWithUserAndPasswordAsHandles | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_reader_t * | reader, | ||
| const char * | address, | ||
| const char * | user, | ||
| const char * | password, | ||
| DXFG_OUT dxfg_v4_instrument_profile_list ** | instrumentProfileList ) |
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_v4_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_v4_InstrumentProfileReader_getLastModified() and dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | reader | The reader handle. |
| [in] | address | The address, a UTF-8 string. |
| [in] | user | The user name of the basic authentication, a UTF-8 string, or NULL. |
| [in] | password | The password of the basic authentication, a UTF-8 string, or NULL. |
| [out] | instrumentProfileList | The pointer to the variable that receives the list of the instrument profiles (release it and the profiles in it with dxfg_v4_instrument_profile_list_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfileReader_readWithAddress | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_reader_t * | reader, | ||
| dxfg_v4_input_stream_t * | is, | ||
| const char * | address, | ||
| DXFG_OUT dxfg_v4_instrument_profile_data_list ** | 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_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | reader | The reader handle. |
| [in] | is | The input stream handle. |
| [in] | address | The origin of the stream for debugging purposes, a UTF-8 string. |
| [out] | instrument_profiles | The list of the structures with the instrument profiles; release it with dxfg_v4_instrument_profile_data_list_release(). |
| int32_t dxfg_v4_InstrumentProfileReader_readWithAddressAsHandles | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_reader_t * | reader, | ||
| dxfg_v4_input_stream_t * | is, | ||
| const char * | address, | ||
| DXFG_OUT dxfg_v4_instrument_profile_list ** | instrumentProfileList ) |
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_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | reader | The reader handle. |
| [in] | is | The input stream handle. |
| [in] | address | The origin of the stream for debugging purposes, a UTF-8 string. |
| [out] | instrumentProfileList | The pointer to the variable that receives the list of the instrument profiles (release it and the profiles in it with dxfg_v4_instrument_profile_list_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfileReader_resolveSourceURL | ( | graal_isolatethread_t * | thread, |
| const char * | address, | ||
| DXFG_OUT const char ** | url ) |
Converts an address specification into the URL that is read by the dxfg_v4_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).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | address | The address, a UTF-8 string. |
| [out] | url | The pointer to the variable that receives the URL (a UTF-8 string; release it with dxfg_v4_String_release()); must not be NULL. |
| int32_t dxfg_v4_InstrumentProfileReader_wasComplete | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_instrument_profile_reader_t * | reader, | ||
| DXFG_OUT int32_t * | complete ) |
Checks whether the instrument profile file was fully read by the last read operation.
Java: InstrumentProfileReader.wasComplete().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | reader | The reader handle. |
| [out] | complete | The pointer to the variable that receives 1 if the file was fully read, 0 if it was not; must not be NULL. |
| int32_t dxfg_v4_InstrumentProfileUpdateListener_new | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_ipf_update_listener_function | user_func, | ||
| void * | user_data, | ||
| DXFG_OUT dxfg_v4_ipf_update_listener_t ** | ipfUpdateListener ) |
Creates a listener of the updates of a collector that calls a C function.
Add the listener with dxfg_v4_InstrumentProfileCollector_addUpdateListener(). The function is called by the executor of the collector, see dxfg_v4_ipf_update_listener_function. Releasing the last handle of the listener deactivates it: after dxfg_v4_JavaObjectHandler_release() returns the function is not called anymore, so user_data can be freed.
Java: InstrumentProfileUpdateListener.instrumentProfilesUpdated(Iterator).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | user_func | The function to call when the set of the instrument profiles changes. |
| [in] | user_data | The pointer that is passed to user_func as is; the SDK does not use it. |
| [out] | ipfUpdateListener | The pointer to the variable that receives the listener (release it with dxfg_v4_JavaObjectHandler_release()); must not be NULL. |
| int32_t dxfg_v4_IpfPropertyChangeListener_new | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_ipf_connection_state_change_listener_func | user_func, | ||
| void * | user_data, | ||
| DXFG_OUT dxfg_v4_ipf_connection_state_change_listener_t ** | ipfConnectionStateChangeListener ) |
Creates a listener of the state changes of a connection that calls a C function.
Add the listener with dxfg_v4_InstrumentProfileConnection_addStateChangeListener(). The function is called by a Java thread, see dxfg_v4_ipf_connection_state_change_listener_func. Releasing the last handle of the listener deactivates it: after dxfg_v4_JavaObjectHandler_release() returns the function is not called anymore, so user_data can be freed.
Java: PropertyChangeListener.propertyChange(PropertyChangeEvent).
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | user_func | The function to call when the state of the connection changes. |
| [in] | user_data | The pointer that is passed to user_func as is; the SDK does not use it. |
| [out] | ipfConnectionStateChangeListener | The pointer to the variable that receives the listener (release it with dxfg_v4_JavaObjectHandler_release()); must not be NULL. |
| int32_t dxfg_v4_Iterable_InstrumentProfile_hasNext | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_iterable_ip_t * | iterable_ip, | ||
| DXFG_OUT int32_t * | hasNext ) |
Checks whether the iterator has a next instrument profile.
Java: Iterator.hasNext().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | iterable_ip | The iterator handle. |
| [out] | hasNext | The pointer to the variable that receives 1 if the iterator has a next instrument profile, 0 if it has not; must not be NULL. |
| int32_t dxfg_v4_Iterable_InstrumentProfile_next | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_iterable_ip_t * | iterable_ip, | ||
| DXFG_OUT dxfg_v4_instrument_profile_data_t ** | instrument_profile ) |
Returns the next instrument profile of the iterator as a structure.
Check dxfg_v4_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_v4_instrument_profile_data_t).
Java: Iterator.next().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | iterable_ip | The iterator handle. |
| [out] | instrument_profile | The next instrument profile; release it with dxfg_v4_instrument_profile_data_release(). |
| int32_t dxfg_v4_Iterable_InstrumentProfile_nextHandle | ( | graal_isolatethread_t * | thread, |
| dxfg_v4_iterable_ip_t * | iterable_ip, | ||
| DXFG_OUT dxfg_v4_instrument_profile_t ** | instrumentProfile ) |
Returns the next instrument profile of the iterator as a handle.
Check dxfg_v4_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_v4_Iterable_InstrumentProfile_next() to get a copy.
Java: Iterator.next().
| [in] | thread | The current GraalVM Isolate's thread. |
| [in] | iterable_ip | The iterator handle. |
| [out] | instrumentProfile | The pointer to the variable that receives the instrument profile (release it with dxfg_v4_JavaObjectHandler_release()); must not be NULL. |