#include <protocol.h>

Inheritance diagram for GroupSessionProtocol:

Classes
struct	MessageCreateGroupSession
struct	MessageCreateReservation
Public Types
enum	{ RelayEvent, RelayEventSelfDiscard, RelayEvents, RelayEventsSelfDiscard, CreateGroupSession, EndGroupSession, ExpireGroupSession, FindGroupSessions, FindGroupSessionsResult, FindGroupSessionsForMember, ReturnGroupSessionsForMember, FindGroupSessionsByType, ReturnGroupSessionsByType, CreateReservation, CancelReservation, StartGroupSession, FindMembers, FindMembersResult, AddMembers, RemoveMembers, AddMember, AddMemberConfirm, RemoveMember, RemoveMemberConfirm }
enum	{ DefaultPayloadCapacity = NS_SSRC_SPREAD::Message::DefaultCapacity }
enum	MemberType { Participant, Observer }
enum	AddMemberResultCode { AddMemberInternalError, AddMemberNonexistentGroupSession, AddMemberDuplicateEntry, AddMemberMaxObserversReached, AddMemberSuccess }
typedef protocol::ServiceProtocol < protocol::GroupSession >	super
typedef std::vector < ExpirationNotification >	expiration_notification_container
typedef std::vector< string >	query_list
Public Member Functions
	WISP_IMPORT (super, caller_type)
	WISP_PROTOCOL_MESSAGE (EndGroupSession, protocol::MessageGroupSession,((gsid_type, gsid)))
	WISP_PROTOCOL_MESSAGE (CancelReservation, protocol::MessageGroupSession,((gsid_type, gsid))((uid_type, requestor)))
	WISP_PROTOCOL_MESSAGE (StartGroupSession, protocol::MessageGroupSession,((string, gs_name))((GroupSession, session)))
	WISP_STRUCT (ExpirationNotification,((gsid_type, gsid))((uid_container, uids)))
	WISP_PROTOCOL_MESSAGE (ExpireGroupSession, protocol::MessageGroupSession,((expiration_notification_container, notifications)))
	Expires both active sessions and reservations.
	WISP_PROTOCOL_MESSAGE_WITH_INIT (RelayEvent, protocol::MessageGroupSession,((gsid_type, gsid))((string, event_queue))((properties_ptr, event)),((gsid_type()))((string()))((properties_ptr(new Properties))))
	WISP_PROTOCOL_MESSAGE_WITH_INIT (RelayEventSelfDiscard, protocol::MessageGroupSession,((uid_type, source))((gsid_type, gsid))((string, event_queue))((properties_ptr, event)),((uid_type()))((gsid_type()))((string()))((properties_ptr(new Properties))))
	WISP_PROTOCOL_MESSAGE_WITH_INIT (RelayEvents, protocol::MessageGroupSession,((gsid_type, gsid))((string, event_queue))((std::vector< Properties >, events)),((gsid_type()))((string()))((std::vector< Properties >())))
	WISP_PROTOCOL_MESSAGE_WITH_INIT (RelayEventsSelfDiscard, protocol::MessageGroupSession,((uid_type, source))((gsid_type, gsid))((string, event_queue))((std::vector< Properties >, events)),((uid_type()))((gsid_type()))((string()))((std::vector< Properties >())))
	WISP_PROTOCOL_MESSAGE (FindGroupSessions, protocol::MessageGroupSession,((uid_type, requestor))((db_limit_type, limit))((db_offset_type, offset)))
	WISP_PROTOCOL_MESSAGE (FindGroupSessionsResult, protocol::MessageGroupSession,((uid_type, requestor))((unsigned int, total_sessions))((db_limit_type, limit))((db_offset_type, offset))((string, gs_name))((group_session_container, sessions)))
	WISP_PROTOCOL_MESSAGE (FindGroupSessionsForMember, protocol::MessageGroupSession,((uid_type, uid)))
	WISP_PROTOCOL_MESSAGE (ReturnGroupSessionsForMember, protocol::MessageGroupSession,((uid_type, uid))((string, gs_name))((group_session_container, participating))((group_session_container, observing))((reservation_container, awaiting)))
	WISP_PROTOCOL_MESSAGE (FindGroupSessionsByType, protocol::MessageGroupSession,((query_list, keys)))
	WISP_PROTOCOL_MESSAGE (ReturnGroupSessionsByType, protocol::MessageGroupSession,((group_session_container, sessions)))
	WISP_PROTOCOL_MESSAGE (FindMembers, protocol::MessageGroupSession,((uid_type, requestor))((gsid_container, sessions)))
	WISP_PROTOCOL_MESSAGE (FindMembersResult, protocol::MessageGroupSession,((uid_type, requestor))((member_container, participants))((member_container, observers)))
	WISP_PROTOCOL_MESSAGE (AddMembers, protocol::MessageGroupSession,((member_container, participants))((member_container, observers)))
	WISP_PROTOCOL_MESSAGE (RemoveMembers, protocol::MessageGroupSession,((member_container, participants))((member_container, observers)))
	WISP_PROTOCOL_MESSAGE (AddMember, protocol::MessageGroupSession,((MemberType, member_type))((Member, member)))
	WISP_PROTOCOL_MESSAGE (AddMemberConfirm, protocol::MessageGroupSession,((AddMemberResultCode, result))((MemberType, member_type))((uid_type, uid))((string, gs_name))((GroupSession, session)))
	WISP_PROTOCOL_MESSAGE (RemoveMember, protocol::MessageGroupSession,((MemberType, member_type))((Member, member)))
	WISP_PROTOCOL_MESSAGE (RemoveMemberConfirm, protocol::MessageGroupSession,((MemberType, member_type))((Member, member))((string, gs_name))((GroupSession, session)))
	WISP_ONE_WAY_CALL (caller_type, CreateGroupSession)
	WISP_ONE_WAY_CALL (caller_type, EndGroupSession)
	WISP_ONE_WAY_CALL (caller_type, ExpireGroupSession)
	WISP_ONE_WAY_CALL (caller_type, RelayEvent)
	WISP_ONE_WAY_CALL (caller_type, RelayEventSelfDiscard)
	WISP_ONE_WAY_CALL (caller_type, RelayEvents)
	WISP_ONE_WAY_CALL (caller_type, RelayEventsSelfDiscard)
	WISP_ONE_WAY_CALL (caller_type, CreateReservation)
	WISP_ONE_WAY_CALL (caller_type, CancelReservation)
	WISP_ONE_WAY_CALL (caller_type, StartGroupSession)
	WISP_TWO_WAY_CALL (caller_type, FindGroupSessionsForMember, ReturnGroupSessionsForMember)
	WISP_ONE_WAY_CALL (caller_type, ReturnGroupSessionsForMember)
	WISP_TWO_WAY_CALL (caller_type, FindGroupSessionsByType, ReturnGroupSessionsByType)
	WISP_ONE_WAY_CALL (caller_type, ReturnGroupSessionsByType)
	WISP_ONE_WAY_CALL (caller_type, FindGroupSessions)
	WISP_ONE_WAY_CALL (caller_type, FindGroupSessionsResult)
	WISP_ONE_WAY_CALL (caller_type, FindMembers)
	WISP_ONE_WAY_CALL (caller_type, FindMembersResult)
	WISP_ONE_WAY_CALL (caller_type, AddMembers)
	WISP_ONE_WAY_CALL (caller_type, RemoveMembers)
	WISP_ONE_WAY_CALL (caller_type, AddMember)
	WISP_ONE_WAY_CALL (caller_type, AddMemberConfirm)
	WISP_ONE_WAY_CALL (caller_type, RemoveMember)
	WISP_ONE_WAY_CALL (caller_type, RemoveMemberConfirm)
