feisty meow concerns codebase  2.140
octopi::blank_entity_registry Class Reference

the blank_entity_registry can be used when security is not an issue. More...

#include <entity_registry.h>

Inheritance diagram for octopi::blank_entity_registry:
Collaboration diagram for octopi::blank_entity_registry:

Public Member Functions

bool authorized (const octopus_entity &formal(entity))
 
bool locate_entity (const octopus_entity &entity, timely::time_stamp &last_active, basis::byte_array &verification)
 retrieves the security records for the "entity", if any exist. More...
 
bool add_entity (const octopus_entity &formal(entity), const basis::byte_array &formal(verification))
 
bool refresh_entity (const octopus_entity &formal(entity))
 
bool zap_entity (const octopus_entity &formal(entity))
 
basis::astring text_form ()
 prints out the contents of the entity registry. More...
 
- Public Member Functions inherited from octopi::entity_registry
 entity_registry ()
 
virtual ~entity_registry ()
 
virtual bool authorized (const octopus_entity &entity)=0
 returns true if the "entity" is a registered entity. More...
 
virtual bool add_entity (const octopus_entity &entity, const basis::byte_array &verification)=0
 adds the "entity" to the list of authorized users if allowed. More...
 
virtual bool refresh_entity (const octopus_entity &entity)=0
 this should be used to refresh the entity's health record. More...
 
virtual bool zap_entity (const octopus_entity &entity)=0
 removes a "entity" if the entity can be found. More...
 

Detailed Description

the blank_entity_registry can be used when security is not an issue.

it always assumes every entity is valid. when the locate() method is invoked, a feel-good record is produced.

Definition at line 89 of file entity_registry.h.

Member Function Documentation

◆ add_entity()

bool octopi::blank_entity_registry::add_entity ( const octopus_entity formalentity,
const basis::byte_array formalverification 
)
inline

Definition at line 95 of file entity_registry.h.

◆ authorized()

bool octopi::blank_entity_registry::authorized ( const octopus_entity formalentity)
inline

Definition at line 92 of file entity_registry.h.

◆ locate_entity()

bool octopi::blank_entity_registry::locate_entity ( const octopus_entity entity,
timely::time_stamp last_active,
basis::byte_array verification 
)
virtual

retrieves the security records for the "entity", if any exist.

true is returned on success and "last_active" is set to the entity's last time of activity and "verification" is set to the cilent's verification token from its login.

Implements octopi::entity_registry.

Definition at line 45 of file entity_registry.cpp.

◆ refresh_entity()

bool octopi::blank_entity_registry::refresh_entity ( const octopus_entity formalentity)
inline

Definition at line 97 of file entity_registry.h.

◆ text_form()

astring octopi::blank_entity_registry::text_form ( )
virtual

prints out the contents of the entity registry.

Implements octopi::entity_registry.

Definition at line 42 of file entity_registry.cpp.

◆ zap_entity()

bool octopi::blank_entity_registry::zap_entity ( const octopus_entity formalentity)
inline

Definition at line 98 of file entity_registry.h.


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