Encapsulates just the action of identifying an octopus user. More...
#include <identity_infoton.h>
Public Member Functions | |
| identity_infoton () | |
| identity_infoton (const octopus_entity &name) | |
| identity_infoton (const identity_infoton &to_copy) | |
| virtual | ~identity_infoton () |
| DEFINE_CLASS_NAME ("identity_infoton") | |
| identity_infoton & | operator= (const identity_infoton &to_copy) |
| virtual void | text_form (basis::base_string &fill) const |
| requires derived infotons to be able to show their state as a string. More... | |
| virtual int | packed_size () const |
| reports how large the infoton will be when packed. More... | |
| virtual void | pack (basis::byte_array &packed_form) const |
| stuffs the data in the infoton into the "packed_form". More... | |
| virtual bool | unpack (basis::byte_array &packed_form) |
| restores an infoton from a packed form. More... | |
| virtual clonable * | clone () const |
| must be provided to allow creation of a copy of this object. More... | |
 Public Member Functions inherited from octopi::infoton | |
| infoton (const structures::string_array &classifier) | |
| creates an infoton with the "classifier". More... | |
| infoton (const basis::astring &class_1) | |
| infoton (const basis::astring &class_1, const basis::astring &class_2) | |
| infoton (const basis::astring &class_1, const basis::astring &class_2, const basis::astring &cl_3) | |
| infoton (const infoton &to_copy) | |
| copies only the base class portion of the infoton. More... | |
| virtual | ~infoton () |
| DEFINE_CLASS_NAME ("infoton") | |
| infoton & | operator= (const infoton &to_copy) |
| assigns only the base class portion. More... | |
| const structures::string_array & | classifier () const |
| this array of strings is the "name" for this infoton. More... | |
| void | set_classifier (const structures::string_array &new_classifier) |
| sets the infoton's classifier to the "new_classifier". More... | |
| void | set_classifier (const basis::astring &class_1) |
| void | set_classifier (const basis::astring &class_1, const basis::astring &class_2) |
| void | set_classifier (const basis::astring &class_1, const basis::astring &class_2, const basis::astring &cl_3) |
| bool | check_classifier (const basis::astring &class_name, const basis::astring &caller) |
| checks that the classifier seems valid. More... | |
| virtual basis::astring | text_form () const |
| local version just makes text_form() more functional. More... | |
| Public Member Functions inherited from basis::text_formable | |
| virtual const char * | class_name () const =0 |
| Returns the bare name of this class as a constant character pointer. More... | |
Static Public Member Functions | |
| static const structures::string_array & | identity_classifier () |
| returns the classifier for this type of infoton. More... | |
| Static Public Member Functions inherited from octopi::infoton | |
| static void | fast_pack (basis::byte_array &packed_form, const infoton &to_pack) |
| flattens an infoton "to_pack" into the byte array "packed_form". More... | |
| static bool | fast_unpack (basis::byte_array &packed_form, structures::string_array &classifier, basis::byte_array &info) |
| undoes a previous fast_pack to restore the previous information. More... | |
| static bool | test_fast_unpack (const basis::byte_array &packed_form, int &packed_length) |
| checks that the "packed_form" could hold a valid packed infoton. More... | |
| static int | fast_pack_overhead (const structures::string_array &classifier) |
| reports how much space is needed to pack the "classifier". More... | |
Public Attributes | |
| octopus_entity | _new_name |
Detailed Description
Encapsulates just the action of identifying an octopus user.
This must be done for an entity before it can begin to request octopus services when there is strong security in place. By default, the octopus does not require this.
Definition at line 30 of file identity_infoton.h.
Constructor & Destructor Documentation
◆ identity_infoton() [1/3]
| octopi::identity_infoton::identity_infoton | ( | ) |
Definition at line 28 of file identity_infoton.cpp.
◆ identity_infoton() [2/3]
| octopi::identity_infoton::identity_infoton | ( | const octopus_entity & | name | ) |
Definition at line 33 of file identity_infoton.cpp.
◆ identity_infoton() [3/3]
| octopi::identity_infoton::identity_infoton | ( | const identity_infoton & | to_copy | ) |
Definition at line 38 of file identity_infoton.cpp.
◆ ~identity_infoton()
|
virtual |
Definition at line 44 of file identity_infoton.cpp.
Member Function Documentation
◆ clone()
|
virtual |
must be provided to allow creation of a copy of this object.
Implements octopi::infoton.
Referenced by octopi::identity_tentacle::consume().
◆ DEFINE_CLASS_NAME()
| octopi::identity_infoton::DEFINE_CLASS_NAME | ( | "identity_infoton" | ) |
◆ identity_classifier()
|
static |
returns the classifier for this type of infoton.
Referenced by octopi::identity_tentacle::reconstitute().
◆ operator=()
| identity_infoton & octopi::identity_infoton::operator= | ( | const identity_infoton & | to_copy | ) |
Definition at line 53 of file identity_infoton.cpp.
References _new_name, octopi::infoton::classifier(), and octopi::infoton::set_classifier().
◆ pack()
|
virtual |
stuffs the data in the infoton into the "packed_form".
the derived method must know how to pack this particular type of infoton.
Implements octopi::infoton.
◆ packed_size()
|
virtual |
reports how large the infoton will be when packed.
must be overridden by derived classes to provide a guess at how large the packed size of this will be. this is important to estimate accurately.
Implements octopi::infoton.
◆ text_form()
|
virtual |
requires derived infotons to be able to show their state as a string.
Implements octopi::infoton.
Definition at line 46 of file identity_infoton.cpp.
References _new_name, basis::base_string::assign(), and octopi::octopus_entity::text_form().
◆ unpack()
|
virtual |
restores an infoton from a packed form.
the unpack() method will be utilized by tentacles that support this type of object.
Implements octopi::infoton.
Member Data Documentation
◆ _new_name
| octopus_entity octopi::identity_infoton::_new_name |
Definition at line 33 of file identity_infoton.h.
Referenced by octopi::identity_tentacle::consume(), operator=(), octopi::SAFE_STATIC_CONST(), and text_form().
The documentation for this class was generated from the following files:
- /opt/feistymeow.org/feisty_meow/octopi/library/octopus/identity_infoton.h
- /opt/feistymeow.org/feisty_meow/octopi/library/octopus/identity_infoton.cpp