Static Public Member Functions
static string	event_group_expire ()
Static Public Attributes
static const gsid_type	GSIDMax = boost::integer_traits<gsid_type>::const_max
	The maximum value a gsid can have.
static const gsid_type	GSIDMin = boost::integer_traits<gsid_type>::const_min
	The minimum value a gsid can have.
static const gsid_type	GSIDSpace
	The size of a gsid protocol partition.

Detailed Description

Definition at line 53 of file group_session/protocol.h.

Member Typedef Documentation

typedef std::vector<ExpirationNotification> GroupSessionProtocol::expiration_notification_container

Definition at line 203 of file group_session/protocol.h.

typedef std::vector<string> GroupSessionProtocol::query_list

Definition at line 273 of file group_session/protocol.h.

typedef protocol::ServiceProtocol<protocol::GroupSession> GroupSessionProtocol::super

Definition at line 56 of file group_session/protocol.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

RelayEvent
RelayEventSelfDiscard
RelayEvents
RelayEventsSelfDiscard
CreateGroupSession
EndGroupSession
ExpireGroupSession
FindGroupSessions
FindGroupSessionsResult
FindGroupSessionsForMember
ReturnGroupSessionsForMember
FindGroupSessionsByType
ReturnGroupSessionsByType
CreateReservation
CancelReservation
StartGroupSession
FindMembers
FindMembersResult
AddMembers
RemoveMembers
AddMember
AddMemberConfirm
RemoveMember
RemoveMemberConfirm

