shibsp::TransactionLog Class Reference

Interface to a synchronized event/audit logging object. More...

#include <shibsp/TransactionLog.h>

List of all members.

Classes

class  Event
 Callback interface that outputs an event record to a stream using formatting tokens. More...

Public Member Functions

 TransactionLog (const char *fmt=nullptr, const char *absent=nullptr)
 Constructor.
xmltooling::Lockable * lock ()
void unlock ()
virtual void write (const Event &e)
 Write a formatted event record to the log.

Public Attributes

xmltooling::logging::Category & log

Detailed Description

Interface to a synchronized event/audit logging object.

For backward compatibility, we expose a logging object directly, but new applications should rely on the Event callback API.


Constructor & Destructor Documentation

shibsp::TransactionLog::TransactionLog ( const char *  fmt = nullptr,
const char *  absent = nullptr 
)

Constructor.

Parameters:
fmt formatting string for events
absent string to output when a field is empty

Member Function Documentation

virtual void shibsp::TransactionLog::write ( const Event e  )  [virtual]

Write a formatted event record to the log.

This method is internally synchronized and the caller does NOT need to explicitly lock and unlock the object.

Parameters:
e event to log

Member Data Documentation

xmltooling::logging::Category& shibsp::TransactionLog::log
Deprecated:
Logging object.

The documentation for this class was generated from the following file:

Generated on 15 Nov 2017 for shibboleth-2.6.1 by  doxygen 1.6.1