octopi::security_infoton Class Reference
Encapsulates security activities (login, logout, refresh). More...
#include <security_infoton.h>
Public Types | |
| enum | login_modes { LI_LOGIN, LI_LOGOUT, LI_REFRESH } |
Public Member Functions | |
| security_infoton () | |
| security_infoton (login_modes mode, const basis::outcome &success, const basis::byte_array &verification) | |
| security_infoton (const security_infoton &to_copy) | |
| virtual | ~security_infoton () |
| DEFINE_CLASS_NAME ("security_infoton") | |
| security_infoton & | operator= (const security_infoton &to_copy) |
| const basis::byte_array & | verification () const |
| basis::byte_array & | verification () |
| 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. | |
| virtual int | packed_size () const |
| reports how large the infoton will be when packed. | |
| virtual void | text_form (basis::base_string &fill) const |
| requires derived infotons to be able to show their state as a string. | |
Static Public Member Functions | |
| static const structures::string_array & | security_classifier () |
| returns the classifier for this type of infoton. | |
Public Attributes | |
| login_modes | _mode |
| what kind of request is being made here? | |
| basis::outcome | _success |
| did the request succeed? | |
Detailed Description
Encapsulates security activities (login, logout, refresh).
Definition at line 24 of file security_infoton.h.
Member Enumeration Documentation
- Enumerator:
LI_LOGIN the requester wants to log in as a new entity.
LI_LOGOUT the requester surrenders its login.
LI_REFRESH the requester is still alive and wants to keep its login.
Definition at line 27 of file security_infoton.h.
Constructor & Destructor Documentation
| octopi::security_infoton::security_infoton | ( | ) |
Definition at line 30 of file security_infoton.cpp.
| octopi::security_infoton::security_infoton | ( | login_modes | mode, | |
| const basis::outcome & | success, | |||
| const basis::byte_array & | verification | |||
| ) |
Definition at line 37 of file security_infoton.cpp.
| octopi::security_infoton::security_infoton | ( | const security_infoton & | to_copy | ) |
Definition at line 45 of file security_infoton.cpp.
| octopi::security_infoton::~security_infoton | ( | ) | [virtual] |
Definition at line 54 of file security_infoton.cpp.
References basis::WHACK().
Member Function Documentation
| clonable * octopi::security_infoton::clone | ( | ) | const [virtual] |
must be provided to allow creation of a copy of this object.
Implements octopi::infoton.
Definition at line 57 of file security_infoton.cpp.
Referenced by octopi::login_tentacle::consume().
| octopi::security_infoton::DEFINE_CLASS_NAME | ( | "security_infoton" | ) |
| security_infoton & octopi::security_infoton::operator= | ( | const security_infoton & | to_copy | ) |
Definition at line 60 of file security_infoton.cpp.
References _mode, _success, octopi::infoton::classifier(), and octopi::infoton::set_classifier().
| void octopi::security_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 87 of file security_infoton.cpp.
References _mode, _success, basis::attach(), and basis::outcome::value().
| virtual int octopi::security_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.
| static const structures::string_array& octopi::security_infoton::security_classifier | ( | ) | [static] |
returns the classifier for this type of infoton.
Referenced by octopi::login_tentacle::reconstitute().
| virtual void octopi::security_infoton::text_form | ( | basis::base_string & | state_fill | ) | const [inline, virtual] |
requires derived infotons to be able to show their state as a string.
Implements octopi::infoton.
Definition at line 61 of file security_infoton.h.
References _mode, _success, basis::base_string::assign(), basis::text_formable::class_name(), and basis::outcome::value().
| bool octopi::security_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 94 of file security_infoton.cpp.
References _mode, _success, basis::detach(), and structures::detach().
| byte_array & octopi::security_infoton::verification | ( | ) |
Definition at line 73 of file security_infoton.cpp.
| const byte_array & octopi::security_infoton::verification | ( | ) | const |
Definition at line 70 of file security_infoton.cpp.
Referenced by octopi::login_tentacle::consume().
Member Data Documentation
what kind of request is being made here?
Definition at line 33 of file security_infoton.h.
Referenced by octopi::login_tentacle::consume(), operator=(), pack(), text_form(), and unpack().
did the request succeed?
Definition at line 34 of file security_infoton.h.
Referenced by octopi::login_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/tentacles/security_infoton.h
- /var/www/hoople2/source/octopi/library/tentacles/security_infoton.cpp