Definition at line 84 of file group_session/protocol.h.

anonymous enum

Enumerator:

DefaultPayloadCapacity

Definition at line 111 of file group_session/protocol.h.

enum GroupSessionProtocol::AddMemberResultCode

Enumerator:

AddMemberInternalError
AddMemberNonexistentGroupSession
AddMemberDuplicateEntry
AddMemberMaxObserversReached
AddMemberSuccess

Definition at line 306 of file group_session/protocol.h.

enum GroupSessionProtocol::MemberType

Enumerator:

Participant
Observer

Definition at line 113 of file group_session/protocol.h.

Member Function Documentation

static string GroupSessionProtocol::event_group_expire ( ) [inline, static]

Definition at line 80 of file group_session/protocol.h.

References WSPR_EVENT_GROUP.

Referenced by EventQueue::transition().

GroupSessionProtocol::WISP_IMPORT	(	super	,
		caller_type
	)

GroupSessionProtocol::WISP_ONE_WAY_CALL	(	caller_type	,
		CreateGroupSession
	)

GroupSessionProtocol::WISP_ONE_WAY_CALL	(	caller_type	,
		EndGroupSession
	)

GroupSessionProtocol::WISP_ONE_WAY_CALL	(	caller_type	,
		ExpireGroupSession
	)

GroupSessionProtocol::WISP_ONE_WAY_CALL	(	caller_type	,
		RelayEvent
	)

GroupSessionProtocol::WISP_ONE_WAY_CALL	(	caller_type	,
		RelayEventSelfDiscard
	)

GroupSessionProtocol::WISP_ONE_WAY_CALL	(	caller_type	,
		RelayEvents
	)

GroupSessionProtocol::WISP_ONE_WAY_CALL	(	caller_type	,
		RelayEventsSelfDiscard
	)

GroupSessionProtocol::WISP_ONE_WAY_CALL	(	caller_type	,
		CreateReservation
	)

GroupSessionProtocol::WISP_ONE_WAY_CALL	(	caller_type	,
		CancelReservation
	)

GroupSessionProtocol::WISP_ONE_WAY_CALL	(	caller_type	,
		StartGroupSession
	)

GroupSessionProtocol::WISP_ONE_WAY_CALL	(	caller_type	,
		ReturnGroupSessionsForMember
	)

GroupSessionProtocol::WISP_ONE_WAY_CALL	(	caller_type	,
		ReturnGroupSessionsByType
	)

GroupSessionProtocol::WISP_ONE_WAY_CALL	(	caller_type	,
		FindGroupSessions
	)

GroupSessionProtocol::WISP_ONE_WAY_CALL	(	caller_type	,
		FindGroupSessionsResult
	)

GroupSessionProtocol::WISP_ONE_WAY_CALL	(	caller_type	,
		FindMembers
	)

