tentacle.h

Go to the documentation of this file.

#ifndef TENTACLE_CLASS
#define TENTACLE_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : tentacle                                                          *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 2002-$now By Author.  This program is free software; you can  *
* redistribute it and/or modify it under the terms of the GNU General Public  *
* License as published by the Free Software Foundation; either version 2 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/

#include "dll_octopus.h"

#include <basis/byte_array.h>

// forward.
class entity_data_bin;
class infoton;
class octopus;
class octopus_entity;
class octopus_request_id;
class pod_motivator;
class queueton;


class OCTOPUS_CLASS_STYLE tentacle : public virtual object_base
{
public:
  tentacle(const string_array &group_name, bool backgrounded,
          int motivational_rate = tentacle::DEFAULT_RATE);

  virtual ~tentacle();

  enum constants { DEFAULT_RATE = 40 };

  IMPLEMENT_CLASS_NAME("tentacle");

  const string_array &group() const;

  bool backgrounding() const { return _backgrounded; }

  int motivational_rate() const;

  enum outcomes {
    OKAY = common::OKAY,
    NOT_FOUND = common::NOT_FOUND,
    ALREADY_EXISTS = common::EXISTING,
    BAD_INPUT = common::BAD_INPUT,
    NO_SPACE = common::NO_SPACE,
    GARBAGE = common::GARBAGE,
    DISALLOWED = common::DISALLOWED,

    NO_HANDLER = common::NO_HANDLER,  
    PARTIAL = common::PARTIAL,  
    ENCRYPTION_MISMATCH = common::ENCRYPTION_MISMATCH
  };

  static const char *outcome_name(const outcome &to_name);


  // functions that must be provided by derived tentacles.

  virtual outcome reconstitute(const string_array &classifier,
          byte_array &packed_form, infoton * &reformed) = 0;

  virtual outcome consume(infoton &to_chow, const octopus_request_id &item_id,
          byte_array &transformed) = 0;

  virtual void expunge(const octopus_entity &to_remove) = 0;



  outcome enqueue(infoton *to_chow, const octopus_request_id &item_id);

  infoton *next_request(octopus_request_id &item_id);

  bool store_product(infoton *product, const octopus_request_id &original_id);



  // support that is for internal use only.

  void attach_storage(entity_data_bin &storage);

  void detach_storage();

  void propel_arm();
 
private:
  string_array *_group;  
  queueton *_pending;  
  mutex *_input_guard;  
  pod_motivator *_action;  
  entity_data_bin *_products;  
  bool _backgrounded;  

  // not permitted.
  tentacle(const tentacle &);
  tentacle &operator =(const tentacle &);
};

#endif

---