vmessage.h File Reference

#include "vtypes.h"
#include "vstring.h"
#include "vbinaryiostream.h"
#include "vmemorystream.h"

Go to the source code of this file.

Classes
class	VMessage
	VMessage is an abstract base class that implements the basic messaging capabilities; the concrete subclass must implement the send() and receive() functions, which know how to read and write the particular message protocol format (the wire protocol). More...
class	VMessageFactory
	VMessageFactory is an abstract base class that you must implement for purposes of giving an input thread a way to instantiate the correct concrete type of message. More...
Defines
#define	VLOGGER_MESSAGE_LEVEL(level, message)   VLOGGER_NAMED_LEVEL(VMessage::kMessageLoggerName, level, message)
	Emits a message at specified level to the message logger; use the level constants defined in VMessage.
#define	VLOGGER_MESSAGE_FATAL(message)   VLOGGER_NAMED_FATAL(VMessage::kMessageLoggerName, message)
	Emits a message at kFatal level to the message logger.
#define	VLOGGER_MESSAGE_ERROR(message)   VLOGGER_NAMED_ERROR(VMessage::kMessageLoggerName, message)
	Emits a message at kError level to the message logger.
#define	VLOGGER_MESSAGE_WARN(message)   VLOGGER_NAMED_WARN(VMessage::kMessageLoggerName, message)
	Emits a message at kWarn level to the message logger.
#define	VLOGGER_MESSAGE_INFO(message)   VLOGGER_NAMED_INFO(VMessage::kMessageLoggerName, message)
	Emits a message at kInfo level to the message logger.
#define	VLOGGER_MESSAGE_DEBUG(message)   VLOGGER_NAMED_DEBUG(VMessage::kMessageLoggerName, message)
	Emits a message at kDebug level to the message logger.
#define	VLOGGER_MESSAGE_TRACE(message)   VLOGGER_NAMED_TRACE(VMessage::kMessageLoggerName, message)
	Emits a message at kTrace level to the message logger.
#define	VLOGGER_MESSAGE_HEXDUMP(message, buffer, length)   VLOGGER_NAMED_HEXDUMP(VMessage::kMessageLoggerName, VMessage::kMessageContentHexDumpLevel, message, buffer, length)
	Emits a hex dump at a specified level to the specified logger.
#define	VLOGGER_MESSAGE_WOULD_LOG(level)   VLOGGER_NAMED_WOULD_LOG(VMessage::kMessageLoggerName, level)
	Returns true if the message logger would emit at the specified level.
Typedefs
typedef Vs32	VMessageLength
	The length of a message. Meaning and format on the wire are determined by actual message protocol.
typedef int	VMessageID
	Message identifier (verb) to distinguish it from other messages in the protocol.
typedef VSharedPtr< VMessage >	VMessagePtr
typedef VSharedPtr< const VMessage >	VMessageConstPtr

---

Detailed Description

Definition in file vmessage.h.

---

Define Documentation

#define VLOGGER_MESSAGE_LEVEL	(		level,
			message
	)		VLOGGER_NAMED_LEVEL(VMessage::kMessageLoggerName, level, message)

Emits a message at specified level to the message logger; use the level constants defined in VMessage.

Definition at line 28 of file vmessage.h.

#define VLOGGER_MESSAGE_FATAL

(

message

)

VLOGGER_NAMED_FATAL(VMessage::kMessageLoggerName, message)

Emits a message at kFatal level to the message logger.

Definition at line 30 of file vmessage.h.

#define VLOGGER_MESSAGE_ERROR

(

message

)

VLOGGER_NAMED_ERROR(VMessage::kMessageLoggerName, message)

Emits a message at kError level to the message logger.

Definition at line 32 of file vmessage.h.

#define VLOGGER_MESSAGE_WARN

(

message

)

VLOGGER_NAMED_WARN(VMessage::kMessageLoggerName, message)

Emits a message at kWarn level to the message logger.

Definition at line 34 of file vmessage.h.

#define VLOGGER_MESSAGE_INFO

(

message

)

VLOGGER_NAMED_INFO(VMessage::kMessageLoggerName, message)

Emits a message at kInfo level to the message logger.

Definition at line 36 of file vmessage.h.

#define VLOGGER_MESSAGE_DEBUG

(

message

)

VLOGGER_NAMED_DEBUG(VMessage::kMessageLoggerName, message)

Emits a message at kDebug level to the message logger.

Definition at line 38 of file vmessage.h.

#define VLOGGER_MESSAGE_TRACE

(

message

)

VLOGGER_NAMED_TRACE(VMessage::kMessageLoggerName, message)

Emits a message at kTrace level to the message logger.

Definition at line 40 of file vmessage.h.

#define VLOGGER_MESSAGE_HEXDUMP	(		message,
			buffer,
			length
	)		VLOGGER_NAMED_HEXDUMP(VMessage::kMessageLoggerName, VMessage::kMessageContentHexDumpLevel, message, buffer, length)

Emits a hex dump at a specified level to the specified logger.

Definition at line 42 of file vmessage.h.

#define VLOGGER_MESSAGE_WOULD_LOG

(

level

)

VLOGGER_NAMED_WOULD_LOG(VMessage::kMessageLoggerName, level)

Returns true if the message logger would emit at the specified level.

Definition at line 44 of file vmessage.h.