GroupSessionProtocol::WISP_ONE_WAY_CALL	(	caller_type	,
		FindMembersResult
	)

GroupSessionProtocol::WISP_ONE_WAY_CALL	(	caller_type	,
		AddMembers
	)

GroupSessionProtocol::WISP_ONE_WAY_CALL	(	caller_type	,
		RemoveMembers
	)

GroupSessionProtocol::WISP_ONE_WAY_CALL	(	caller_type	,
		AddMember
	)

GroupSessionProtocol::WISP_ONE_WAY_CALL	(	caller_type	,
		AddMemberConfirm
	)

GroupSessionProtocol::WISP_ONE_WAY_CALL	(	caller_type	,
		RemoveMember
	)

GroupSessionProtocol::WISP_ONE_WAY_CALL	(	caller_type	,
		RemoveMemberConfirm
	)

GroupSessionProtocol::WISP_PROTOCOL_MESSAGE	(	EndGroupSession	,
		protocol::MessageGroupSession	,
		((gsid_type, gsid))
	)

GroupSessionProtocol::WISP_PROTOCOL_MESSAGE	(	CancelReservation	,
		protocol::MessageGroupSession	,
		((gsid_type, gsid))((uid_type, requestor))
	)

GroupSessionProtocol::WISP_PROTOCOL_MESSAGE	(	StartGroupSession	,
		protocol::MessageGroupSession	,
		((string, gs_name))((GroupSession, session))
	)

GroupSessionProtocol::WISP_PROTOCOL_MESSAGE	(	ExpireGroupSession	,
		protocol::MessageGroupSession	,
		((expiration_notification_container, notifications))
	)

Expires both active sessions and reservations.

GroupSessionProtocol::WISP_PROTOCOL_MESSAGE	(	FindGroupSessions	,
		protocol::MessageGroupSession	,
		((uid_type, requestor))((db_limit_type, limit))((db_offset_type, offset))
	)

GroupSessionProtocol::WISP_PROTOCOL_MESSAGE	(	FindGroupSessionsResult	,
		protocol::MessageGroupSession	,
		((uid_type, requestor))((unsigned int, total_sessions))((db_limit_type, limit))((db_offset_type, offset))((string, gs_name))((group_session_container, sessions))
	)

GroupSessionProtocol::WISP_PROTOCOL_MESSAGE	(	FindGroupSessionsForMember	,
		protocol::MessageGroupSession	,
		((uid_type, uid))
	)

GroupSessionProtocol::WISP_PROTOCOL_MESSAGE	(	ReturnGroupSessionsForMember	,
		protocol::MessageGroupSession	,
		((uid_type, uid))((string, gs_name))((group_session_container, participating))((group_session_container, observing))((reservation_container, awaiting))
	)

GroupSessionProtocol::WISP_PROTOCOL_MESSAGE	(	FindGroupSessionsByType	,
		protocol::MessageGroupSession	,
		((query_list, keys))
	)

GroupSessionProtocol::WISP_PROTOCOL_MESSAGE	(	ReturnGroupSessionsByType	,
		protocol::MessageGroupSession	,
		((group_session_container, sessions))
	)

GroupSessionProtocol::WISP_PROTOCOL_MESSAGE	(	FindMembers	,
		protocol::MessageGroupSession	,
		((uid_type, requestor))((gsid_container, sessions))
	)

GroupSessionProtocol::WISP_PROTOCOL_MESSAGE	(	FindMembersResult	,
		protocol::MessageGroupSession	,
		((uid_type, requestor))((member_container, participants))((member_container, observers))
	)

GroupSessionProtocol::WISP_PROTOCOL_MESSAGE	(	AddMembers	,
		protocol::MessageGroupSession	,
		((member_container, participants))((member_container, observers))
	)

GroupSessionProtocol::WISP_PROTOCOL_MESSAGE	(	RemoveMembers	,
		protocol::MessageGroupSession	,
		((member_container, participants))((member_container, observers))
	)

