ircproxy  The Ultimate Cyborg

MessageOutData Struct Reference

#include <MessageOut.h>

Inheritance diagram for MessageOutData:

PseudoMessageOutData

List of all members.


Detailed Description

A structure containing the data associated with a MessageOut object.

Definition at line 39 of file MessageOut.h.


Public Member Functions

 MessageOutData (Priority const &priority, msg_type type)
 Construct a MessageOutData object with prefix.
virtual ~MessageOutData ()
 Destructor.
virtual bool is_pseudo_message (void) const
 Return 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.

Public Attributes

Priority M_priority
 Message priority.
msg_type M_type
 Whether or not it's safe to send this message before authentication.
uint32_t M_sequence_number
 A sequence number. Larger if this message was created later.

Static Public Attributes

static uint32_t S_sequence_number
 The next sequence number.

Constructor & Destructor Documentation

MessageOutData::MessageOutData ( Priority const &  priority,
msg_type  type 
) [inline]

Construct a MessageOutData object with prefix.

Definition at line 47 of file MessageOut.h.

References debug::channels::dc::objects.

00047                                                           : M_priority(priority), M_type(type), M_sequence_number(S_sequence_number++)
00048       { Dout(dc::objects, "Constructing MessageOutData(" << priority << ")"); }

virtual MessageOutData::~MessageOutData (  )  [inline, virtual]

Destructor.

Definition at line 50 of file MessageOut.h.

References M_sequence_number, and debug::channels::dc::objects.

00050 { Dout(dc::objects, "Destructing MessageOutData " << *this << ", sequence number " << M_sequence_number); }


Member Function Documentation

virtual bool MessageOutData::is_pseudo_message ( void   )  const [inline, virtual]

Return true if this is a pseudo message.

Reimplemented in PseudoMessageOutData.

Definition at line 53 of file MessageOut.h.

00053 { return false; }

bool MessageOutData::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 56 of file MessageOut.h.

References M_type, and safe_query.

00056 { return M_type == safe_query; }


Member Data Documentation

Message priority.

Definition at line 40 of file MessageOut.h.

Referenced by operator<<().

Whether or not it's safe to send this message before authentication.

Definition at line 41 of file MessageOut.h.

Referenced by is_safe().

A sequence number. Larger if this message was created later.

Definition at line 43 of file MessageOut.h.

Referenced by ~MessageOutData().

The next sequence number.

Definition at line 44 of file MessageOut.h.


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

Copyright © 2005-2007 Carlo Wood.  All rights reserved.