The CSR API which encapsulates a CSR Service endpoint and the type of requests to be submitted. More...
Typedefs | |
typedef struct _sbr_Csr | sbr_Csr |
The CSR object used to interact with an SBR core services service to submit business reports. More... | |
Functions | |
SBR_CSR_EXPORT int | sbr_csr_create (ato_Ctx *ctx, sbr_Csr **csr, const char *servicetype, const char *csrurl, const char *csrtemplate) |
Create a CSR object from the XML stored in csrtemplate. More... | |
SBR_CSR_EXPORT void | sbr_csr_free (sbr_Csr *csr) |
Free the CSR object if not NULL. More... | |
SBR_CSR_EXPORT size_t | sbr_csr_timeout (ato_Ctx *ctx, sbr_Csr *csr) |
Get the network total timeout value, in seconds, used for requests to SBR CSR services. More... | |
SBR_CSR_EXPORT void | sbr_csr_settimeout (ato_Ctx *ctx, sbr_Csr *csr, size_t timeout) |
Set the network total timeout value, in seconds, used for requests to SBR CSR services. More... | |
SBR_CSR_EXPORT size_t | sbr_csr_timeoutconnect (ato_Ctx *ctx, sbr_Csr *csr) |
Get the network connect timeout value, in seconds, used for requests to SBR CSR services. More... | |
SBR_CSR_EXPORT void | sbr_csr_settimeoutconnect (ato_Ctx *ctx, sbr_Csr *csr, size_t timeout) |
Set the network connect timeout value, in seconds, used for requests to SBR CSR services. More... | |
The CSR API which encapsulates a CSR Service endpoint and the type of requests to be submitted.
typedef struct _sbr_Csr sbr_Csr |
The CSR object used to interact with an SBR core services service to submit business reports.
Use this object to construct one or more sbr_Request objects, each of which contains a sbr_Response object.
SBR_CSR_EXPORT int sbr_csr_create | ( | ato_Ctx * | ctx, |
sbr_Csr ** | csr, | ||
const char * | servicetype, | ||
const char * | csrurl, | ||
const char * | csrtemplate | ||
) |
Create a CSR object from the XML stored in csrtemplate.
ctx | the current thread local Context. |
csr | the address of the object to create. *csr must be initialised to NULL. |
servicetype | the servicetype id to use within the CSR config context. A NULL value will result in an assertion error. |
csrurl | the URL of the CSR service to use. If NULL, the value is read from the current context and servicetype. |
csrtemplate | the XML content. A NULL or empty value will result in an assertion error. sbr_csr_loadtemplate() is provided as a helper function to load from the filesystem. |
SBR_CSR_EXPORT void sbr_csr_free | ( | sbr_Csr * | csr | ) |
Free the CSR object if not NULL.
csr | the CSR object. If NULL do nothing. |
Get the network total timeout value, in seconds, used for requests to SBR CSR services.
ctx | the current thread local Context. |
csr | the CSR object. |
Set the network total timeout value, in seconds, used for requests to SBR CSR services.
This affects all new requests derived from this CSR instance.
ctx | the current thread local Context. |
csr | the CSR object. |
timeout | the timeout value to set. |
Get the network connect timeout value, in seconds, used for requests to SBR CSR services.
ctx | the current thread local Context. |
csr | the CSR object. |
Set the network connect timeout value, in seconds, used for requests to SBR CSR services.
This affects all new requests derived from this CSR instance.
ctx | the current thread local Context. |
csr | the CSR object. |
timeout | the timeout value to set. |