#include <Appender.hpp>
Public Member Functions | |
| Appender (std::string name) | |
| virtual bool | configureLayout () |
| virtual void | drainBuffer () |
| virtual bool | startHook () |
| ensure port is connected before we start | |
| virtual void | stopHook () |
| Drain the buffer. | |
| virtual | ~Appender () |
Protected Member Functions | |
| virtual void | processEvents (int n) |
Protected Attributes | |
| log4cpp::Appender * | appender |
| Appender created by derived class. | |
| unsigned int | countMaxPopped |
| RTT::Property< std::string > | layoutName_prop |
| Layout name (e.g. "simple", "basic", "pattern") | |
| RTT::Property< std::string > | layoutPattern_prop |
| Layout conversion pattern (for those layouts that use a pattern) | |
| RTT::InputPort < OCL::logging::LoggingEvent > | log_port |
Detailed Description
Definition at line 16 of file Appender.hpp.
Constructor & Destructor Documentation
| OCL::logging::Appender::Appender | ( | std::string | name | ) |
Definition at line 12 of file Appender.cpp.
| OCL::logging::Appender::~Appender | ( | ) | [virtual] |
Definition at line 25 of file Appender.cpp.
Member Function Documentation
| bool OCL::logging::Appender::configureLayout | ( | ) | [virtual] |
Optionally create a layout according to layoutName and layoutPattern.
- Precondition:
- !appender, if you want a layout to actually be created
- Returns:
- true if not layout or no appender or a layout was created successfully, otherwise false
- Todo:
- ensure "" != layoutPattern?
Definition at line 29 of file Appender.cpp.
| void OCL::logging::Appender::drainBuffer | ( | ) | [virtual] |
Process all remaining events in buffer
Definition at line 99 of file Appender.cpp.
| void OCL::logging::Appender::processEvents | ( | int | n | ) | [protected, virtual] |
Process up n events
- Parameters:
-
n if 0 ==n then process events until buffer is empty, otherwise process at most n events
- Precondition:
- 0 <= n (otherwise acts as though n==1)
Definition at line 104 of file Appender.cpp.
| bool OCL::logging::Appender::startHook | ( | ) | [virtual] |
ensure port is connected before we start
- Todo:
- input ports must be connected?
Reimplemented from RTT::base::TaskCore.
Definition at line 69 of file Appender.cpp.
| void OCL::logging::Appender::stopHook | ( | ) | [virtual] |
Drain the buffer.
Reimplemented from RTT::base::TaskCore.
Definition at line 77 of file Appender.cpp.
Member Data Documentation
log4cpp::Appender* OCL::logging::Appender::appender [protected] |
Appender created by derived class.
Definition at line 50 of file Appender.hpp.
unsigned int OCL::logging::Appender::countMaxPopped [protected] |
Definition at line 59 of file Appender.hpp.
RTT::Property<std::string> OCL::logging::Appender::layoutName_prop [protected] |
Layout name (e.g. "simple", "basic", "pattern")
Definition at line 54 of file Appender.hpp.
RTT::Property<std::string> OCL::logging::Appender::layoutPattern_prop [protected] |
Layout conversion pattern (for those layouts that use a pattern)
Definition at line 56 of file Appender.hpp.
Port we receive logging events on Initially unconnected. The logging service connects appenders.
Definition at line 47 of file Appender.hpp.
The documentation for this class was generated from the following files: