BaseMessage Class Reference

BaseMessage is an abstract class defining the operations shared in common by Message and ScatterMessage. More...

#include <BaseMessage.h>

Inheritance diagram for BaseMessage:

Public Types
enum	Service {   Unreliable = UNRELIABLE_MESS, Reliable = RELIABLE_MESS, FIFO = FIFO_MESS, Causal = CAUSAL_MESS,   Agreed = AGREED_MESS, Safe = SAFE_MESS, SelfDiscard = SELF_DISCARD, DropReceive = DROP_RECV,   UnreliableSelfDiscard = Unreliable | SelfDiscard, ReliableSelfDiscard = Reliable | SelfDiscard, FIFOSelfDiscard = FIFO | SelfDiscard, CausalSelfDiscard = Causal | SelfDiscard,   AgreedSelfDiscard = Agreed | SelfDiscard, SafeSelfDiscard = Safe | SelfDiscard }
	Service is not a proper enumeration, but rather a specification of constants corresponding to the Spread service type flags. More...
typedef Spread::int16	message_type
	Defines the type for 16-bit message type identifiers. More...
typedef Spread::service	service_type
	Defines the type for specifying service types. More...

Public Member Functions
virtual	~BaseMessage ()
	Virtual destructor. More...
virtual unsigned int	size () const =0
	Returns the number of bytes in the message. More...
virtual void	clear ()=0
	Clears the message for reuse, resetting its size to zero. More...
void	set_service (const service_type service)
	Sets the service type of the message. More...
service_type	service () const
	Returns the service type requested (for sends) or sent under (for receives) of the message. More...
void	set_type (const message_type type)
	Sets the message type identifier. More...
message_type	type () const
	Returns the type of the message. More...
void	set_sender (const string &sender)
	Sets the message sender. More...
const string &	sender () const
	Returns the message sender. More...
void	set_endian_mismatch (const bool mismatch=true)
	Sets the endian mismatch flag to the specified value. More...
bool	endian_mismatch () const
	Returns true if there is an endian mismatch between sender and receiver, false otherwise. More...
void	set_agreed ()
	Sets the service type to BaseMessage::Agreed. More...
bool	is_agreed () const
	Returns true if service type is BaseMessage::Agreed, false otherwise. More...
void	set_causal ()
	Sets the service type to BaseMessage::Causal. More...
bool	is_causal () const
	Returns true if service type is BaseMessage::Causal, false otherwise. More...
void	set_fifo ()
	Sets the service type to BaseMessage::FIFO. More...
bool	is_fifo () const
	Returns true if service type is BaseMessage::FIFO, false otherwise. More...
void	set_reliable ()
	Sets the service type to BaseMessage::Reliable. More...
bool	is_reliable () const
	Returns true if service type is BaseMessage::Reliable, false otherwise. More...
void	set_unreliable ()
	Sets the service type to BaseMessage::Unreliable. More...
bool	is_unreliable () const
	Returns true if service type is BaseMessage::Unreliable, false otherwise. More...
void	set_safe ()
	Sets the service type to BaseMessage::Safe. More...
bool	is_safe () const
	Returns true if service type is BaseMessage::Safe, false otherwise. More...
void	set_self_discard (const bool discard=true)
	Adds or removes the BaseMessage::SelfDiscard flag to or from the service type. More...
bool	is_self_discard () const
	Returns true if service type has the BaseMessage::SelfDiscard flag set, false otherwise. More...
bool	is_regular () const
	Returns true if this is a regular data (as opposed to membership) message, false otherwise. More...
bool	is_membership () const
	Returns true if this is a membership message, false otherwise. More...

Protected Member Functions
	BaseMessage ()
	Initializes the class with a message type equal to 0, service type equal to Safe, endian mismatch equal to false, and a zero-length string for the sender. More...

Protected Attributes
message_type	_type
service_type	_service_type
bool	_endian_mismatch
string	_sender

Detailed Description

BaseMessage is an abstract class defining the operations shared in common by Message and ScatterMessage.

We do not document its protected members because they are intended only for internal library use.

Definition at line 60 of file BaseMessage.h.

Member Typedef Documentation

typedef Spread::int16 BaseMessage::message_type

Defines the type for 16-bit message type identifiers.

Definition at line 63 of file BaseMessage.h.

typedef Spread::service BaseMessage::service_type

Defines the type for specifying service types.

Definition at line 66 of file BaseMessage.h.

Member Enumeration Documentation

enum BaseMessage::Service

Service is not a proper enumeration, but rather a specification of constants corresponding to the Spread service type flags.

We do not document the meaning of these flags here. See the Spread C API documentation to understand their meaning. We will note, however, that DropReceive is not a service type, but rather a flag instructing the Spread receive functions to truncate messages and group lists if the buffers are too small. There should be no need to use this constant in the API as it is handled by Mailbox::set_drop_receive.

Enumerator
Unreliable
Reliable
FIFO
Causal
Agreed
Safe
SelfDiscard
DropReceive
UnreliableSelfDiscard
ReliableSelfDiscard
FIFOSelfDiscard
CausalSelfDiscard
AgreedSelfDiscard
SafeSelfDiscard

Definition at line 81 of file BaseMessage.h.

Constructor & Destructor Documentation

BaseMessage::BaseMessage ( )

inlineprotected

Initializes the class with a message type equal to 0, service type equal to Safe, endian mismatch equal to false, and a zero-length string for the sender.

Definition at line 123 of file BaseMessage.h.

References group_type.

virtual BaseMessage::~BaseMessage ( )

inlinevirtual

Virtual destructor.

Definition at line 144 of file BaseMessage.h.

References clear(), and size().

Member Function Documentation

virtual void BaseMessage::clear ( )

pure virtual

Clears the message for reuse, resetting its size to zero.

Implemented in ScatterMessage, and Message.

Referenced by ~BaseMessage().

bool BaseMessage::endian_mismatch ( ) const

inline

Returns true if there is an endian mismatch between sender and receiver, false otherwise.

This only has meaning for received messages.

Returns

true if there is an endian mismatch between sender and receiver, false otherwise.

Definition at line 227 of file BaseMessage.h.

References _endian_mismatch.

bool BaseMessage::is_agreed ( ) const

inline

Returns true if service type is BaseMessage::Agreed, false otherwise.

Returns

true if service type is BaseMessage::Agreed, false otherwise.

Definition at line 240 of file BaseMessage.h.

References service().

bool BaseMessage::is_causal ( ) const

inline

Returns true if service type is BaseMessage::Causal, false otherwise.

Returns

true if service type is BaseMessage::Causal, false otherwise.

Definition at line 253 of file BaseMessage.h.

References service().

bool BaseMessage::is_fifo ( ) const

inline

Returns true if service type is BaseMessage::FIFO, false otherwise.

Returns

true if service type is BaseMessage::FIFO, false otherwise.

Definition at line 266 of file BaseMessage.h.

References service().

bool BaseMessage::is_membership ( ) const

inline

Returns true if this is a membership message, false otherwise.

Returns

true if this is a membership message, false otherwise.

Definition at line 345 of file BaseMessage.h.

References __END_NS_SSRC_SPREAD, and service().

bool BaseMessage::is_regular ( ) const

inline

Returns true if this is a regular data (as opposed to membership) message, false otherwise.

Returns

true if this is a regular message, false otherwise.

Definition at line 337 of file BaseMessage.h.

References service().

bool BaseMessage::is_reliable ( ) const

inline

Returns true if service type is BaseMessage::Reliable, false otherwise.

Returns

true if service type is BaseMessage::Reliable, false otherwise.

Definition at line 279 of file BaseMessage.h.

References service().

bool BaseMessage::is_safe ( ) const

inline

Returns true if service type is BaseMessage::Safe, false otherwise.

Returns

true if service type is BaseMessage::Safe, false otherwise.

Definition at line 305 of file BaseMessage.h.

References service().

bool BaseMessage::is_self_discard ( ) const

inline

Returns true if service type has the BaseMessage::SelfDiscard flag set, false otherwise.

Returns

true if service type has the BaseMessage::SelfDiscard flag set, false otherwise.

Definition at line 328 of file BaseMessage.h.

References service().

bool BaseMessage::is_unreliable ( ) const

inline

Returns true if service type is BaseMessage::Unreliable, false otherwise.

Returns

true if service type is BaseMessage::Unreliable, false otherwise.

Definition at line 292 of file BaseMessage.h.

References service().

const string& BaseMessage::sender ( ) const

inline

Returns the message sender.

This only has meaning for received messages.

Returns

The message sender.

Definition at line 209 of file BaseMessage.h.

References _sender.

Referenced by set_sender().

service_type BaseMessage::service ( ) const

inline

Returns the service type requested (for sends) or sent under (for receives) of the message.

Returns

The service type of the message.

Definition at line 177 of file BaseMessage.h.

References _service_type.

Referenced by is_agreed(), is_causal(), is_fifo(), is_membership(), is_regular(), is_reliable(), is_safe(), is_self_discard(), is_unreliable(), and set_service().

void BaseMessage::set_agreed ( )

inline

Sets the service type to BaseMessage::Agreed.

Definition at line 232 of file BaseMessage.h.

References Agreed, and set_service().

void BaseMessage::set_causal ( )

inline

Sets the service type to BaseMessage::Causal.

Definition at line 245 of file BaseMessage.h.

References Causal, and set_service().

void BaseMessage::set_endian_mismatch ( const bool  mismatch = true )

inline

Sets the endian mismatch flag to the specified value.

Parameters

mismatch

The mismatch value.

Definition at line 217 of file BaseMessage.h.

Referenced by if().

void BaseMessage::set_fifo ( )

inline

Sets the service type to BaseMessage::FIFO.

Definition at line 258 of file BaseMessage.h.

References FIFO, and set_service().

void BaseMessage::set_reliable ( )

inline

Sets the service type to BaseMessage::Reliable.

Definition at line 271 of file BaseMessage.h.

References Reliable, and set_service().

void BaseMessage::set_safe ( )

inline

Sets the service type to BaseMessage::Safe.

Definition at line 297 of file BaseMessage.h.

References Safe, and set_service().

void BaseMessage::set_self_discard ( const bool  discard = true )

inline

Adds or removes the BaseMessage::SelfDiscard flag to or from the service type.

Parameters

discard

true to set the BaseMessage::SelfDiscard flag, false to remove it.

Definition at line 316 of file BaseMessage.h.

References SelfDiscard.

void BaseMessage::set_sender ( const string &  sender )

inline

Sets the message sender.

Parameters

sender

The message sender.

Definition at line 201 of file BaseMessage.h.

References sender().

Referenced by if().

void BaseMessage::set_service ( const service_type  service )

inline

Sets the service type of the message.

Parameters

service

The service type of the message.

Definition at line 167 of file BaseMessage.h.

References service().

Referenced by if(), Mailbox::send(), set_agreed(), set_causal(), set_fifo(), set_reliable(), set_safe(), and set_unreliable().

void BaseMessage::set_type ( const message_type  type )

inline

Sets the message type identifier.

Parameters

type	The new message type.

Definition at line 185 of file BaseMessage.h.

References type().

Referenced by if(), and Mailbox::send().

void BaseMessage::set_unreliable ( )

inline

Sets the service type to BaseMessage::Unreliable.

Definition at line 284 of file BaseMessage.h.

References set_service(), and Unreliable.

virtual unsigned int BaseMessage::size ( ) const

pure virtual

Returns the number of bytes in the message.

Returns

The number of bytes in the message.

Implemented in ScatterMessage, and Message.

Referenced by ~BaseMessage().

message_type BaseMessage::type ( ) const

inline

Returns the type of the message.

Returns

The type of the message.

Definition at line 193 of file BaseMessage.h.

References _type.

Referenced by set_type().

Member Data Documentation

bool BaseMessage::_endian_mismatch

protected

Definition at line 115 of file BaseMessage.h.

Referenced by endian_mismatch().

string BaseMessage::_sender

protected

Definition at line 116 of file BaseMessage.h.

Referenced by sender().

service_type BaseMessage::_service_type

protected

Definition at line 114 of file BaseMessage.h.

Referenced by service().

message_type BaseMessage::_type

protected

Definition at line 113 of file BaseMessage.h.

Referenced by type().

---

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

• BaseMessage.h