Internal Messages

Collaboration diagram for Internal Messages:

Classes

class  protlib::message
 internal messages More...

Namespaces

namespace  protlib

Files

file  messages.h

Functions

 protlib::message::message (type_t t, qaddr_t s=qaddr_unknown, id_t id=0)
 constructor
virtual protlib::message::~message ()
 destructor
id_t protlib::message::get_id () const
 get ID
id_t protlib::message::set_id (id_t id)
 set ID or generate a new one
id_t protlib::message::new_id ()
 get new ID
type_t protlib::message::get_type () const
 get message type
FastQueue * protlib::message::get_source_queue () const
 get source module queue
qaddr_t protlib::message::get_source () const
 get source ID
qaddr_t protlib::message::set_source (qaddr_t s)
 set source ID
const char * protlib::message::get_qaddr_name () const
 get name of message source
static const char * protlib::message::get_qaddr_name (qaddr_t s)
 get source name
bool protlib::message::send (qaddr_t src, FastQueue *destqueue, bool exp=false)
 send the message to a queue
bool protlib::message::send (qaddr_t src, qaddr_t dest, bool exp=false)
 send the message
bool protlib::message::send_back (qaddr_t from, bool exp=false)
 send the message back
virtual void protlib::message::clear_pointers ()
 clear all pointers

Variables

static const char *const protlib::message::qaddr_string []
 printable message source names
static const char *const protlib::message::type_string []
 printable message typee names
bool protlib::message::send_to (qaddr_t dest, bool exp=false)
 send the message to dest
bool protlib::message::send_to (FastQueue *destqueue, bool exp=false)

Function Documentation

void protlib::message::clear_pointers (  )  [virtual, inherited]

clear all pointers

Set all pointer fields to NULL.

Reimplemented in protlib::TPMsg.

Definition at line 200 of file messages.cpp.

message::id_t protlib::message::get_id (  )  const [inherited]

const char * protlib::message::get_qaddr_name ( qaddr_t  s  )  [static, inherited]

get source name

Get the name of the given source.

Definition at line 152 of file messages.cpp.

References protlib::message::qaddr_string.

const char * protlib::message::get_qaddr_name (  )  const [inherited]

message::qaddr_t protlib::message::get_source (  )  const [inherited]

FastQueue * protlib::message::get_source_queue (  )  const [inherited]

get source module queue

Definition at line 129 of file messages.cpp.

References protlib::QueueManager::get_queue(), protlib::QueueManager::instance(), and protlib::message::source.

message::type_t protlib::message::get_type (  )  const [inherited]

get message type

Get the message type.

Definition at line 127 of file messages.cpp.

References protlib::message::type.

Referenced by protlib::TimerModule::process_queue().

protlib::message::message ( type_t  t,
qaddr_t  s = qaddr_unknown,
id_t  id = 0 
) [inherited]

constructor

Set message type, source ID and source queue. Set message ID to id if possible, otherwise generate a new ID.

Definition at line 99 of file messages.cpp.

References protlib::message::new_id(), and protlib::message::set_id().

message::id_t protlib::message::new_id (  )  [inherited]

get new ID

Generate an unused ID.

Definition at line 120 of file messages.cpp.

References protlib::tsdb::get_new_id64(), and protlib::message::msg_id.

Referenced by protlib::message::message(), and protlib::message::set_id().

bool protlib::message::send ( qaddr_t  src,
qaddr_t  dest,
bool  exp = false 
) [inherited]

send the message

Send this message.

Returns:
false if destination queue cannot be found or queue does not accept the message.

Definition at line 168 of file messages.cpp.

References protlib::FastQueue::enqueue(), protlib::QueueManager::get_queue(), protlib::QueueManager::instance(), and protlib::message::source.

bool protlib::message::send ( qaddr_t  src,
FastQueue destqueue,
bool  exp = false 
) [inherited]

bool protlib::message::send_back ( qaddr_t  from,
bool  exp = false 
) [inherited]

send the message back

Send back this message.

Returns:
false if destination queue cannot be found or queue does not accept the message.

Definition at line 192 of file messages.cpp.

References protlib::FastQueue::enqueue(), protlib::QueueManager::get_queue(), protlib::QueueManager::instance(), and protlib::message::source.

Referenced by protlib::message::send_back_or_delete(), and protlib::TimerModule::timer_expired().

bool protlib::message::send_to ( FastQueue destqueue,
bool  exp = false 
) [inherited]

Definition at line 184 of file messages.cpp.

References protlib::FastQueue::enqueue().

bool protlib::message::send_to ( qaddr_t  dest,
bool  exp = false 
) [inherited]

send the message to dest

Send this message.

Returns:
false if destination queue cannot be found or queue does not accept the message.

Definition at line 178 of file messages.cpp.

References protlib::FastQueue::enqueue(), protlib::QueueManager::get_queue(), and protlib::QueueManager::instance().

Referenced by protlib::TPoverTCP::receiver_thread(), and protlib::message::send_to_or_delete().

message::id_t protlib::message::set_id ( id_t  id  )  [inherited]

set ID or generate a new one

Definition at line 109 of file messages.cpp.

References protlib::message::msg_id, and protlib::message::new_id().

Referenced by protlib::message::message(), protlib::TimerMsg::restart(), and protlib::TimerMsg::stop().

message::qaddr_t protlib::message::set_source ( qaddr_t  s  )  [inherited]

set source ID

Set source ID and return old value.

Definition at line 138 of file messages.cpp.

References protlib::message::source.

protlib::message::~message (  )  [virtual, inherited]

destructor

Destructor does nothing for this class.

Definition at line 105 of file messages.cpp.


Variable Documentation

const char *const protlib::message::qaddr_string [static, private, inherited]

printable message source names

This array contains printable names of messages sources.

Definition at line 171 of file messages.h.

Referenced by protlib::message::get_qaddr_name().

const char *const protlib::message::type_string [static, private, inherited]

Initial value:

 {
        "TPMsg",
        "TimerMsg",
        "SignalingMsg",
        "ContextMsg",
        "InfoMsg",
        "RoutingMsg",
        "APIMsg"
}
printable message typee names

This array contains printable names of message types.

Definition at line 173 of file messages.h.

Referenced by protlib::message::get_type_name().


Generated on Fri Aug 14 23:38:36 2009 for Ariba by  doxygen 1.5.8