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. 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... | |
| virtual int | packed_size () const |
| reports how large the infoton will be when packed. 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 & | encryption_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 | |
| basis::byte_array | _wrapped |
| the encrypted data that's held here. More... | |
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
◆ encryption_wrapper() [1/2]
| octopi::encryption_wrapper::encryption_wrapper | ( | const basis::byte_array & | wrapped = basis::byte_array::empty_array() | ) |
Definition at line 31 of file encryption_wrapper.cpp.
◆ encryption_wrapper() [2/2]
| octopi::encryption_wrapper::encryption_wrapper | ( | const encryption_wrapper & | to_copy | ) |
Definition at line 36 of file encryption_wrapper.cpp.
◆ ~encryption_wrapper()
|
virtual |
Definition at line 42 of file encryption_wrapper.cpp.
Member Function Documentation
◆ clone()
|
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.
◆ DEFINE_CLASS_NAME()
| octopi::encryption_wrapper::DEFINE_CLASS_NAME | ( | "encryption_wrapper" | ) |
◆ encryption_classifier()
|
static |
returns the classifier for this type of infoton.
Referenced by octopi::unwrapping_tentacle::reconstitute().
◆ operator=()
| encryption_wrapper & octopi::encryption_wrapper::operator= | ( | const encryption_wrapper & | to_copy | ) |
Definition at line 47 of file encryption_wrapper.cpp.
References _wrapped.
◆ 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()
|
inlinevirtual |
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().
◆ 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
◆ _wrapped
| basis::byte_array octopi::encryption_wrapper::_wrapped |
the encrypted data that's held here.
this must be a packed classifier string array followed by the packed infoton.
Definition at line 32 of file encryption_wrapper.h.
Referenced by octopi::encryption_tentacle::consume(), operator=(), octopi::SAFE_STATIC_CONST(), and cromp::cromp_server::wrap_infoton().
The documentation for this class was generated from the following files:
- /opt/feistymeow.org/feisty_meow/octopi/library/tentacles/encryption_wrapper.h
- /opt/feistymeow.org/feisty_meow/octopi/library/tentacles/encryption_wrapper.cpp
