Activity monitor object that dumps communication into a syslog. More...

Inheritance diagram for MMonitorSyslog:

Public Member Functions
	MMonitorSyslog (const MStdString &prefix="MCOM", int verbose=4)
	Constructor that creates a monitor with the given message prefix. More...

virtual	~MMonitorSyslog ()
	Object destructor. More...

virtual void	Attach (const MStdString &clientIdentitfication)
	Tell that the application is starting a sequence of events that it would like to monitor, attach by attempting to open the file. More...

virtual void	OnMessage (MessageType code, const char *message, int length)
	Send text message with the specified code. More...

Public Member Functions inherited from MMonitor
	MMonitor ()
	Object constructor.

virtual	~MMonitor ()
	Object destructor.

bool	IsListening () const
	Whether the monitor is interested in any events.

virtual void	Detach ()
	Detach from the monitor, if attached previously. More...

virtual void	Write (const MStdString &str)
	Write the user message to the monitor. More...

virtual void	OnConnect ()
	Notify that the channel has just connected.

virtual void	OnDisconnect ()
	Notify that the channel is disconnected.

virtual void	OnDataLinkLayerSuccess ()
	Notifies that the data link layer operation succeeded. More...

virtual void	OnDataLinkLayerInformation (const MStdString &msg)
	Notifies about any neutral or positive information during the data link layer operations. More...

virtual void	OnDataLinkLayerRetry (const MStdString &reason)
	Notifies that the last data link layer operation failed and will be repeated. More...

virtual void	OnDataLinkLayerFail (const MStdString &msg)
	Notifies that the last data link layer operation failed and no other action will be performed. More...

virtual void	OnApplicationLayerRetry (const MStdString &reason)
	Notifies that the last application layer operation failed and will be repeated. More...

virtual void	OnApplicationLayerFail (const MStdString &service)
	Notifies that the last application layer operation failed and no other action will be performed. More...

virtual void	OnApplicationLayerStart (const MStdString &service)
	Notifies that the application layer operation started. More...

virtual void	OnApplicationLayerSuccess (const MStdString &service)
	Notifies that the last application layer operation succeeded. More...

virtual void	OnEnterUninterruptibleCommunication ()
	Notifies that the uninterruptible communication sequence is entered. More...

virtual void	OnLeaveUninterruptibleCommunication ()
	Notifies that the uninterruptible communication sequence is left. More...

virtual void	OnByteRX (const char *data, int length)

void	OnBytesReceived (const MByteString &data)

virtual void	OnByteTX (const char *data, int length)

void	OnBytesSent (const MByteString &data)

MObject *	GetClient () const

void	SetClient (MObject *client)

Public Member Functions inherited from MObject
virtual	~MObject ()
	Object destructor.

virtual const MClass *	GetClass () const =0
	Get the final class of the object. More...

virtual unsigned	GetEmbeddedSizeof () const
	For embedded object types, return the size of the class. More...

bool	IsEmbeddedObject () const
	Tell if the object is of embedded kind. More...

SHOW_INTERNAL MVariant	Call (const MStdString &name, const MVariant &params)
	Call the object service with parameters, given as variant. More...

MVariant	Call0 (const MStdString &name)
	Call the object service with no parameters. More...

MVariant	Call1 (const MStdString &name, const MVariant &p1)
	Call the object service with one parameter. More...

MVariant	Call2 (const MStdString &name, const MVariant &p1, const MVariant &p2)
	Call the object service with two parameter. More...

MVariant	Call3 (const MStdString &name, const MVariant &p1, const MVariant &p2, const MVariant &p3)
	Call the object service with three parameter. More...

MVariant	Call4 (const MStdString &name, const MVariant &p1, const MVariant &p2, const MVariant &p3, const MVariant &p4)
	Call the object service with four parameter. More...

MVariant	Call5 (const MStdString &name, const MVariant &p1, const MVariant &p2, const MVariant &p3, const MVariant &p4, const MVariant &p5)
	Call the object service with five parameter. More...

MVariant	Call6 (const MStdString &name, const MVariant &p1, const MVariant &p2, const MVariant &p3, const MVariant &p4, const MVariant &p5, const MVariant &p6)
	Call the object service with six parameter. More...

virtual MVariant	CallV (const MStdString &name, const MVariant::VariantVector &params)
	Call the object service with parameters, given as variant vector. More...

virtual bool	IsPropertyPresent (const MStdString &name) const
	Tell if the property with the given name exists.

virtual bool	IsServicePresent (const MStdString &name) const
	Tell if the service with the given name exists.

virtual MVariant	GetProperty (const MStdString &name) const
	Get the property value using name of the property. More...

virtual void	SetProperty (const MStdString &name, const MVariant &value)
	Set the property using name of the property, and value. More...

