octopus.h

Go to the documentation of this file.

#ifndef OCTOPUS_CLASS
#define OCTOPUS_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : octopus                                                           *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 2001-$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/object_base.h>

// forward.
class entity_data_bin;
class filter_list;
class infoton;
class modula_oblongata;
class octopus_entity;
class octopus_request_id;
class chaos;
class safe_roller;
class string_set;
class tentacle;
class time_stamp;


class OCTOPUS_CLASS_STYLE octopus : public virtual object_base
{
public:
  octopus(const istring &name, int max_size_per_entity);

  virtual ~octopus();

  IMPLEMENT_CLASS_NAME("octopus");

  const istring &name() const;

  // tentacle management functions...

  outcome add_tentacle(tentacle *to_add, bool filter = false);

  outcome remove_tentacle(const string_array &group_name, tentacle * &free_me);

  outcome zap_tentacle(const string_array &group_name);

  // entity management methods...

  octopus_entity issue_identity();

  void expunge(const octopus_entity &to_remove);

  entity_data_bin &responses();

  // main functionality: restoring infotons, evaluating requests and
  // locating responses.

  outcome restore(const string_array &classifier, byte_array &packed_form,
          infoton * &reformed);

  outcome evaluate(infoton *request, const octopus_request_id &item_id,
          bool now = false);

  infoton *acquire_result(const octopus_entity &requester,
          octopus_request_id &original_id);

  infoton *acquire_specific_result(const octopus_request_id &original_id);



  // tentacle accessors: careful with these--you must always unlock after
  // you have locked.

  tentacle *lock_tentacle(const string_array &tentacle_name);

  void unlock_tentacle(tentacle *to_unlock);

  void lock_tentacles();

  // the following are only valid if the tentacle list is locked.
  int locked_tentacle_count();  
  tentacle *locked_get_tentacle(int indy);  
  void unlock_tentacles();  


  // used internally; don't mess with externally.

  void periodic_cleaning();

private:
  istring *_name;  
  modula_oblongata *_tentacles;  
  mutex *_molock;  
  entity_data_bin *_responses;  
  int _disallow_removals;

  time_stamp *_next_cleaning;  
  mutex *_clean_lock;  
  filter_list *_filters;  
  safe_roller *_sequencer;  
  chaos *_rando;  

  // not accessible.
  octopus(const octopus &);
  octopus &operator =(const octopus &);
};

#endif

---