appender.h File Reference
Implement this interface for your own strategies for printing log statements.
More...
#include <log4c/defs.h>
#include <log4c/layout.h>
#include <stdio.h>
Go to the source code of this file.
Detailed Description
Implement this interface for your own strategies for printing log statements.
- Todo:
- the appender interface needs a better configuration system depending on the layout type. The udata field is a just a trick.
Define Documentation
#define log4c_appender_type_define |
( |
a_type |
|
) |
|
Helper macro to define static appender types.
- Parameters:
-
| a_type | the log4c_appender_type_t object to define |
- Warning:
- needs GCC support: otherwise this macro does nothing
- Deprecated:
- This macro, and the static initialialization of appenders in general, is deprecated. Use rather the log4c_appender_type_set() function to initialize your appenders before calling log4c_init()
Typedef Documentation
log4c appender type class
Attributes description:
name
appender type name
open
append
close
Function Documentation
log in appender specific way.
- Parameters:
-
- Bug:
- is this the right place to open an appender ?
closes the appender
- Parameters:
-
| a_appender | the log4c_appender_t object |
- Returns:
- zero if successful, -1 otherwise
Destructor for log4c_appender_t.
Get a pointer to an existing appender.
- Parameters:
-
| a_name | the name of the appender to return. |
- Returns:
- a pointer to an existing appender, or NULL if no appender with the specfied name exists.
- Parameters:
-
| a_appender | the log4c_appender_t object |
- Returns:
- the appender layout
LOG4C_API const char* log4c_appender_get_name |
( |
const log4c_appender_t * |
a_appender |
) |
|
- Parameters:
-
| a_appender | the log4c_appender_t object |
- Returns:
- the appender name
- Parameters:
-
| a_appender | the log4c_appender_t object |
- Returns:
- the appender operations
LOG4C_API void* log4c_appender_get_udata |
( |
const log4c_appender_t * |
a_appender |
) |
|
- Parameters:
-
| a_appender | the log4c_appender_t object |
- Returns:
- the appender user data
Constructor for log4c_appender_t.
opens the appender.
- Parameters:
-
| a_appender | the log4c_appender_t object |
LOG4C_API void log4c_appender_print |
( |
const log4c_appender_t * |
a_appender, |
|
|
FILE * |
a_stream | |
|
) |
| | |
prints the appender on a stream
- Parameters:
-
| a_appender | the log4c_appender_t object |
| a_stream | the stream |
sets the appender layout
- Parameters:
-
| a_appender | the log4c_appender_t object |
| a_layout | the new appender layout |
- Returns:
- the previous appender layout
sets the appender type
- Parameters:
-
| a_appender | the log4c_appender_t object |
| a_type | the new appender type |
- Returns:
- the previous appender type
LOG4C_API void* log4c_appender_set_udata |
( |
log4c_appender_t * |
a_appender, |
|
|
void * |
a_udata | |
|
) |
| | |
sets the appender user data
- Parameters:
-
| a_appender | the log4c_appender_t object |
| a_udata | the new appender user data |
- Returns:
- the previous appender user data
Get a pointer to an existing appender type.
- Parameters:
-
| a_name | the name of the appender type to return. |
- Returns:
- a pointer to an existing appender type, or NULL if no appender type with the specified name exists.
Use this function to register an appender type with log4c. Once this is done you may refer to this type by name both programmatically and in the log4c configuration file.
- Parameters:
-
| a_type | a pointer to the new appender type to set. |
- Returns:
- a pointer to the previous appender type of same name.
Example code fragment:
const log4c_appender_type_t log4c_appender_type_s13_file = {
"s13_file",
s13_file_open,
s13_file_append,
s13_file_close,
};
log4c_appender_type_set(&log4c_appender_type_s13_file);
LOG4C_API void log4c_appender_types_print |
( |
FILE * |
fp |
) |
|
prints all the current registered appender types on a stream
- Parameters:
-