GroupSessionProtocol::WISP_PROTOCOL_MESSAGE	(	AddMember	,
		protocol::MessageGroupSession	,
		((MemberType, member_type))((Member, member))
	)

GroupSessionProtocol::WISP_PROTOCOL_MESSAGE	(	AddMemberConfirm	,
		protocol::MessageGroupSession	,
		((AddMemberResultCode, result))((MemberType, member_type))((uid_type, uid))((string, gs_name))((GroupSession, session))
	)

GroupSessionProtocol::WISP_PROTOCOL_MESSAGE	(	RemoveMember	,
		protocol::MessageGroupSession	,
		((MemberType, member_type))((Member, member))
	)

GroupSessionProtocol::WISP_PROTOCOL_MESSAGE	(	RemoveMemberConfirm	,
		protocol::MessageGroupSession	,
		((MemberType, member_type))((Member, member))((string, gs_name))((GroupSession, session))
	)

GroupSessionProtocol::WISP_PROTOCOL_MESSAGE_WITH_INIT	(	RelayEvent	,
		protocol::MessageGroupSession	,
		((gsid_type, gsid))((string, event_queue))((properties_ptr, event))	,
		((gsid_type()))((string()))((properties_ptr(new Properties)))
	)

GroupSessionProtocol::WISP_PROTOCOL_MESSAGE_WITH_INIT	(	RelayEventSelfDiscard	,
		protocol::MessageGroupSession	,
		((uid_type, source))((gsid_type, gsid))((string, event_queue))((properties_ptr, event))	,
		((uid_type()))((gsid_type()))((string()))((properties_ptr(new Properties)))
	)

GroupSessionProtocol::WISP_PROTOCOL_MESSAGE_WITH_INIT	(	RelayEvents	,
		protocol::MessageGroupSession	,
		((gsid_type, gsid))((string, event_queue))((std::vector< Properties >, events))	,
		((gsid_type()))((string()))((std::vector< Properties >()))
	)

GroupSessionProtocol::WISP_PROTOCOL_MESSAGE_WITH_INIT	(	RelayEventsSelfDiscard	,
		protocol::MessageGroupSession	,
		((uid_type, source))((gsid_type, gsid))((string, event_queue))((std::vector< Properties >, events))	,
		((uid_type()))((gsid_type()))((string()))((std::vector< Properties >()))
	)

GroupSessionProtocol::WISP_STRUCT	(	ExpirationNotification	,
		((gsid_type, gsid))((uid_container, uids))
	)

GroupSessionProtocol::WISP_TWO_WAY_CALL	(	caller_type	,
		FindGroupSessionsForMember	,
		ReturnGroupSessionsForMember
	)

GroupSessionProtocol::WISP_TWO_WAY_CALL	(	caller_type	,
		FindGroupSessionsByType	,
		ReturnGroupSessionsByType
	)

Member Data Documentation

const gsid_type GroupSessionProtocol::GSIDMax = boost::integer_traits<gsid_type>::const_max [static]

The maximum value a gsid can have.

Definition at line 61 of file group_session/protocol.h.

const gsid_type GroupSessionProtocol::GSIDMin = boost::integer_traits<gsid_type>::const_min [static]

The minimum value a gsid can have.

Definition at line 64 of file group_session/protocol.h.

Referenced by gsid_max(), gsid_min(), and gsid_to_protocol().

const gsid_type GroupSessionProtocol::GSIDSpace [static]

Initial value:

      (((boost::integer_traits<gsid_type>::const_max >> 2) + 1)
       - (boost::integer_traits<gsid_type>::const_min >> 2))  /
      ((boost::integer_traits<wisp_message_protocol>::const_max >> 2) + 1)

The size of a gsid protocol partition.

For example, the first protocol partition is assigned the range:

(GSIDMin, GSIDMin + GSIDSpace]

Definition at line 75 of file group_session/protocol.h.

Referenced by gsid_max(), gsid_min(), gsid_to_protocol(), and gsid_to_protocol_partition().

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

group_session/protocol.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation