RobotRaconteur::LocalMessageTap Class Reference

Local message tap. More...

#include <Tap.h>

Inheritance diagram for RobotRaconteur::LocalMessageTap:

Public Member Functions
	LocalMessageTap (const std::string &tap_name)
	Construct a new local tap.
RR_OVIRTUAL void	Open () RR_OVERRIDE
	Open the tap for writing.
RR_OVIRTUAL void	Close () RR_OVERRIDE
	Close the tap.
RR_OVIRTUAL void	RecordLogRecord (const RRLogRecord &log_record) RR_OVERRIDE
	Record a log record.
RR_OVIRTUAL void	RecordMessage (const boost::intrusive_ptr< Message > &message) RR_OVERRIDE
	Record a message.

Detailed Description

Local message tap.

The LocalMessageTap works by creating a UNIX domain socket in an operating system dependant directory, and writes messages to the socket. Log records are encoded as messages and sent interleaved with messages from the transport. UTC timestamps are added to the MetaData header field of the message.

It is recommended that RobotRaconteurNodeSetup command line options be used to configure the local tap. See Command Line Options.

See Taps for more information on taps.

Constructor & Destructor Documentation

LocalMessageTap()

RobotRaconteur::LocalMessageTap::LocalMessageTap

(

const std::string &

tap_name

)

Construct a new local tap.

Must use boost::make_shared<LocalMessageTap>()

Parameters

tap_name

The name of the local tap

Member Function Documentation

RecordLogRecord()

RR_OVIRTUAL void RobotRaconteur::LocalMessageTap::RecordLogRecord ( const RRLogRecord & log_record )

virtual

Record a log record.

Parameters

log_record

Implements RobotRaconteur::MessageTap.

RecordMessage()

RR_OVIRTUAL void RobotRaconteur::LocalMessageTap::RecordMessage ( const boost::intrusive_ptr< Message > & message )

virtual

Record a message.

Parameters

message

Implements RobotRaconteur::MessageTap.

---

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

• /builddir/build/BUILD/robotraconteur-1.2.8-build/RobotRaconteur-1.2.8-Source/RobotRaconteurCore/include/RobotRaconteur/Tap.h