struct FinderMessage

Base class for Finder Protocol messages. More...

Contains pure virtuals
Definition#include <finder_ipc.hh>
Inherited byFinderAck, FinderAnswer, FinderAssociate, FinderBye, FinderHello, FinderQuestion
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods

Protected Methods

Protected Members


Detailed Description

Provides the functionality common to all message types: sequencing, source identifier, authentication, and rendering.

 FinderMessage ()

FinderMessage

bool  add_arg (const char*)

add_arg

const char*  get_arg (uint32_t n)

get_arg

[const]

const FinderMessageType&  type ()

type

[const]

uint16_t  seqno ()

seqno

[const]

uint16_t  ackno ()

ackno

[const]

bool  is_ack ()

is_ack

[const]

bool  operator== (const FinderMessage& m)

operator==

[const]

string  str ()

str

[const]

 FinderMessage (uint32_t src, uint32_t seq, const string& name)

FinderMessage

 ~FinderMessage ()

~FinderMessage

[virtual]

typedef ref_ptr<FinderMessage> RefPtr

RefPtr

const string  render ()

render

[const]

Create a string containing ascii packet data.

const string  render_signed (const HMAC& h)

render_signed

[const]

Create a string containing ascii packet data that includes an authentication header.

Parameters:
hheader authentication object.

inline uint32_t  srcid ()

srcid

[const]

Returns: source identifier of message.

inline uint32_t  seqno ()

seqno

[const]

Returns: sequence number of message.

inline void  set_seqno (uint32_t s)

set_seqno

set sequence number of message.

inline const string&  name ()

name

[const]

Returns: message name (i.e. 'hello', 'bye')

const string  render_signature (const HMAC& h, const string& msg_header)

render_signature

[protected const]

Returns: HMAC signature of message header.

const string  render_header (size_t payload_bytes)

render_header

[protected const]

Returns: Ascii representation of header.

const string  render_payload ()

render_payload

[protected const pure virtual]

FinderMessage sub-classes must implement this method.

Returns: Ascii representation of data associated with packet.

uint32_t _src

_src

[protected]

uint32_t _seq

_seq

[protected]

string _name

_name

[protected]


Generated by: pavlin on possum.icir.org on Mon Mar 10 19:34:49 2003, using kdoc 2.0a54+XORP.