feisty meow concerns codebase  2.140
octopi::unwrapping_tentacle Class Reference

this simple tentacle just unpacks the encryption_wrapper infoton. More...

#include <encryption_wrapper.h>

Inheritance diagram for octopi::unwrapping_tentacle:
Collaboration diagram for octopi::unwrapping_tentacle:

Public Member Functions

 unwrapping_tentacle ()
 
virtual ~unwrapping_tentacle ()
 
 DEFINE_CLASS_NAME ("unwrapping_tentacle")
 
virtual basis::outcome reconstitute (const structures::string_array &classifier, basis::byte_array &packed_form, infoton *&reformed)
 this is a simple enough action that it is totally automated. More...
 
virtual basis::outcome consume (infoton &to_chow, const octopus_request_id &item_id, basis::byte_array &transformed)
 this should never be called. More...
 
- Public Member Functions inherited from octopi::tentacle_helper< encryption_wrapper >
 tentacle_helper (const structures::string_array &classifier, bool backgrounded, int motivational_rate=tentacle::DEFAULT_RATE)
 
virtual ~tentacle_helper ()
 force a virtual destructor. More...
 
virtual basis::outcome consume (infoton &formal(to_chow), const octopus_request_id &formal(item_id), basis::byte_array &transformed)
 consume is not really provided here. remember to implement for servers! More...
 
virtual void expunge (const octopus_entity &formal(to_remove))
 no general actions for expunge; they are all class-specific. More...
 
- Public Member Functions inherited from octopi::tentacle
 tentacle (const structures::string_array &group_name, bool backgrounded, int motivational_rate=tentacle::DEFAULT_RATE)
 constructs a tentacle that handles infotons with the "group_name". More...
 
virtual ~tentacle ()
 
 DEFINE_CLASS_NAME ("tentacle")
 
const structures::string_arraygroup () const
 returns the name of the group that this tentacle services. More...
 
bool backgrounding () const
 reports on whether this tentacle supports background operation or not. More...
 
int motivational_rate () const
 returns the background processing rate this was constructed with. More...
 
virtual void expunge (const octopus_entity &to_remove)=0
 called to remove traces of the entity "to_remove". More...
 
basis::outcome enqueue (infoton *to_chow, const octopus_request_id &item_id)
 holds onto infotons coming from the octopus for backgrounding. More...
 
infotonnext_request (octopus_request_id &item_id)
 pops out the next queued request for processing. More...
 
bool store_product (infoton *product, const octopus_request_id &original_id)
 used by tentacles to store the objects they produce from infotons. More...
 
void attach_storage (entity_data_bin &storage)
 used when a tentacle is being integrated with an octopus. More...
 
void detach_storage ()
 unhooks the storage bin from this tentacle. More...
 
entity_data_binget_storage ()
 returns the current pointer, which might be nil. More...
 
void propel_arm ()
 invoked by our thread to cause requests to be processed. More...
 

Additional Inherited Members

- Public Types inherited from octopi::tentacle
enum  constants { DEFAULT_RATE = 40 }
 
enum  outcomes {
  OKAY = basis::common::OKAY , NOT_FOUND = basis::common::NOT_FOUND , ALREADY_EXISTS = basis::common::EXISTING , BAD_INPUT = basis::common::BAD_INPUT ,
  NO_SPACE = basis::common::NO_SPACE , GARBAGE = basis::common::GARBAGE , DISALLOWED = basis::common::DISALLOWED , NO_HANDLER = basis::common::NO_HANDLER ,
  PARTIAL = basis::common::PARTIAL , ENCRYPTION_MISMATCH = basis::common::ENCRYPTION_MISMATCH
}
 
- Static Public Member Functions inherited from octopi::tentacle
static const char * outcome_name (const basis::outcome &to_name)
 returns the textual form of the outcome "to_name". More...
 

Detailed Description

this simple tentacle just unpacks the encryption_wrapper infoton.

this object should never be doing more than that.

Definition at line 69 of file encryption_wrapper.h.

Constructor & Destructor Documentation

◆ unwrapping_tentacle()

octopi::unwrapping_tentacle::unwrapping_tentacle ( )

Definition at line 78 of file encryption_wrapper.cpp.

◆ ~unwrapping_tentacle()

octopi::unwrapping_tentacle::~unwrapping_tentacle ( )
virtual

Definition at line 83 of file encryption_wrapper.cpp.

Member Function Documentation

◆ consume()

outcome octopi::unwrapping_tentacle::consume ( infoton to_chow,
const octopus_request_id item_id,
basis::byte_array transformed 
)
virtual

this should never be called.

Implements octopi::tentacle.

Definition at line 96 of file encryption_wrapper.cpp.

References FUNCDEF, LOG, and basis::array< contents >::reset().

◆ DEFINE_CLASS_NAME()

octopi::unwrapping_tentacle::DEFINE_CLASS_NAME ( "unwrapping_tentacle"  )

◆ reconstitute()

outcome octopi::unwrapping_tentacle::reconstitute ( const structures::string_array classifier,
basis::byte_array packed_form,
infoton *&  reformed 
)
virtual

this is a simple enough action that it is totally automated.

Reimplemented from octopi::tentacle_helper< encryption_wrapper >.

Definition at line 86 of file encryption_wrapper.cpp.

References octopi::encryption_wrapper::encryption_classifier(), octopi::tentacle::NO_HANDLER, NULL_POINTER, and octopi::reconstituter().


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