Symple module
Roster
The Roster provides a registry for active network peers indexed by session ID.
Roster
#include <icy/symple/roster.h>class RosterDefined in src/symple/include/icy/symple/roster.h:29
Inherits:
string, Peer >
The Roster provides a registry for active network peers indexed by session ID.
List of all members
| Name | Kind | Owner |
|---|---|---|
PeerAdded | variable | Declared here |
PeerRemoved | variable | Declared here |
Roster | function | Declared here |
~Roster | function | Declared here |
getByHost | function | Declared here |
peers | function | Declared here |
print | function | Declared here |
className | function | Declared here |
onAdd | function | Declared here |
onRemove | function | Declared here |
KeyedStore | function | Inherited from KeyedStore |
~KeyedStore | function | Inherited from KeyedStore |
KeyedStore | function | Inherited from KeyedStore |
operator= | function | Inherited from KeyedStore |
KeyedStore | function | Inherited from KeyedStore |
operator= | function | Inherited from KeyedStore |
get | function | Inherited from KeyedStore |
add | function | Inherited from KeyedStore |
tryAdd | function | Inherited from KeyedStore |
put | function | Inherited from KeyedStore |
erase | function | Inherited from KeyedStore |
contains | function | Inherited from KeyedStore |
empty | function | Inherited from KeyedStore |
size | function | Inherited from KeyedStore |
clear | function | Inherited from KeyedStore |
map | function | Inherited from KeyedStore |
map | function | Inherited from KeyedStore |
begin | function | Inherited from KeyedStore |
end | function | Inherited from KeyedStore |
begin | function | Inherited from KeyedStore |
end | function | Inherited from KeyedStore |
_map | variable | Inherited from KeyedStore |
onAdd | function | Inherited from KeyedStore |
onRemove | function | Inherited from KeyedStore |
Map | typedef | Inherited from KeyedStore |
Inherited from KeyedStore
| Kind | Name | Description |
|---|---|---|
function | KeyedStore | Defaulted constructor. |
function | ~KeyedStore virtual inline | |
function | KeyedStore | Deleted constructor. |
function | operator= | Deleted assignment operator. |
function | KeyedStore | Defaulted constructor. |
function | operator= | Defaulted assignment operator. |
function | get const inline | Returns the item for key, or nullptr if not found. |
function | add inline | Inserts a uniquely owned item. Returns a reference to the stored item. |
function | tryAdd inline | Inserts if absent; returns false on duplicate (never throws). |
function | put inline | Inserts or replaces the item under key. |
function | erase inline | Removes and destroys the item under key. |
function | contains const inline | |
function | empty const inline | |
function | size const inline | |
function | clear inline | |
function | map inline | Direct map access for iteration. |
function | map const inline | |
function | begin inline | |
function | end inline | |
function | begin const inline | |
function | end const inline | |
variable | _map | |
function | onAdd virtual inline | Override for lifecycle reactions. |
function | onRemove virtual inline | |
typedef | Map |
Public Attributes
| Return | Name | Description |
|---|---|---|
Signal< void(Peer &)> | PeerAdded | Lifecycle signals for external observers (samples, UI). |
Signal< void(constPeer &)> | PeerRemoved |
PeerAdded
Signal< void(Peer &)> PeerAddedDefined in src/symple/include/icy/symple/roster.h:46
Lifecycle signals for external observers (samples, UI).
PeerRemoved
Signal< void(constPeer &)> PeerRemovedDefined in src/symple/include/icy/symple/roster.h:47
Public Methods
| Return | Name | Description |
|---|---|---|
Roster | ||
Peer * | getByHost | Returns the first peer which matches the given host address. |
Map | peers const | Returns a deep copy of the peer map. |
void | print const | |
constchar * | className virtual const inline |
Roster
Roster()Defined in src/symple/include/icy/symple/roster.h:32
getByHost
Peer * getByHost(std::string_view host)Defined in src/symple/include/icy/symple/roster.h:36
Returns the first peer which matches the given host address.
peers
const
Map peers() constDefined in src/symple/include/icy/symple/roster.h:39
Returns a deep copy of the peer map.
const
void print(std::ostream & os) constDefined in src/symple/include/icy/symple/roster.h:41
className
virtual const inline
virtual inline constchar * className() constDefined in src/symple/include/icy/symple/roster.h:43
Protected Methods
onAdd
inline override
inline void onAdd(const std::string &, Peer * peer) overrideDefined in src/symple/include/icy/symple/roster.h:50
onRemove
inline override
inline void onRemove(const std::string &, Peer * peer) override