ssrc::wisp::protocol::CallHeader Struct Reference

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

#include <Caller.h>

Public Member Functions
	CallHeader ()
	Constructs a CallHeader with all members initialized to zero. More...
	CallHeader (const wisp_message_id id, const wisp_call_token token, const CallRole role, const unsigned int size=0)
	Constructs a CallHeader. More...
void	clear ()
	Sets all members to 0. More...
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. More...
bool	is_jumbo_fragment () const
	Returns true if the following message is a jumbo message fragment. More...
template<class Archive >
void	serialize (Archive &ar, const unsigned int)

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

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

CallHeader() [1/2]

ssrc::wisp::protocol::CallHeader::CallHeader ( )

inline

Constructs a CallHeader with all members initialized to zero.

Definition at line 216 of file Caller.h.

CallHeader() [2/2]

ssrc::wisp::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

clear()

void ssrc::wisp::protocol::CallHeader::clear ( )

inline

Sets all members to 0.

Definition at line 230 of file Caller.h.

Referenced by ssrc::wisp::protocol::MessageInfo::clear_header().

init()

void ssrc::wisp::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.

Referenced by ssrc::wisp::protocol::MessageInfo::init_header().

is_jumbo_fragment()

bool ssrc::wisp::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 ssrc::wisp::protocol::Caller< PT >::receive(), and ssrc::wisp::protocol::Caller< PT >::receive_request().

serialize()

template<class Archive >

void ssrc::wisp::protocol::CallHeader::serialize ( Archive &  ar, const unsigned  int  )

inline

Definition at line 254 of file Caller.h.

Member Data Documentation

id

wisp_message_id ssrc::wisp::protocol::CallHeader::id

An identifier denoting the message type.

Definition at line 203 of file Caller.h.

Referenced by ssrc::wisp::protocol::MessageInfo::id().

message_size

unsigned int ssrc::wisp::protocol::CallHeader::message_size

The size of the message in bytes.

It is non-zero only for jumbo messages.

Definition at line 211 of file Caller.h.

role

wisp_call_role ssrc::wisp::protocol::CallHeader::role

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

Definition at line 207 of file Caller.h.

Referenced by ssrc::wisp::protocol::Caller< PT >::receive_request(), and ssrc::wisp::protocol::MessageInfo::role().

token

wisp_call_token ssrc::wisp::protocol::CallHeader::token

A token denoting the call responsible for generating the message.

Definition at line 205 of file Caller.h.

Referenced by ssrc::wisp::protocol::MessageInfo::token().

---

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

• Caller.h