Reels
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
reels::Clients Class Reference

A container class to hold client ids. More...

#include <reels.h>

Public Member Functions

ElementHash hash_client_id (pChar p_cli)
 Return the hash of a client ID as an ElementHash.
 
void add_client_id (pChar p_cli)
 Add a client ID to this container.
 
bool load (pBinaryImage &p_bi)
 Load the state of an object from a base64 mercury-dynamics serialization using image_get()
 
bool load (pBinaryImage &p_bi, int &c_block, int &c_ofs)
 Load the state of an object from a base64 mercury-dynamics serialization using image_get()
 
bool save (pBinaryImage &p_bi)
 Save the state of an object into a base64 mercury-dynamics serialization using image_put()
 

Public Attributes

ClientIDs id = {}
 The vector containing client ids as hashes in the order of definition.
 
ClientIDSet id_set = {}
 The set of the same hashes for fast search.
 

Detailed Description

A container class to hold client ids.

Member Function Documentation

◆ add_client_id()

void reels::Clients::add_client_id ( pChar  p_cli)

Add a client ID to this container.

Parameters
p_cliThe "client". A string representing "the actor".

◆ hash_client_id()

ElementHash reels::Clients::hash_client_id ( pChar  p_cli)
inline

Return the hash of a client ID as an ElementHash.

Parameters
p_cliThe "client". A string representing "the actor".
Returns
The hash.

◆ load() [1/2]

bool reels::Clients::load ( pBinaryImage p_bi)

Load the state of an object from a base64 mercury-dynamics serialization using image_get()

Parameters
p_biThe address of a BinaryImage stream containing a previously save()-ed image at the cursor position.
Returns
True on success (Most likely error is a wrong stream).

◆ load() [2/2]

bool reels::Clients::load ( pBinaryImage p_bi,
int &  c_block,
int &  c_ofs 
)

Load the state of an object from a base64 mercury-dynamics serialization using image_get()

Parameters
p_biThe address of a BinaryImage stream containing a previously save()-ed image at the cursor position.
c_blockThe current reading cursor (block number) required only for nested use of load().
c_ofsThe current reading cursor (offset in block) required only for nested use of load().
Returns
True on success (Most likely error is a wrong stream).

◆ save()

bool reels::Clients::save ( pBinaryImage p_bi)

Save the state of an object into a base64 mercury-dynamics serialization using image_put()

Parameters
p_biThe address of a BinaryImage stream that is either empty or has been used only for writing.
Returns
True on success (Most likely error is allocation).

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