Cpl::Logging::LogSink Class Reference

This class is responsible for consuming the application's Log buffer and 'dispatching' log entries. More...

Detailed Description

This class is responsible for consuming the application's Log buffer and 'dispatching' log entries.

By default, the class simply drains the log buffer and discards the entries. A child class is required to provide a meaningful implementation of the dispatchLogEntry() method.

FYI: The Cpl::Persistent framework provides an alternate 'log sink' that writes log entries to Non-volatile storage along with an a API to retrieve the log entries.

#include <LogSink.h>

Inheritance diagram for Cpl::Logging::LogSink:

Collaboration diagram for Cpl::Logging::LogSink:

Public Member Functions
	LogSink (Cpl::Dm::MailboxServer &myMbox, Cpl::Container::RingBufferMP< Cpl::Logging::EntryData_T > &incomingEntriesBuffer) noexcept
	Constructor.
void	request (OpenMsg &msg)
	This method starts the sink (See Cpl::Itc::OpenSync)
void	request (CloseMsg &msg)
	This method stops the sink (See Cpl::Itc::CloseSync)
Public Member Functions inherited from Cpl::Itc::CloseSync
	CloseSync (PostApi &myMbox) noexcept
	Constructor.
bool	close (void *args=nullptr)
	See CloseSync.
Public Member Functions inherited from Cpl::Itc::OpenSync
	OpenSync (PostApi &myMbox) noexcept
	Constructor.
bool	open (void *args=nullptr)
	See OpenApi.
Public Member Functions inherited from Cpl::Itc::OpenApi
virtual	~OpenApi ()
	Virtual destructor.
Public Member Functions inherited from Cpl::Itc::CloseApi
virtual	~CloseApi ()
	Virtual destructor.

Protected Member Functions
void	elementCountChanged (Cpl::Dm::Mp::Uint32 &mp, Cpl::Dm::SubscriberApi &clientObserver) noexcept
	Element Count Change notification.
virtual void	dispatchLogEntry (Cpl::Logging::EntryData_T &src)
	Platform specific method to save the entry.

Protected Attributes
Cpl::Dm::SubscriberComposer< LogSink, Cpl::Dm::Mp::Uint32 >	m_observerElementCount
	Observer for change notification (to the RingBuffer)
Cpl::Container::RingBufferMP< Cpl::Logging::EntryData_T > &	m_logBuffer
	The Log Ring Buffer.
bool	m_opened
	Track my open state.
Protected Attributes inherited from Cpl::Itc::OpenSync
PostApi &	m_mbox
	Mailbox (of the server implementing the ITC request() method.

Additional Inherited Members
Public Types inherited from Cpl::Itc::OpenRequest
typedef Cpl::Itc::SAP< OpenRequest >	SAP
	SAP for this API.
typedef RequestMessage< OpenRequest, OpenPayload >	OpenMsg
	Message Type: Open.
Public Types inherited from Cpl::Itc::CloseRequest
typedef Cpl::Itc::SAP< CloseRequest >	SAP
	SAP for this API.
typedef RequestMessage< CloseRequest, ClosePayload >	CloseMsg
	Message Type: Close.

Constructor & Destructor Documentation

LogSink()

Cpl::Logging::LogSink::LogSink ( Cpl::Dm::MailboxServer &  myMbox, Cpl::Container::RingBufferMP< Cpl::Logging::EntryData_T > &  incomingEntriesBuffer  )

noexcept

Constructor.

Member Function Documentation

dispatchLogEntry()

virtual void Cpl::Logging::LogSink::dispatchLogEntry ( Cpl::Logging::EntryData_T &  src )

inlineprotectedvirtual

Platform specific method to save the entry.

elementCountChanged()

void Cpl::Logging::LogSink::elementCountChanged ( Cpl::Dm::Mp::Uint32 &  mp, Cpl::Dm::SubscriberApi &  clientObserver  )

protectednoexcept

Element Count Change notification.

request() [1/2]

void Cpl::Logging::LogSink::request ( CloseMsg &  msg )

virtual

This method stops the sink (See Cpl::Itc::CloseSync)

Implements Cpl::Itc::CloseRequest.

request() [2/2]

void Cpl::Logging::LogSink::request ( OpenMsg &  msg )

virtual

This method starts the sink (See Cpl::Itc::OpenSync)

Implements Cpl::Itc::OpenRequest.

Member Data Documentation

m_logBuffer

Cpl::Container::RingBufferMP<Cpl::Logging::EntryData_T>& Cpl::Logging::LogSink::m_logBuffer

protected

The Log Ring Buffer.

m_observerElementCount

Cpl::Dm::SubscriberComposer<LogSink, Cpl::Dm::Mp::Uint32> Cpl::Logging::LogSink::m_observerElementCount

protected

Observer for change notification (to the RingBuffer)

m_opened

bool Cpl::Logging::LogSink::m_opened

protected

Track my open state.

---

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

• Cpl/Logging/LogSink.h