Savarese Software Research Corporation
protocol::CallHeader Struct Reference

Every call is described by a CallHeader followed by a message. More...

#include <Caller.h>

List of all members.

Public Member Functions

  CallHeader ()
  Constructs a CallHeader with all members initialized to zero.
  CallHeader (const wisp_message_id id, const wisp_call_token token, const CallRole role, const unsigned int size=0)
  Constructs a CallHeader.
void  clear ()
  Sets all members to 0.
void  init (const wisp_message_id _id, const wisp_call_token _token, const CallRole _role, const unsigned int _size=0)
  Initializes members to specified values.
bool  is_jumbo_fragment () const
  Returns true if the following message is a jumbo message fragment.
template<class Archive >
void  serialize (Archive &ar, const unsigned int)

Public Attributes

wisp_message_id  id
  An identifier denoting the message type.
wisp_call_token  token
  A token denoting the call responsible for generating the message.
wisp_call_role  role
  A value indicating the role of the call (e.g., OneWayRequest).
unsigned int  message_size
  The size of the message in bytes.

Detailed Description

Every call is described by a CallHeader followed by a message.

The CallHeader describes the message type via an id, the call it is participating in via a token, and the role of the message in the call.

Definition at line 201 of file Caller.h.


Constructor & Destructor Documentation

protocol::CallHeader::CallHeader ( ) [inline]

Constructs a CallHeader with all members initialized to zero.

Definition at line 216 of file Caller.h.

protocol::CallHeader::CallHeader ( const wisp_message_id  id,
const wisp_call_token  token,
const CallRole  role,
const unsigned int  size = 0 
) [inline]

Constructs a CallHeader.

Definition at line 221 of file Caller.h.


Member Function Documentation

void protocol::CallHeader::clear ( ) [inline]

Sets all members to 0.

Definition at line 230 of file Caller.h.

void protocol::CallHeader::init ( const wisp_message_id  _id,
const wisp_call_token  _token,
const CallRole  _role,
const unsigned int  _size = 0 
) [inline]

Initializes members to specified values.

Definition at line 237 of file Caller.h.

bool protocol::CallHeader::is_jumbo_fragment ( ) const [inline]

Returns true if the following message is a jumbo message fragment.

Returns:
true if the following message is a jumbo message fragment.

Definition at line 249 of file Caller.h.

Referenced by protocol::Caller< PT >::receive(), and protocol::Caller< PT >::receive_request().

template<class Archive >
void protocol::CallHeader::serialize ( Archive &  ar,
const unsigned  int 
) [inline]

Definition at line 254 of file Caller.h.


Member Data Documentation

An identifier denoting the message type.

Definition at line 203 of file Caller.h.

The size of the message in bytes.

It is non-zero only for jumbo messages.

Definition at line 211 of file Caller.h.

A value indicating the role of the call (e.g., OneWayRequest).

Definition at line 207 of file Caller.h.

Referenced by protocol::Caller< PT >::receive_request().

A token denoting the call responsible for generating the message.

Definition at line 205 of file Caller.h.


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

Savarese Software Research Corporation
Copyright © 2006-2010 Savarese Software Research Corporation. All rights reserved.