MessageOut Class Reference

#include <MessageOut.h>

List of all members.

---

Detailed Description

An output message.

Definition at line 96 of file MessageOut.h.

Public Member Functions
	MessageOut (Priority const &priority, msg_type type=unsafe_msg)
	Construct a MessageOut object with Priority and Prefix.
	MessageOut (PseudoMessageOut const &pseudo_message_out)
	Construct a MessageOut object that represents a pseudo message.
	MessageOut (MessageOut const &message)
	Copy-constructor.
template<class SESSION>
void	write_to (std::ostream &os, SESSION const &session) const
	Write the message to an ostream.
Priority const &	priority (void) const
	Returns the priority of this message.
bool	is_pseudo_message (void) const
	Returns true if this is a pseudo message.
bool	is_safe (void) const
	Returns the true if the message can be sent to the server without first logging into X.
Private Attributes
boost::shared_ptr< MessageOutData >	M_data
	Shared pointer to the actual message data.
Friends
bool	operator< (MessageOut const &msg1, MessageOut const &msg2)
	Returns true if the priority of message msg1 is less than the priority of message msg2.
std::ostream &	operator<< (std::ostream &os, MessageOut const &message)
	For debugging purposes. Write a MessageOut to os.

---

Constructor & Destructor Documentation

MessageOut::MessageOut	(	Priority const &	priority,
		msg_type	type = unsafe_msg
	)			[inline]

Construct a MessageOut object with Priority and Prefix.

Definition at line 102 of file MessageOut.h.

: M_data(NEW(MessageOutData(priority, type))) { }

MessageOut::MessageOut

(

PseudoMessageOut const &

pseudo_message_out

)

[inline]

Construct a MessageOut object that represents a pseudo message.

Definition at line 104 of file MessageOut.h.

: M_data(pseudo_message_out.data()) { }

MessageOut::MessageOut

(

MessageOut const &

message

)

[inline]

Copy-constructor.

Definition at line 106 of file MessageOut.h.

: M_data(message.M_data) { }

---

Member Function Documentation

template<class SESSION>

void MessageOut::write_to	(	std::ostream &	os,
		SESSION const &	session
	)			const [inline]

Write the message to an ostream.

Definition at line 105 of file MessageOut.cc.

References ASSERT, DoutEntering, and M_data.

Referenced by ClientSession::queue_msg().

{
  DoutEntering(dc::debug, "MessageOut<" << type_info_of<SESSION>().demangled_name() << ">::write_to(" << os << ", " << session << ") for " << *this);
  if (M_data->is_pseudo_message())
    boost::static_pointer_cast<PseudoMessageOutData>(M_data)->M_pseudo_message_event_server.trigger(PseudoMessageEventType());
  else
  {
#ifndef CWDEBUG
    std::ostream& tmp(os);
#else
    ASSERT(!os.fail());
    std::stringstream tmp;
#endif
    for (std::vector<boost::shared_ptr<JustInTimeToken> >::iterator iter = M_data->M_tokens.begin(); iter != M_data->M_tokens.end(); ++iter)
      (*iter)->write_to(tmp, session);
    tmp << "\r\n";
#ifdef CWDEBUG
    std::string result(tmp.str());
    os << result;
    Dout(dc::debug, "Wrote string \"" << buf2str(result.data(), result.size()) << "\".");
#endif
  }
}

Priority const& MessageOut::priority

(

void

)

const [inline]

Returns the priority of this message.

Definition at line 116 of file MessageOut.h.

References M_data.

{ return M_data->M_priority; }

bool MessageOut::is_pseudo_message

(

void

)

const [inline]

Returns true if this is a pseudo message.

Definition at line 119 of file MessageOut.h.

References M_data.

{ return M_data->is_pseudo_message(); }

bool MessageOut::is_safe

(

void

)

const [inline]

Returns the true if the message can be sent to the server without first logging into X.

Definition at line 122 of file MessageOut.h.

References M_data.

{ return M_data->is_safe(); }

---

Friends And Related Function Documentation

bool operator<	(	MessageOut const &	msg1,
		MessageOut const &	msg2
	)			[friend]

Returns true if the priority of message msg1 is less than the priority of message msg2.

Definition at line 125 of file MessageOut.h.

  {
    return msg1.M_data->M_priority < msg2.M_data->M_priority ||
           (msg1.M_data->M_priority == msg2.M_data->M_priority &&
            msg1.M_data->M_sequence_number > msg2.M_data->M_sequence_number);
  }

std::ostream& operator<<	(	std::ostream &	os,
		MessageOut const &	message
	)			[friend]

For debugging purposes. Write a MessageOut to os.

Definition at line 466 of file debug_ostream_operators.cc.

{
  os << "{data:" << *message.M_data;
  return os << '}';
}

---

Member Data Documentation

boost::shared_ptr<MessageOutData> MessageOut::M_data [private]

Shared pointer to the actual message data.

Definition at line 98 of file MessageOut.h.

Referenced by is_pseudo_message(), is_safe(), operator<<(), priority(), and write_to().

---

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

• MessageOut.h
• MessageOut.cc
• MessageOut.inl