octopi::identity_infoton Class Reference
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. | |
| virtual int | packed_size () const |
| reports how large the infoton will be when packed. | |
| virtual void | pack (basis::byte_array &packed_form) const |
| stuffs the data in the infoton into the "packed_form". | |
| virtual bool | unpack (basis::byte_array &packed_form) |
| restores an infoton from a packed form. | |
| virtual clonable * | clone () const |
| must be provided to allow creation of a copy of this object. | |
Static Public Member Functions | |
| static const structures::string_array & | identity_classifier () |
| returns the classifier for this type of infoton. | |
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
| octopi::identity_infoton::identity_infoton | ( | ) |
Definition at line 28 of file identity_infoton.cpp.
| octopi::identity_infoton::identity_infoton | ( | const octopus_entity & | name | ) |
Definition at line 33 of file identity_infoton.cpp.
| octopi::identity_infoton::identity_infoton | ( | const identity_infoton & | to_copy | ) |
Definition at line 38 of file identity_infoton.cpp.
| octopi::identity_infoton::~identity_infoton | ( | ) | [virtual] |
Definition at line 44 of file identity_infoton.cpp.
Member Function Documentation
| clonable * octopi::identity_infoton::clone | ( | ) | const [virtual] |
must be provided to allow creation of a copy of this object.
Implements octopi::infoton.
Definition at line 68 of file identity_infoton.cpp.
Referenced by octopi::identity_tentacle::consume().
| octopi::identity_infoton::DEFINE_CLASS_NAME | ( | "identity_infoton" | ) |
| static const structures::string_array& octopi::identity_infoton::identity_classifier | ( | ) | [static] |
returns the classifier for this type of infoton.
Referenced by octopi::identity_tentacle::reconstitute().
| 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().
| void octopi::identity_infoton::pack | ( | basis::byte_array & | packed_form | ) | const [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.
Definition at line 71 of file identity_infoton.cpp.
References _new_name, and octopi::octopus_entity::pack().
| virtual int octopi::identity_infoton::packed_size | ( | ) | const [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.
| void octopi::identity_infoton::text_form | ( | basis::base_string & | state_fill | ) | const [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().
| bool octopi::identity_infoton::unpack | ( | basis::byte_array & | packed_form | ) | [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.
Definition at line 74 of file identity_infoton.cpp.
References _new_name, and octopi::octopus_entity::unpack().
Member Data Documentation
Definition at line 33 of file identity_infoton.h.
Referenced by octopi::identity_tentacle::consume(), operator=(), pack(), text_form(), and unpack().
The documentation for this class was generated from the following files:
- /var/www/hoople2/source/octopi/library/octopus/identity_infoton.h
- /var/www/hoople2/source/octopi/library/octopus/identity_infoton.cpp
