Common API functions.
More...
Common API functions.
◆ dx_get_error_description()
Returns error description by error code.
- Parameters
-
- Returns
- Error description string
◆ dx_get_error_level()
Returns error level by error code.
- Parameters
-
- Returns
- Error level
◆ dxf_free()
DXFEED_API ERRORCODE dxf_free |
( |
void * |
pointer | ) |
|
Frees memory allocated in API functions from this module.
- Parameters
-
[in] | pointer | Pointer to memory allocated earlier in some API function from this module |
◆ dxf_get_last_error()
Retrieves the last error info.
The error is stored on per-thread basis. If the connection termination notifier callback was invoked, then to retrieve the connection's error code call this function right from the callback function. If an error occurred within the error storage subsystem itself, the function will return DXF_FAILURE.
- Parameters
-
[out] | error_code | A pointer to the variable where the error code is to be stored |
[out] | error_descr | A pointer to the variable where the human-friendly error description is to be stored; may be NULL if the text representation of error is not required |
- Returns
- DXF_SUCCESS on successful error retrieval or DXF_FAILURE on error; dxf_get_last_error can be used to retrieve the error code and description in case of failure; error_code and error_descr are returned as output parameters of this function
◆ dxf_initialize_logger()
DXFEED_API ERRORCODE dxf_initialize_logger |
( |
const char * |
file_name, |
|
|
int |
rewrite_file, |
|
|
int |
show_timezone_info, |
|
|
int |
verbose |
|
) |
| |
Initializes the internal logger.
Various actions and events, including the errors, are being logged throughout the library. They may be stored into the file.
- Parameters
-
[in] | file_name | A full path to the file where the log is to be stored |
[in] | rewrite_file | A flag defining the file open mode; if it's nonzero then the log file will be rewritten |
[in] | show_timezone_info | A flag defining the time display option in the log file; if it's nonzero then the time will be displayed with the timezone suffix |
[in] | verbose | A flag defining the logging mode; if it's nonzero then the verbose logging will be enabled |
- Returns
- DXF_SUCCESS on successful logger initialization or DXF_FAILURE on error; dxf_get_last_error can be used to retrieve the error code and description in case of failure;
◆ dxf_initialize_logger_v2()
DXFEED_API ERRORCODE dxf_initialize_logger_v2 |
( |
const char * |
file_name, |
|
|
int |
rewrite_file, |
|
|
int |
show_timezone_info, |
|
|
int |
verbose, |
|
|
int |
log_data_transfer |
|
) |
| |
Initializes the internal logger with data transfer logging.
Various actions and events, including the errors, are being logged throughout the library. They may be stored into the file.
- Parameters
-
[in] | file_name | A full path to the file where the log is to be stored |
[in] | rewrite_file | A flag defining the file open mode; if it's nonzero then the log file will be rewritten |
[in] | show_timezone_info | A flag defining the time display option in the log file; if it's nonzero then the time will be displayed with the timezone suffix |
[in] | verbose | A flag defining the logging mode; if it's nonzero then the verbose logging will be enabled |
[in] | log_data_transfer | A flag defining the logging mode; if it's nonzero then the data transfer (portions of received and sent data) logging will be enabled |
- Returns
- DXF_SUCCESS on successful logger initialization or DXF_FAILURE on error; dxf_get_last_error can be used to retrieve the error code and description in case of failure;
◆ dxf_write_raw_data()
Add dumping of incoming traffic into specific file.
- Parameters
-
[in] | connection | A handle of a previously created connection which the subscription will be using |
[in] | raw_file_name | Raw data file name |