ADTF  3.18.3
ILoggingabstract

The Remote logging interface. More...

Public Member Functions

 ADTF_IID (ILogging, "logging.ant.remote.adtf")
 RPC IID of the Clock.
 
virtual size_t CreateLogBuffer (tTimeStamp nTimeout)=0
 Creates a new log buffer. More...
 
virtual tResult ReleaseLogBuffer (size_t nBufferID)=0
 Releases a log buffer. More...
 
virtual const char * GetBufferContent (size_t nBufferID)=0
 Returns the content of a log buffer. More...
 

Static Public Attributes

static constexpr const tChar *const DEFAULT_NAME = "logging"
 Default rpc object server name within an ADTF system.
 

Detailed Description

The Remote logging interface.

See also
cADTFRemoteSystem, adtf::services::ant::ILogging.

Definition at line 23 of file adtf_remote_logging_intf.h.

Member Function Documentation

◆ CreateLogBuffer()

virtual size_t CreateLogBuffer ( tTimeStamp  nTimeout)
pure virtual

Creates a new log buffer.

Parameters
[in]nTimeoutIf the buffer is not retrieved within this timeout, then the buffer is destroyed.
Returns
The buffer ID.

◆ GetBufferContent()

virtual const char* GetBufferContent ( size_t  nBufferID)
pure virtual

Returns the content of a log buffer.

Parameters
[in]nBufferIDThe buffer ID.
Returns
The content, use parse_logging_rpc_buffer to parse the returned string.

◆ ReleaseLogBuffer()

virtual tResult ReleaseLogBuffer ( size_t  nBufferID)
pure virtual

Releases a log buffer.

Parameters
[in]nBufferIDThe buffer ID.
Returns
Standard result.