stumpless 2.2.0
|
Macro functions that log messages and entries at the warning level. 更多...
宏定义 | |
#define | stump_w(...) |
Logs a message to the current target with warning severity. | |
#define | stump_w_str(message) |
Logs a message to the current target with warning severity. | |
#define | stump_w_entry(target, entry) stumpless_add_entry( ( target ), ( entry ) ) |
Adds an entry to a given target with warning severity. | |
#define | stump_w_log(target, priority, ...) stumpless_add_log( ( target ), ( priority ), __VA_ARGS__ ) |
Adds a message to a given target with the specified priority. | |
#define | stump_w_log_str(target, priority, message) stumpless_add_log_str( ( target ), ( priority ), ( message ) ) |
Adds a message to a given target with the specified priority. | |
#define | stump_w_message(target, ...) |
Adds a message to a given target with warning severity. | |
#define | stump_w_message_str(target, message) |
Adds a message to a given target with warning severity. | |
#define | stumplog_w(priority, ...) stumplog( ( priority ), __VA_ARGS__ ) |
Adds a message to the current target with the specified priority. | |
#define | stumplog_w_str(priority, message) stumplog_str( ( priority ), ( message ) ) |
Adds a message to the current target with the specified priority. | |
Macro functions that log messages and entries at the warning level.
These can be turned into no-ops at compile time by defining STUMPLESS_DISABLE_WARNING_LEVEL during build, or at least before inclusion of this header (or stumpless.h).
#define stump_w | ( | ... | ) |
Logs a message to the current target with warning severity.
This function will be removed at compile time if STUMPLESS_DISABLE_WARNING_LEVEL has been defined during build. If it is disabled, then this function is removed at compile time and will have no effect. Otherwise, it is equivalent to a call to stumpless_add_log with the provided message and calculated priority.
Note that if this function is disabled, then the arguments will not be evaluated, meaning that any side effects will not happen. Be sure that any side effects you rely on will not cause problems if they are left out during a build with warning level calls disabled.
This function will log the given message with a severity of STUMPLESS_SEVERITY_WARNING, and the facility defined by the STUMPLESS_DEFAULT_FACILITY. If you wish to specify a different priority, then you will need to use stumplog_w instead.
The message must be a valid format specifier string provided along with the appropriate number of variable arguments afterwards. This means that it should not be a user-controlled value under any circumstances. If you need a safer alternative without the risks of format strings, use stump_w_str instead.
Thread Safety: MT-Safe env locale This function is thread safe. Different target types handle thread safety differently, as some require per-target locks and others can rely on system libraries to log safely, but all targets support thread safe logging in some manner. For target-specific information on how thread safety is supported and whether AS or AC safety can be assumed, refer to the documentation for the target's header file (in the stumpless/target
include folder).
Async Signal Safety: AS-Unsafe lock heap This function is not safe to call from signal handlers as some targets make use of non-reentrant locks to coordinate access. It also may make memory allocation calls to create internal cached structures, and memory allocation may not be signal safe.
Async Cancel Safety: AC-Unsafe lock heap This function is not safe to call from threads that may be asynchronously cancelled, due to the use of locks in some targets that could be left locked and the potential for memory allocation.
... | The message to log, optionally along with the values for any format specifiers valid in printf . This must be a valid UTF-8 string in shortest form. |
#define stump_w_entry | ( | target, | |
entry ) stumpless_add_entry( ( target ), ( entry ) ) |
Adds an entry to a given target with warning severity.
This function will be removed at compile time if STUMPLESS_DISABLE_WARNING_LEVEL has been defined during build. If it is disabled, then this function is removed at compile time and will have no effect. Otherwise, it is equivalent to a call to stumpless_add_entry with the provided target and entry.
Note that if this function is disabled, then the arguments will not be evaluated, meaning that any side effects will not happen. Be sure that any side effects you rely on will not cause problems if they are left out during a build with warning level calls disabled.
This call does not override the severity of the entry itself. Rather, it is intended to allow logging calls to be removed at compile time if the severity is known ahead of time.
Thread Safety: MT-Safe env locale This function is thread safe. Different target types handle thread safety differently, as some require per-target locks and others can rely on system libraries to log safely, but all targets support thread safe logging in some manner. For target-specific information on how thread safety is supported and whether AS or AC safety can be assumed, refer to the documentation for the target's header file (in the stumpless/target
include folder).
Async Signal Safety: AS-Unsafe lock This function is not safe to call from signal handlers as some targets make use of non-reentrant locks to coordinate access.
Async Cancel Safety: AC-Unsafe lock This function is not safe to call from threads that may be asynchronously cancelled, due to the use of locks in some targets that could be left locked.
target | The target to send the entry to. |
entry | The entry to send to the target. |
#define stump_w_log | ( | target, | |
priority, | |||
... ) stumpless_add_log( ( target ), ( priority ), __VA_ARGS__ ) |
Adds a message to a given target with the specified priority.
This function will be removed at compile time if STUMPLESS_DISABLE_WARNING_LEVEL has been defined during build. If it is disabled, then this function is removed at compile time and will have no effect. Otherwise, it is equivalent to a call to stumplog with the provided message and priority.
Note that if this function is disabled, then the arguments will not be evaluated, meaning that any side effects will not happen. Be sure that any side effects you rely on will not cause problems if they are left out during a build with warning level calls disabled.
The message must be a valid format specifier string provided along with the appropriate number of variable arguments afterwards. This means that it should not be a user-controlled value under any circumstances. If you need a safer alternative without the risks of format strings, use stump_w_log_str instead.
Thread Safety: MT-Safe env locale This function is thread safe. Different target types handle thread safety differently, as some require per-target locks and others can rely on system libraries to log safely, but all targets support thread safe logging in some manner. For target-specific information on how thread safety is supported and whether AS or AC safety can be assumed, refer to the documentation for the target's header file (in the stumpless/target
include folder).
Async Signal Safety: AS-Unsafe lock heap This function is not safe to call from signal handlers as some targets make use of non-reentrant locks to coordinate access. It also may make memory allocation calls to create internal cached structures, and memory allocation may not be signal safe.
Async Cancel Safety: AC-Unsafe lock heap This function is not safe to call from threads that may be asynchronously cancelled, due to the use of locks in some targets that could be left locked and the potential for memory allocation.
target | The target to send the entry to. |
priority | The priority of the message - this should be the bitwise or of a single STUMPLESS_SEVERITY and single STUMPLESS_FACILITY value. |
... | The message to log, optionally along with the values for any format specifiers valid in printf . This must be a valid UTF-8 string in shortest form. |
#define stump_w_log_str | ( | target, | |
priority, | |||
message ) stumpless_add_log_str( ( target ), ( priority ), ( message ) ) |
Adds a message to a given target with the specified priority.
This function will be removed at compile time if STUMPLESS_DISABLE_WARNING_LEVEL has been defined during build. If it is disabled, then this function is removed at compile time and will have no effect. Otherwise, it is equivalent to a call to stump_w_log_str with the provided target, message, and priority.
Note that if this function is disabled, then the arguments will not be evaluated, meaning that any side effects will not happen. Be sure that any side effects you rely on will not cause problems if they are left out during a build with warning level calls disabled.
Thread Safety: MT-Safe env locale This function is thread safe. Different target types handle thread safety differently, as some require per-target locks and others can rely on system libraries to log safely, but all targets support thread safe logging in some manner. For target-specific information on how thread safety is supported and whether AS or AC safety can be assumed, refer to the documentation for the target's header file (in the stumpless/target
include folder).
Async Signal Safety: AS-Unsafe lock heap This function is not safe to call from signal handlers as some targets make use of non-reentrant locks to coordinate access. It also may make memory allocation calls to create internal cached structures, and memory allocation may not be signal safe.
Async Cancel Safety: AC-Unsafe lock heap This function is not safe to call from threads that may be asynchronously cancelled, due to the use of locks in some targets that could be left locked and the potential for memory allocation.
target | The target to send the entry to. |
priority | The priority of the message - this should be the bitwise or of a single STUMPLESS_SEVERITY and single STUMPLESS_FACILITY value. |
message | The message to log. This must be a valid UTF-8 string in shortest form. |
#define stump_w_message | ( | target, | |
... ) |
Adds a message to a given target with warning severity.
This function will be removed at compile time if STUMPLESS_DISABLE_WARNING_LEVEL has been defined during build. If it is disabled, then this function is removed at compile time and will have no effect. Otherwise, it is equivalent to a call to stumpless_add_log with the provided message and calculated priority.
Note that if this function is disabled, then the arguments will not be evaluated, meaning that any side effects will not happen. Be sure that any side effects you rely on will not cause problems if they are left out during a build with warning level calls disabled.
This function will log the given message with a severity of STUMPLESS_SEVERITY_WARNING, and the facility defined by the STUMPLESS_DEFAULT_FACILITY. If you wish to specify a different priority, then you will need to use stump_w_log instead.
The message must be a valid format specifier string provided along with the appropriate number of variable arguments afterwards. This means that it should not be a user-controlled value under any circumstances. If you need a safer alternative without the risks of format strings, use stump_w_message_str instead.
Thread Safety: MT-Safe env locale This function is thread safe. Different target types handle thread safety differently, as some require per-target locks and others can rely on system libraries to log safely, but all targets support thread safe logging in some manner. For target-specific information on how thread safety is supported and whether AS or AC safety can be assumed, refer to the documentation for the target's header file (in the stumpless/target
include folder).
Async Signal Safety: AS-Unsafe lock heap This function is not safe to call from signal handlers as some targets make use of non-reentrant locks to coordinate access. It also may make memory allocation calls to create internal cached structures, and memory allocation may not be signal safe.
Async Cancel Safety: AC-Unsafe lock heap This function is not safe to call from threads that may be asynchronously cancelled, due to the use of locks in some targets that could be left locked and the potential for memory allocation.
target | The target to send the entry to. |
... | The message to log, optionally along with the values for any format specifiers valid in printf . This must be a valid UTF-8 string in shortest form. |
#define stump_w_message_str | ( | target, | |
message ) |
Adds a message to a given target with warning severity.
This function will be removed at compile time if STUMPLESS_DISABLE_WARNING_LEVEL has been defined during build. If it is disabled, then this function is removed at compile time and will have no effect. Otherwise, it is equivalent to a call to stumpless_add_log_str with the provided target and message.
Note that if this function is disabled, then the arguments will not be evaluated, meaning that any side effects will not happen. Be sure that any side effects you rely on will not cause problems if they are left out during a build with warning level calls disabled.
This function will log the given message with a severity of STUMPLESS_SEVERITY_WARNING, and the facility defined by the STUMPLESS_DEFAULT_FACILITY. If you wish to specify a different priority, then you will need to use stump_w_log instead.
Thread Safety: MT-Safe env locale This function is thread safe. Different target types handle thread safety differently, as some require per-target locks and others can rely on system libraries to log safely, but all targets support thread safe logging in some manner. For target-specific information on how thread safety is supported and whether AS or AC safety can be assumed, refer to the documentation for the target's header file (in the stumpless/target
include folder).
Async Signal Safety: AS-Unsafe lock heap This function is not safe to call from signal handlers as some targets make use of non-reentrant locks to coordinate access. It also may make memory allocation calls to create internal cached structures, and memory allocation may not be signal safe.
Async Cancel Safety: AC-Unsafe lock heap This function is not safe to call from threads that may be asynchronously cancelled, due to the use of locks in some targets that could be left locked and the potential for memory allocation.
target | The target to send the entry to. |
message | The message to log. This must be a valid UTF-8 string in shortest form. |
#define stump_w_str | ( | message | ) |
Logs a message to the current target with warning severity.
This function will be removed at compile time if STUMPLESS_DISABLE_WARNING_LEVEL has been defined during build. If it is disabled, then this function is removed at compile time and will have no effect. Otherwise, it is equivalent to a call to stumpless_add_log with the provided message and calculated priority.
Note that if this function is disabled, then the arguments will not be evaluated, meaning that any side effects will not happen. Be sure that any side effects you rely on will not cause problems if they are left out during a build with warning level calls disabled.
This function will log the given message with a severity of STUMPLESS_SEVERITY_WARNING, and the facility defined by the STUMPLESS_DEFAULT_FACILITY. If you wish to specify a different priority, then you will need to use stumplog_em instead.
Thread Safety: MT-Safe env locale This function is thread safe. Different target types handle thread safety differently, as some require per-target locks and others can rely on system libraries to log safely, but all targets support thread safe logging in some manner. For target-specific information on how thread safety is supported and whether AS or AC safety can be assumed, refer to the documentation for the target's header file (in the stumpless/target
include folder).
Async Signal Safety: AS-Unsafe lock heap This function is not safe to call from signal handlers as some targets make use of non-reentrant locks to coordinate access. It also may make memory allocation calls to create internal cached structures, and memory allocation may not be signal safe.
Async Cancel Safety: AC-Unsafe lock heap This function is not safe to call from threads that may be asynchronously cancelled, due to the use of locks in some targets that could be left locked and the potential for memory allocation.
message | The message to log. This must be a valid UTF-8 string in shortest form. |
#define stumplog_w | ( | priority, | |
... ) stumplog( ( priority ), __VA_ARGS__ ) |
Adds a message to the current target with the specified priority.
This function will be removed at compile time if STUMPLESS_DISABLE_WARNING_LEVEL has been defined during build. If it is disabled, then this function is removed at compile time and will have no effect. Otherwise, it is equivalent to a call to stumplog with the provided priority and message.
Note that if this function is disabled, then the arguments will not be evaluated, meaning that any side effects will not happen. Be sure that any side effects you rely on will not cause problems if they are left out during a build with warning level calls disabled.
The message must be a valid format specifier string provided along with the appropriate number of variable arguments afterwards. This means that it should not be a user-controlled value under any circumstances. If you need a safer alternative without the risks of format strings, use stumplog_w_str instead.
Thread Safety: MT-Safe env locale This function is thread safe. Different target types handle thread safety differently, as some require per-target locks and others can rely on system libraries to log safely, but all targets support thread safe logging in some manner. For target-specific information on how thread safety is supported and whether AS or AC safety can be assumed, refer to the documentation for the target's header file (in the stumpless/target
include folder).
Async Signal Safety: AS-Unsafe lock heap This function is not safe to call from signal handlers as some targets make use of non-reentrant locks to coordinate access. It also may make memory allocation calls to create internal cached structures, and memory allocation may not be signal safe.
Async Cancel Safety: AC-Unsafe lock heap This function is not safe to call from threads that may be asynchronously cancelled, due to the use of locks in some targets that could be left locked and the potential for memory allocation.
priority | The priority of the message - this should be the bitwise or of a single STUMPLESS_SEVERITY and single STUMPLESS_FACILITY value. |
... | The message to log, optionally along with the values for any format specifiers valid in printf . This must be a valid UTF-8 string in shortest form. |
#define stumplog_w_str | ( | priority, | |
message ) stumplog_str( ( priority ), ( message ) ) |
Adds a message to the current target with the specified priority.
This function will be removed at compile time if STUMPLESS_DISABLE_WARNING_LEVEL has been defined during build. If it is disabled, then this function is removed at compile time and will have no effect. Otherwise, it is equivalent to a call to stumplog_str with the provided message and calculated priority.
Note that if this function is disabled, then the arguments will not be evaluated, meaning that any side effects will not happen. Be sure that any side effects you rely on will not cause problems if they are left out during a build with warning level calls disabled.
Thread Safety: MT-Safe env locale This function is thread safe. Different target types handle thread safety differently, as some require per-target locks and others can rely on system libraries to log safely, but all targets support thread safe logging in some manner. For target-specific information on how thread safety is supported and whether AS or AC safety can be assumed, refer to the documentation for the target's header file (in the stumpless/target
include folder).
Async Signal Safety: AS-Unsafe lock heap This function is not safe to call from signal handlers as some targets make use of non-reentrant locks to coordinate access. It also may make memory allocation calls to create internal cached structures, and memory allocation may not be signal safe.
Async Cancel Safety: AC-Unsafe lock heap This function is not safe to call from threads that may be asynchronously cancelled, due to the use of locks in some targets that could be left locked and the potential for memory allocation.
priority | The priority of the message - this should be the bitwise or of a single STUMPLESS_SEVERITY and single STUMPLESS_FACILITY value. |
message | The message to log. This must be a valid UTF-8 string in shortest form. |