virtual MStdStringVector	GetAllPropertyNames () const
	Return the list of publicly available properties, persistent or not. More...

virtual MStdStringVector	GetAllPersistentPropertyNames () const
	Return the list of persistent properties. More...

virtual void	SetPersistentPropertiesToDefault ()
	Set the persistent properties of the object to their default values. More...

virtual MVariant	GetPersistentPropertyDefaultValue (const MStdString &name) const
	Get the default value of persistent property with the name given. More...

virtual void	SetPersistentPropertyToDefault (const MStdString &name)
	Set the persistent property with the name given to default value. More...

virtual const char *	GetType () const
	Get the name of the type for the object (could be the same as class name).

virtual void	SetType (const MStdString &)
	Intentionally, it will set the name of the type for the object, but the service will not allow setting the name to anything other than the current name. More...

virtual void	Validate ()
	Validate internal structures of the object. More...

Additional Inherited Members
Public Types inherited from MMonitor
enum	MessageType { MessageChannelAttach = 0x20, MessageChannelConnect = 0x21, MessageChannelDisconnect = 0x22, MessageChannelByteRx = 0x23, MessageChannelByteTx = 0x24, MessageProtocolLinkLayerInformation = 0x35, MessageProtocolLinkLayerRetry = 0x37, MessageProtocolLinkLayerFail = 0x39, MessageProtocolApplicationLayerStart = 0x3B, MessageProtocolApplicationLayerRetry = 0x3D, MessageProtocolApplicationLayerSuccess = 0x3F, MessageProtocolApplicationLayerFail = 0x41, MessageProtocolSynchronize = 0x43, MessageUser = 0x60 }
	Enumeration that defines supported monitor messages, and whether the parameters are expected. More...

Static Public Member Functions inherited from MObject
static const MClass *	GetStaticClass ()
	Get the declared class of this particular object. More...

static bool	IsClassPresent (const MStdString &name)
	Tells if the given class name is available. More...

Public Attributes inherited from MMonitor
SHOW_INTERNAL typedef SharedPointer	Pointer
	Pointer type that clients should use to access to monitor.

Static Public Attributes inherited from MObject
static const MClass	s_class
	Class of MObject.

Protected Member Functions inherited from MMonitor
void	OnMessageWithText (MessageType code, const MStdString &text)
	Send text message with the specified code. More...

Protected Member Functions inherited from MObject
	MObject ()
	Object constructor, protected as the class is abstract.

void	DoSetPersistentPropertiesToDefault (const MClass *staticClass)
	Set the persistent properties to their default values for one object provided the class for that object. More...

Detailed Description

Activity monitor object that dumps communication into a syslog.

This implementation of monitor is for UNIX-like operation systems. It is possible to enable it for Windows as well using a third party syslog library.

Sharing of monitors among simultaneously communicating channels can produce obscure output or lead to synchronization errors, therefore, each channel should have its own monitor object. The monitor is registered with the client channel object using the service MChannel::SetMonitor.

Note that when M_NO_MCOM_MONITOR_SHARED_POINTER=0 the monitor object should be created on a heap with operator new, and handled through the pointer type MMonitor::Pointer. The deletion of such object will be done through the stared pointer. When M_NO_MCOM_MONITOR_SHARED_POINTER=1 the user will be responsible for deletion of the object, however the monitor object should outlive the channel that it monitors.

Constructor & Destructor Documentation

MMonitorSyslog::MMonitorSyslog	(	const MStdString &	prefix = `"MCOM"`,
		int	verbose = `4`
	)

Constructor that creates a monitor with the given message prefix.

Parameters

prefix	Log prefix, MCOM by default.
verbose	Log level, 4 by default.

Precondition: The object should be created on a heap with operator new, and handled with a shared pointer, otherwise the behavior is undefined. File, if given, shall be a valid directory or a file name, but the check is deferred to the attaching time.

virtual MMonitorSyslog::~MMonitorSyslog ( )

virtual

Object destructor.

The children of this class shall call DoFinish in their destructors.

Member Function Documentation

virtual void MMonitorSyslog::Attach ( const MStdString & clientIdentitfication )

virtual

Tell that the application is starting a sequence of events that it would like to monitor, attach by attempting to open the file.

The action is not immediate, and some time might pass before the file is open.

Client identification is a string that somehow tells about the client. Like for the channel based on COM port, this would be the com port name, and for the socket it will be the address and the port.

Reimplemented from MMonitor.

virtual void MMonitorSyslog::OnMessage	(	MessageType	code,
		const char *	message,
		int	length
	)

virtual

Send text message with the specified code.

Precondition: Code is valid and message has a valid format.

Reimplemented from MMonitor.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation