PQLR
Postquantum Crypto Library by QAPP
error_handler.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include <stdlib.h>
4 
5 #include <pqlr/common/pqlr.h>
6 
7 #ifdef __cplusplus
8 extern "C" {
9 #endif //__cplusplus
10 
28 typedef void (*pqlr_error_handler_fnc)(int err_no, const char* msg, void* ctx);
29 
38 typedef struct pqlr_error_handler_callback
39 {
45  pqlr_error_handler_fnc callback;
46 
52  void* ctx;
53 } pqlr_error_handler_callback_t;
54 
55 
72 PQLR_API void pqlr_set_error_handler(
73  pqlr_t pqlr, pqlr_error_handler_callback_t* error_handler);
74 
75 
89 PQLR_API void pqlr_get_error_handler(
90  const pqlr_t pqlr, pqlr_error_handler_callback_t* error_handler);
91 
99 PQLR_API void pqlr_default_error_handler(
100  int err_no, const char* msg, void* ctx);
101 
106 #ifdef __cplusplus
107 } // extern "C"
108 #endif // __cplusplus
PQLR_API
#define PQLR_API
Definition: api.h:22
pqlr_get_error_handler
PQLR_API void pqlr_get_error_handler(const pqlr_t pqlr, pqlr_error_handler_callback_t *error_handler)
Obtains custom error handler specified by pqlr_set_error_handler().
pqlr_error_handler_callback_t
struct pqlr_error_handler_callback pqlr_error_handler_callback_t
Pqlr user's error handler callback interface.
pqlr_set_error_handler
PQLR_API void pqlr_set_error_handler(pqlr_t pqlr, pqlr_error_handler_callback_t *error_handler)
Allows to specify custom fatal error handler for pqlr instance. Please, note that any change in the g...
pqlr_error_handler_fnc
void(* pqlr_error_handler_fnc)(int err_no, const char *msg, void *ctx)
Type definition for error handling function. Place to free user defined resources before termination.
Definition: error_handler.h:28
pqlr_default_error_handler
PQLR_API void pqlr_default_error_handler(int err_no, const char *msg, void *ctx)
Default pqlr fatal error handler. Prints error string to stderr.
pqlr_t
struct pqlr_st * pqlr_t
Pqlr instance handle. Pqlr represents basic library and it's algorithms configuration....
Definition: pqlr.h:26
pqlr_error_handler_callback
Pqlr user's error handler callback interface.
Definition: error_handler.h:39
pqlr_error_handler_callback::ctx
void * ctx
This is a context pointer to be passed to user's callback. User is able to store and access any state...
Definition: error_handler.h:52
pqlr_error_handler_callback::callback
pqlr_error_handler_fnc callback
Error handler function. You can pass pointer to custom fatal error handler function for correct resou...
Definition: error_handler.h:45