msg_alert Class Reference

Alert message class. More...

#include <message.hh>

Inheritance diagram for msg_alert:

Public Member Functions
	msg_alert ()
virtual	~msg_alert ()
bool	is_request () const
bool	is_reply () const
bool	is_alert () const
virtual msg_t	message_type () const
	snake_case_mv_accessible_static_noset (msg_t, message_type)
Public Member Functions inherited from message
	message ()
virtual	~message ()
amqp_split_message_ptrs	create_amqp_messages (unsigned a_max_size=10000)
	Converts a Dripline message object to a set of AMQP messages. More...
void	encode_message_body (std::vector< std::string > &a_body_vec, unsigned a_max_size, const scarab::param_node &a_options=scarab::param_node()) const
	Converts the message-body to a strings (default encoding is JSON) for creating AMQP messages. More...
std::string	encode_full_message (unsigned a_max_size, const scarab::param_node &a_options=scarab::param_node()) const
	Converts the entire message into a single string (default encoding is JSON) More...
	snake_case_mv_accessible (bool, is_valid)
	Flag indicating whether the message was correctly converted from one or more AMQP messages. More...
	snake_case_mv_referrable (std::string, routing_key)
	snake_case_mv_referrable (std::string, correlation_id)
	snake_case_mv_referrable (std::string, message_id)
	snake_case_mv_referrable (std::string, reply_to)
	snake_case_mv_accessible (encoding, encoding)
	snake_case_mv_referrable (std::string, timestamp)
	snake_case_mv_referrable (std::string, sender_exe)
	snake_case_mv_referrable (std::string, sender_hostname)
	snake_case_mv_referrable (std::string, sender_username)
	snake_case_mv_referrable (std::string, sender_service_name)
	snake_case_mv_referrable (sender_version_map_t, sender_versions)
specifier &	parsed_specifier ()
const specifier &	parsed_specifier () const
scarab::param_node	get_sender_info () const
	Creates and returns a new param_node object to contain the sender info. More...
void	set_sender_info (const scarab::param_node &a_sender_info)
	Copies the sender info out of a param_node. More...
scarab::param_node	get_message_param (bool a_include_payload=true) const
	Creates and returns a new param_node object to contain the full message. More...
scarab::param &	payload ()
const scarab::param &	payload () const
void	set_payload (scarab::param_ptr_t a_payload)
const scarab::param_ptr_t &	get_payload_ptr () const

Static Public Member Functions
static alert_ptr_t	create (scarab::param_ptr_t a_payload, const std::string &a_routing_key, const std::string &a_specifier="", message::encoding a_encoding=encoding::json)
	Creates an alert message. More...
Static Public Member Functions inherited from message
static std::tuple< std::string, unsigned, unsigned >	parse_message_id (const std::string &a_message_id)
	Parses the message ID, which should be of the form [UUID]/[chunk]/[total chunks]. More...
static message_ptr_t	process_message (amqp_split_message_ptrs a_message_ptrs, const std::string &a_routing_key)
	Converts a set of AMQP messages to a Dripline message object. More...

Private Member Functions
void	derived_modify_amqp_message (amqp_message_ptr a_amqp_msg, AmqpClient::Table &a_properties) const
virtual void	derived_modify_message_param (scarab::param_node &a_message_node) const

Additional Inherited Members
Public Types inherited from message
enum	encoding { json }
typedef std::map< std::string, sender_package_version >	sender_version_map_t
Static Public Attributes inherited from message
static const char	s_message_id_separator = '/'
Protected Member Functions inherited from message
std::string	interpret_encoding () const
Protected Attributes inherited from message
specifier	f_specifier

Detailed Description

Alert message class.

Author

N.S. Oblath

No additional fields are added.

Alert message can be created with the static create() function.

Definition at line 284 of file message.hh.

Constructor & Destructor Documentation

msg_alert()

msg_alert

(

)

Definition at line 566 of file message.cc.

~msg_alert()

~msg_alert ( )

virtual

Definition at line 572 of file message.cc.

Member Function Documentation

create()

alert_ptr_t create ( scarab::param_ptr_t  a_payload, const std::string &  a_routing_key, const std::string &  a_specifier = "", message::encoding  a_encoding = encoding::json  )

static

Creates an alert message.

Definition at line 556 of file message.cc.

derived_modify_amqp_message()

void derived_modify_amqp_message ( amqp_message_ptr  a_amqp_msg, AmqpClient::Table &  a_properties  ) const

inlineprivatevirtual

Implements message.

Definition at line 450 of file message.hh.

derived_modify_message_param()

void derived_modify_message_param ( scarab::param_node &  a_message_node ) const

inlineprivatevirtual

Implements message.

Definition at line 455 of file message.hh.

is_alert()

bool is_alert ( ) const

inlinevirtual

Implements message.

Definition at line 445 of file message.hh.

is_reply()

bool is_reply ( ) const

inlinevirtual

Implements message.

Definition at line 441 of file message.hh.

is_request()

bool is_request ( ) const

inlinevirtual

Implements message.

Definition at line 437 of file message.hh.

message_type()

msg_t message_type ( ) const

virtual

Implements message.

Definition at line 579 of file message.cc.

snake_case_mv_accessible_static_noset()

snake_case_mv_accessible_static_noset	(	msg_t	,
		message_type
	)

---

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

• message.hh
• message.cc