Sawyer::Message::FileSink Class Reference

Description

Send free-format messages to a C FILE pointer.

Definition at line 1307 of file Message.h.

#include <Sawyer/Message.h>

Inheritance diagram for Sawyer::Message::FileSink:

Collaboration diagram for Sawyer::Message::FileSink:

Public Member Functions
virtual void	post (const Mesg &, const MesgProps &)
	Causes a message to be emitted.
Public Member Functions inherited from Sawyer::Message::UnformattedSink
virtual std::string	maybeTerminatePrior (const Mesg &, const MesgProps &)
	Support function for emitting a message.
virtual std::string	maybePrefix (const Mesg &, const MesgProps &)
	Support function for emitting a message.
virtual std::string	maybeBody (const Mesg &, const MesgProps &)
	Support function for emitting a message.
virtual std::string	maybeFinal (const Mesg &, const MesgProps &)
	Support function for emitting a message.
virtual std::string	render (const Mesg &, const MesgProps &)
	Support function for emitting a message.
GangPtr	gang () const
	Property: sink gang.
UnformattedSinkPtr	gang (const GangPtr &g)
	Property: sink gang.
bool	partialMessagesAllowed () const
	Property: allow partial message output.
UnformattedSinkPtr	partialMessagesAllowed (bool)
	Property: allow partial message output.
PrefixPtr	prefix () const
	Property: how to generate message prefixes.
UnformattedSinkPtr	prefix (const PrefixPtr &p)
	Property: how to generate message prefixes.
Public Member Functions inherited from Sawyer::Message::Destination
virtual void	bakeDestinations (const MesgProps &, BakedDestinations &baked)
	Bakes message properties according to the plumbing lattice.
MesgProps	mergePropertiesNS (const MesgProps &props)
	Merge properties of this lattice node into the specified properties.
const MesgProps &	defaultPropertiesNS () const
	Default values for message properties.
MesgProps &	defaultPropertiesNS ()
	Default values for message properties.
const MesgProps &	overridePropertiesNS () const
	Overrides message properties.
MesgProps &	overridePropertiesNS ()
	Overrides message properties.
Public Member Functions inherited from Sawyer::SharedObject
	SharedObject ()
	Default constructor.
	SharedObject (const SharedObject &)
	Copy constructor.
virtual	~SharedObject ()
	Virtual destructor.
SharedObject &	operator= (const SharedObject &)
	Assignment.
Public Member Functions inherited from Sawyer::SharedFromThis< Destination >
SharedPointer< Destination >	sharedFromThis ()
	Create a shared pointer from this.
SharedPointer< const Destination >	sharedFromThis () const
	Create a shared pointer from this.

Static Public Member Functions
static FileSinkPtr	instance (FILE *f, const PrefixPtr &prefix=PrefixPtr())
	Allocating constructor.

Protected Member Functions
	FileSink (FILE *f, const PrefixPtr &prefix)
	Constructor for derived classes.
Protected Member Functions inherited from Sawyer::Message::UnformattedSink
	UnformattedSink (const PrefixPtr &prefix)
	Constructor for derived classes.
void	gangInternal (const GangPtr &g)
	Cause this sink to be coordinated with others.

Additional Inherited Members
Protected Attributes inherited from Sawyer::Message::UnformattedSink
bool	partialMessagesAllowed_
Protected Attributes inherited from Sawyer::Message::Destination
Sawyer::SynchronizationTraits< Sawyer::SingleThreadedTag >::RecursiveMutex	mutex_
	Mutex protecting data members here and in subclasses.
MesgProps	dflts_
	Default properties merged into each incoming message.
MesgProps	overrides_
	Override properties applied to incoming message.

Constructor & Destructor Documentation

FileSink()

Sawyer::Message::FileSink::FileSink ( FILE *  f, const PrefixPtr &  prefix  )

inlineprotected

Constructor for derived classes.

Non-subclass users should use instance instead.

Definition at line 1311 of file Message.h.

Member Function Documentation

instance()

static FileSinkPtr Sawyer::Message::FileSink::instance ( FILE *  f, const PrefixPtr &  prefix = PrefixPtr()  )

inlinestatic

Allocating constructor.

Constructs a new message sink that sends messages to the specified C FILE pointer.

Definition at line 1314 of file Message.h.

post()

virtual void Sawyer::Message::FileSink::post ( const Mesg &  , const MesgProps &  bakedProperties  )

virtual

Causes a message to be emitted.

The bakedProperties argument is one of the values returned by the bakeDestinations method.

Implements Sawyer::Message::Destination.

---

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

• Message.h