encryption_wrapper Class Reference

Wraps an encrypted infoton when the octopus is in an encrypted mode. More...

#include <encryption_wrapper.h>

Inheritance diagram for encryption_wrapper:

[legend]Collaboration diagram for encryption_wrapper:

[legend]List of all members.

Public Member Functions
	encryption_wrapper (const byte_array &wrapped=byte_array::empty_array())
	encryption_wrapper (const encryption_wrapper &to_copy)
virtual	~encryption_wrapper ()
	IMPLEMENT_CLASS_NAME ("encryption_wrapper")
encryption_wrapper &	operator= (const encryption_wrapper &to_copy)
virtual void	pack (byte_array &packed_form) const
	stuffs the data in the infoton into the "packed_form".
virtual bool	unpack (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 string_array &	encryption_classifier ()
	returns the classifier for this type of infoton.
Public Attributes
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 31 of file encryption_wrapper.h.

---

Constructor & Destructor Documentation

encryption_wrapper::encryption_wrapper

(

const byte_array &

wrapped = byte_array::empty_array()

)

Definition at line 30 of file encryption_wrapper.cpp.

encryption_wrapper::encryption_wrapper

(

const encryption_wrapper &

to_copy

)

Definition at line 35 of file encryption_wrapper.cpp.

encryption_wrapper::~encryption_wrapper

(

)

[virtual]

Definition at line 41 of file encryption_wrapper.cpp.

---

Member Function Documentation

encryption_wrapper::IMPLEMENT_CLASS_NAME

(

"encryption_wrapper"

)

encryption_wrapper & encryption_wrapper::operator=

(

const encryption_wrapper &

to_copy

)

Definition at line 47 of file encryption_wrapper.cpp.

static const string_array& encryption_wrapper::encryption_classifier

(

)

[static]

returns the classifier for this type of infoton.

Referenced by unwrapping_tentacle::reconstitute().

void encryption_wrapper::pack

(

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 infoton.

Definition at line 64 of file encryption_wrapper.cpp.

References _wrapped, and basis::attach().

bool encryption_wrapper::unpack

(

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 infoton.

Definition at line 69 of file encryption_wrapper.cpp.

References _wrapped, and basis::detach().

clonable * encryption_wrapper::clone

(

)

const [virtual]

must be provided to allow creation of a copy of this object.

Implements infoton.

Definition at line 43 of file encryption_wrapper.cpp.

virtual int 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 infoton.

---

Member Data Documentation

byte_array 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 35 of file encryption_wrapper.h.

Referenced by encryption_tentacle::consume(), pack(), unpack(), and cromp_server::wrap_infoton().

---

The documentation for this class was generated from the following files:

• /home/fred/hoople/source/lib_src/library/tentacles/encryption_wrapper.h
• /home/fred/hoople/source/lib_src/library/tentacles/encryption_wrapper.cpp

---