libcppa  Version 0.1
Classes | Public Member Functions | Static Public Member Functions
cppa::group Class Reference

#include <group.hpp>

Inheritance diagram for cppa::group:
cppa::channel cppa::ref_counted

List of all members.

Classes

class  module
 Module interface. More...

Public Member Functions

const std::string & identifier () const
const std::string & module_name () const
virtual subscription subscribe (const channel_ptr &who)=0

Static Public Member Functions

static intrusive_ptr< groupget (const std::string &module_name, const std::string &group_identifier)
static void add_module (module *)

Detailed Description

A multicast group.


Member Function Documentation

static void cppa::group::add_module ( module ) [static]

Add a new group module to the libcppa group management. .

static intrusive_ptr<group> cppa::group::get ( const std::string &  module_name,
const std::string &  group_identifier 
) [static]

Get a pointer to the group associated with group_identifier from the module module_name. .

const std::string& cppa::group::identifier ( ) const

A string representation of the group identifier.

Returns:
The group identifier as string (e.g. "224.0.0.1" for IPv4 multicast or a user-defined string for local groups).
const std::string& cppa::group::module_name ( ) const

The name of the module.

Returns:
The module name of this group (e.g. "local").
virtual subscription cppa::group::subscribe ( const channel_ptr who) [pure virtual]

Subscribe who to this group.

Returns:
A subscription object that unsubscribes who if the lifetime of who ends.

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