This header defines the GroupList class. More...

#include <string>
#include <ostream>
#include <ssrc/spread/detail/Buffer.h>
#include <sp.h>

Include dependency graph for GroupList.h:

This graph shows which files directly or indirectly include this file:

Classes
class	GroupList
	GroupList is a container for Spread group names. More...
struct	GroupList::group_type
Namespaces
namespace	Spread
	The Spread C API from <sp.h> can be accessed via the Spread namespace if required, but it is intended for internal use by Ssrc Spread to avoid polluting the global namespace.
Typedefs
typedef char	Spread::group_type [MAX_GROUP_NAME]
	This is an internal typedef not meant for use in end-user code.
Enumerations
enum	{ MaxSizePrivateName = MAX_PRIVATE_NAME, MaxSizeProcessName = MAX_PROC_NAME, MaxSizeGroupName = MAX_GROUP_NAME, MinValidGroupNameChar = 36, MaxValidGroupNameChar = 126, GroupNameSeparatorChar = 35 }
Functions
std::pair< string, string >	split_private_group (const string &private_group)
	Splits a private group name into its private name and process name components.

Detailed Description

This header defines the GroupList class.

Definition in file GroupList.h.

Enumeration Type Documentation

anonymous enum

Enumerator:

MaxSizePrivateName	Maximum number of characters in a private name. This is inconsistent with MaxSizeProcessName and MaxSizeGroupName (which are max + 1), but it's how the Spread Toolkit does it; so we don't deviate, even though we'd rather they all be consistently defined as maximum values.
MaxSizeProcessName	Maximum number of characters in the name of a daemon process + 1.
MaxSizeGroupName	The maximum number of characters in a group name + 1.
MinValidGroupNameChar	The minimum value of a valid group name character.
MaxValidGroupNameChar	The maximum value of a valid group name character.
GroupNameSeparatorChar	The value of the group name character separator.

Definition at line 41 of file GroupList.h.

std::pair<string,string> split_private_group ( const string & private_group ) [inline]

Splits a private group name into its private name and process name components.

This functions assumes it is provided a valid private group name, otherwise its behavior is undefined.

Parameters:

private_group The private group name to split.

Returns:: A std::pair<string,string> where the first element is the private name component and the second element is the process name component.

Definition at line 74 of file GroupList.h.