octopi::encryption_wrapper Class Reference
Wraps an encrypted infoton when the octopus is in an encrypted mode. More...
#include <encryption_wrapper.h>
Public Member Functions | |
| encryption_wrapper (const basis::byte_array &wrapped=basis::byte_array::empty_array()) | |
| encryption_wrapper (const encryption_wrapper &to_copy) | |
| virtual | ~encryption_wrapper () |
| DEFINE_CLASS_NAME ("encryption_wrapper") | |
| encryption_wrapper & | operator= (const encryption_wrapper &to_copy) |
| void | text_form (basis::base_string &fill) const |
| requires derived infotons to be able to show their state as a string. | |
| 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. | |
Static Public Member Functions | |
| static const structures::string_array & | encryption_classifier () |
| returns the classifier for this type of infoton. | |
Public Attributes | |
| basis::byte_array | _wrapped |
| the encrypted data that's held here. | |
Detailed Description
Wraps an encrypted infoton when the octopus is in an encrypted mode.
The enclosed package will be unwrapped by the encryption tentacle.
Definition at line 29 of file encryption_wrapper.h.
Constructor & Destructor Documentation
| octopi::encryption_wrapper::encryption_wrapper | ( | const basis::byte_array & | wrapped = basis::byte_array::empty_array() |
) |
Definition at line 31 of file encryption_wrapper.cpp.
| octopi::encryption_wrapper::encryption_wrapper | ( | const encryption_wrapper & | to_copy | ) |
Definition at line 36 of file encryption_wrapper.cpp.
| octopi::encryption_wrapper::~encryption_wrapper | ( | ) | [virtual] |
Definition at line 42 of file encryption_wrapper.cpp.
Member Function Documentation
| clonable * octopi::encryption_wrapper::clone | ( | ) | const [virtual] |
must be provided to allow creation of a copy of this object.
Implements octopi::infoton.
Definition at line 44 of file encryption_wrapper.cpp.
| octopi::encryption_wrapper::DEFINE_CLASS_NAME | ( | "encryption_wrapper" | ) |
| static const structures::string_array& octopi::encryption_wrapper::encryption_classifier | ( | ) | [static] |
returns the classifier for this type of infoton.
Referenced by octopi::unwrapping_tentacle::reconstitute().
| encryption_wrapper & octopi::encryption_wrapper::operator= | ( | const encryption_wrapper & | to_copy | ) |
Definition at line 48 of file encryption_wrapper.cpp.
| void octopi::encryption_wrapper::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 65 of file encryption_wrapper.cpp.
References _wrapped, and basis::attach().
| virtual int octopi::encryption_wrapper::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::encryption_wrapper::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 47 of file encryption_wrapper.h.
References basis::base_string::assign(), and basis::text_formable::class_name().
| bool octopi::encryption_wrapper::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 70 of file encryption_wrapper.cpp.
References _wrapped, and structures::detach().
Member Data Documentation
the encrypted data that's held here.
this must be a packed classifier string array followed by the packed infoton.
Definition at line 33 of file encryption_wrapper.h.
Referenced by octopi::encryption_tentacle::consume(), pack(), unpack(), and cromp::cromp_server::wrap_infoton().
The documentation for this class was generated from the following files:
- /var/www/hoople2/source/octopi/library/tentacles/encryption_wrapper.h
- /var/www/hoople2/source/octopi/library/tentacles/encryption_wrapper.cpp
