feisty meow concerns codebase 2.140
bubbles_tentacle Class Reference

#include <crompish_pax.h>

Inheritance diagram for bubbles_tentacle:
Collaboration diagram for bubbles_tentacle:

Public Member Functions

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

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

Detailed Description

Definition at line 110 of file crompish_pax.h.

Constructor & Destructor Documentation

◆ bubbles_tentacle()

bubbles_tentacle::bubbles_tentacle ( bool  backgrounded)
inline

Definition at line 113 of file crompish_pax.h.


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