Robot Raconteur Core C++ Library
Loading...
Searching...
No Matches
RobotRaconteur::MessageTap Class Referenceabstract

Base class for message taps. More...

#include <Tap.h>

Inheritance diagram for RobotRaconteur::MessageTap:
RobotRaconteur::LocalMessageTap

Public Member Functions

virtual void Open ()=0
 Open the tap for writing.
virtual void Close ()=0
 Close the tap.
virtual void RecordLogRecord (const RRLogRecord &log_record)=0
 Record a log record.
virtual void RecordMessage (const boost::intrusive_ptr< Message > &message)=0
 Record a message.

Detailed Description

Base class for message taps.

Taps are used to save messages and log records that pass through a node. The saved messages and logs can be analyzed and replayed for visualization, diagnostics, and analysis.

Message taps are configured using RobotRaconteurNodeSetup command line options (recommended), or by registering the tap using RobotRaconteurNode::SetMessageTap().

See Taps for more information on taps.

Member Function Documentation

◆ RecordLogRecord()

virtual void RobotRaconteur::MessageTap::RecordLogRecord ( const RRLogRecord & log_record)
pure virtual

Record a log record.

Parameters
log_record

Implemented in RobotRaconteur::LocalMessageTap.

◆ RecordMessage()

virtual void RobotRaconteur::MessageTap::RecordMessage ( const boost::intrusive_ptr< Message > & message)
pure virtual

Record a message.

Parameters
message

Implemented in RobotRaconteur::LocalMessageTap.


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