reels::Clients Class Reference

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

#include <reels.h>

Public Member Functions
	Clients ()
ElementHash	hash_client_id (pChar p_cli)
	Return the hash of a client ID as an ElementHash. More...
void	add_client_id (pChar p_cli)
	Add a client ID to this container. More...
bool	load (pBinaryImage &p_bi)
	Load the state of an object from a base64 mercury-dynamics serialization using image_get() More...
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() More...
bool	save (pBinaryImage &p_bi)
	Save the state of an object into a base64 mercury-dynamics serialization using image_put() More...

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

Detailed Description

A container class to hold client ids.

Constructor & Destructor Documentation

Clients()

reels::Clients::Clients ( )

inline

Member Function Documentation

add_client_id()

void reels::Clients::add_client_id

(

pChar

p_cli

)

Add a client ID to this container.

Parameters

p_cli

The "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_cli

The "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_bi	The 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_bi	The address of a BinaryImage stream containing a previously save()-ed image at the cursor position.
c_block	The current reading cursor (block number) required only for nested use of load().
c_ofs	The 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_bi	The 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).

Member Data Documentation

id

ClientIDs reels::Clients::id = {}

The vector containing client ids as hashes in the order of definition.

id_set

ClientIDSet reels::Clients::id_set = {}

The set of the same hashes for fast search.

---

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

• reels/reels.h
• reels/reels.cpp