Diffusion C API
5.9.24
|
Functions relating to error reporting within the API. More...
Data Structures | |
struct | error_report_s |
Structure describing an error report which may arise when calling various API functions. More... | |
Typedefs | |
typedef struct error_report_s | ERROR_REPORT_T |
Structure describing an error report which may arise when calling various API functions. | |
Functions | |
const char * | diffusion_error_str (const ERROR_CODE_T code) |
Given a Diffusion API error code, return the related error text. More... | |
int | is_recoverable_connection_error (ERROR_CODE_T error_code) |
Given a Diffusion API error code, say whether this indicated that a connection to the server couldn't be made but an immediate retry is may be successful. More... | |
ERROR_REPORT_T * | error_report_create (void) |
Create a new ERROR_REPORT_T structure. | |
void | error_report_free (ERROR_REPORT_T *error_report) |
Free an existing ERROR_REPORT_T structure and associated memory. | |
ERROR_REPORT_T * | error_report_dup (const ERROR_REPORT_T *error_report) |
Create a duplicate (deep copy) of an ERROR_REPORT_T structure. | |
Functions relating to error reporting within the API.
Copyright © 2014, 2015 Push Technology Ltd., All Rights Reserved.
Use is subject to license terms.
NOTICE: All information contained herein is, and remains the property of Push Technology. The intellectual and technical concepts contained herein are proprietary to Push Technology and may be covered by U.S. and Foreign Patents, patents in process, and are protected by trade secret or copyright law.
const char* diffusion_error_str | ( | const ERROR_CODE_T | code | ) |
Given a Diffusion API error code, return the related error text.
code | The Diffusion API error code |
const char * | A pointer to the error message. |
NULL | If there is no error message for this code. |
int is_recoverable_connection_error | ( | ERROR_CODE_T | error_code | ) |
Given a Diffusion API error code, say whether this indicated that a connection to the server couldn't be made but an immediate retry is may be successful.
error_code | The Diffusion API error code |
int | 1 for recoverable, else 0. |