Strophe
0.8
XMPP client library
|
Runtime contexts, library initialization and shutdown, and versioning. More...
Defines | |
#define | LIBXMPP_VERSION_MAJOR (0) |
The major version number of Strophe. | |
#define | LIBXMPP_VERSION_MINOR (0) |
The minor version number of Strophe. | |
Functions | |
void | xmpp_initialize (void) |
Initialize the Strophe library. | |
void | xmpp_shutdown (void) |
Shutdown the Strophe library. | |
int | xmpp_version_check (int major, int minor) |
Check that Strophe supports a specific API version. | |
static void * | _malloc (const size_t size, void *const userdata) |
static void | _free (void *p, void *const userdata) |
static void * | _realloc (void *p, const size_t size, void *const userdata) |
void | xmpp_default_logger (void *const userdata, const xmpp_log_level_t level, const char *const area, const char *const msg) |
Log a message. | |
xmpp_log_t * | xmpp_get_default_logger (xmpp_log_level_t level) |
Get a default logger with filtering. | |
void * | xmpp_alloc (const xmpp_ctx_t *const ctx, const size_t size) |
Allocate memory in a Strophe context. | |
void | xmpp_free (const xmpp_ctx_t *const ctx, void *p) |
Free memory in a Strophe context. | |
void * | xmpp_realloc (const xmpp_ctx_t *const ctx, void *p, const size_t size) |
Reallocate memory in a Strophe context. | |
void | xmpp_log (const xmpp_ctx_t *const ctx, const xmpp_log_level_t level, const char *const area, const char *const fmt, va_list ap) |
Write a log message to the logger. | |
void | xmpp_error (const xmpp_ctx_t *const ctx, const char *const area, const char *const fmt,...) |
Write to the log at the ERROR level. | |
void | xmpp_warn (const xmpp_ctx_t *const ctx, const char *const area, const char *const fmt,...) |
Write to the log at the WARN level. | |
void | xmpp_info (const xmpp_ctx_t *const ctx, const char *const area, const char *const fmt,...) |
Write to the log at the INFO level. | |
void | xmpp_debug (const xmpp_ctx_t *const ctx, const char *const area, const char *const fmt,...) |
Write to the log at the DEBUG level. | |
xmpp_ctx_t * | xmpp_ctx_new (const xmpp_mem_t *const mem, const xmpp_log_t *const log) |
Create and initialize a Strophe context object. | |
void | xmpp_ctx_free (xmpp_ctx_t *const ctx) |
Free a Strophe context object that is no longer in use. | |
Variables | |
static xmpp_mem_t | xmpp_default_mem |
static const char *const | _xmpp_log_level_name [4] = {"DEBUG", "INFO", "WARN", "ERROR"} |
static const xmpp_log_level_t | _xmpp_default_logger_levels [] |
static const xmpp_log_t | _xmpp_default_loggers [] |
static xmpp_log_t | xmpp_default_log = { NULL, NULL } |
Runtime contexts, library initialization and shutdown, and versioning.
#define LIBXMPP_VERSION_MAJOR (0) |
The major version number of Strophe.
#define LIBXMPP_VERSION_MINOR (0) |
The minor version number of Strophe.
static void* _malloc | ( | const size_t | size, |
void *const | userdata | ||
) | [static] |
static void _free | ( | void * | p, |
void *const | userdata | ||
) | [static] |
static void* _realloc | ( | void * | p, |
const size_t | size, | ||
void *const | userdata | ||
) | [static] |
void xmpp_default_logger | ( | void *const | userdata, |
const xmpp_log_level_t | level, | ||
const char *const | area, | ||
const char *const | msg | ||
) |
Log a message.
The default logger writes to stderr.
userdata | the opaque data used by the default logger. This contains the filter level in the default logger. |
level | the level to log at |
area | the area the log message is for |
msg | the log message |
void* xmpp_alloc | ( | const xmpp_ctx_t *const | ctx, |
const size_t | size | ||
) |
Allocate memory in a Strophe context.
All Strophe functions will use this to allocate memory.
ctx | a Strophe context object |
size | the number of bytes to allocate |
void xmpp_free | ( | const xmpp_ctx_t *const | ctx, |
void * | p | ||
) |
Free memory in a Strophe context.
free some blocks returned by other APIs, for example the buffer you get from xmpp_stanza_to_text
All Strophe functions will use this to free allocated memory.
ctx | a Strophe context object |
p | a pointer referencing memory to be freed |
void* xmpp_realloc | ( | const xmpp_ctx_t *const | ctx, |
void * | p, | ||
const size_t | size | ||
) |
Reallocate memory in a Strophe context.
All Strophe functions will use this to reallocate memory.
ctx | a Strophe context object |
p | a pointer to previously allocated memory |
size | the new size in bytes to allocate |
void xmpp_log | ( | const xmpp_ctx_t *const | ctx, |
const xmpp_log_level_t | level, | ||
const char *const | area, | ||
const char *const | fmt, | ||
va_list | ap | ||
) |
Write a log message to the logger.
Write a log message to the logger for the context for the specified level and area. This function takes a printf-style format string and a variable argument list (in va_list) format. This function is not meant to be called directly, but is used via xmpp_error, xmpp_warn, xmpp_info, and xmpp_debug.
ctx | a Strophe context object |
level | the level at which to log |
area | the area to log for |
fmt | a printf-style format string for the message |
ap | variable argument list supplied for the format string |
void xmpp_error | ( | const xmpp_ctx_t *const | ctx, |
const char *const | area, | ||
const char *const | fmt, | ||
... | |||
) |
Write to the log at the ERROR level.
This is a convenience function for writing to the log at the ERROR level. It takes a printf-style format string followed by a variable list of arguments for formatting.
ctx | a Strophe context object |
area | the area to log for |
fmt | a printf-style format string followed by a variable list of arguments to format |
void xmpp_warn | ( | const xmpp_ctx_t *const | ctx, |
const char *const | area, | ||
const char *const | fmt, | ||
... | |||
) |
Write to the log at the WARN level.
This is a convenience function for writing to the log at the WARN level. It takes a printf-style format string followed by a variable list of arguments for formatting.
ctx | a Strophe context object |
area | the area to log for |
fmt | a printf-style format string followed by a variable list of arguments to format |
void xmpp_info | ( | const xmpp_ctx_t *const | ctx, |
const char *const | area, | ||
const char *const | fmt, | ||
... | |||
) |
Write to the log at the INFO level.
This is a convenience function for writing to the log at the INFO level. It takes a printf-style format string followed by a variable list of arguments for formatting.
ctx | a Strophe context object |
area | the area to log for |
fmt | a printf-style format string followed by a variable list of arguments to format |
void xmpp_debug | ( | const xmpp_ctx_t *const | ctx, |
const char *const | area, | ||
const char *const | fmt, | ||
... | |||
) |
Write to the log at the DEBUG level.
This is a convenience function for writing to the log at the DEBUG level. It takes a printf-style format string followed by a variable list of arguments for formatting.
ctx | a Strophe context object |
area | the area to log for |
fmt | a printf-style format string followed by a variable list of arguments to format |
xmpp_mem_t xmpp_default_mem [static] |
const char* const _xmpp_log_level_name[4] = {"DEBUG", "INFO", "WARN", "ERROR"} [static] |
const xmpp_log_level_t _xmpp_default_logger_levels[] [static] |
const xmpp_log_t _xmpp_default_loggers[] [static] |
{ {&xmpp_default_logger, (void*)&_xmpp_default_logger_levels[XMPP_LEVEL_DEBUG]}, {&xmpp_default_logger, (void*)&_xmpp_default_logger_levels[XMPP_LEVEL_INFO]}, {&xmpp_default_logger, (void*)&_xmpp_default_logger_levels[XMPP_LEVEL_WARN]}, {&xmpp_default_logger, (void*)&_xmpp_default_logger_levels[XMPP_LEVEL_ERROR]} }
xmpp_log_t xmpp_default_log = { NULL, NULL } [static] |