ACE 8.0.1
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Private Attributes | List of all members
ACE_Log_Msg_IPC Class Reference

Defines the interfaces for ACE_Log_Msg backend. More...

#include <Log_Msg_IPC.h>

Inheritance diagram for ACE_Log_Msg_IPC:
Inheritance graph
[legend]
Collaboration diagram for ACE_Log_Msg_IPC:
Collaboration graph
[legend]

Public Member Functions

 ACE_Log_Msg_IPC ()=default
 Constructor.
 
 ~ACE_Log_Msg_IPC () override
 Destructor.
 
int open (const ACE_TCHAR *logger_key) override
 Open a new connection.
 
int reset () override
 
int close () override
 Close the backend completely.
 
ssize_t log (ACE_Log_Record &log_record) override
 
- Public Member Functions inherited from ACE_Log_Msg_Backend
virtual ~ACE_Log_Msg_Backend ()=default
 No-op virtual destructor.
 

Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 

Private Attributes

ACE_LOG_MSG_IPC_STREAM message_queue_
 

Detailed Description

Defines the interfaces for ACE_Log_Msg backend.

Implement an ACE_Log_Msg_Backend that logs to a remote logging process.

Constructor & Destructor Documentation

◆ ACE_Log_Msg_IPC()

ACE_Log_Msg_IPC::ACE_Log_Msg_IPC ( )
default

Constructor.

◆ ~ACE_Log_Msg_IPC()

ACE_Log_Msg_IPC::~ACE_Log_Msg_IPC ( )
override

Destructor.

Member Function Documentation

◆ close()

int ACE_Log_Msg_IPC::close ( )
overridevirtual

Close the backend completely.

Implements ACE_Log_Msg_Backend.

◆ log()

ssize_t ACE_Log_Msg_IPC::log ( ACE_Log_Record & log_record)
overridevirtual

Process a log record.

Parameters
log_recordThe ACE_Log_Record to process.
Return values
-1for failure; else it is customarily the number of bytes processed, but can also be 0 to signify success.

Implements ACE_Log_Msg_Backend.

◆ open()

int ACE_Log_Msg_IPC::open ( const ACE_TCHAR * logger_key)
overridevirtual

Open a new connection.

Implements ACE_Log_Msg_Backend.

◆ reset()

int ACE_Log_Msg_IPC::reset ( )
overridevirtual

Reset the backend. When changing the logging destination the backend may need to properly disconnect from the remote logging daemon and reclaim some local resources. But we try to reduce the number of local allocations/deallocations.

Implements ACE_Log_Msg_Backend.

Member Data Documentation

◆ ACE_ALLOC_HOOK_DECLARE

ACE_Log_Msg_IPC::ACE_ALLOC_HOOK_DECLARE

◆ message_queue_

ACE_LOG_MSG_IPC_STREAM ACE_Log_Msg_IPC::message_queue_
private

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