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 <basis/contracts.h>
#include <mathematics/chaos.h>
#include <processes/safe_roller.h>
#include <structures/set.h>
#include <timely/time_stamp.h>
 
namespace octopi {
 
// forward.
class entity_data_bin;
class filter_list;
class infoton;
class modula_oblongata;
class octopus_entity;
class octopus_request_id;
class tentacle;
 
 
class octopus : public virtual basis::root_object
{
public:
  octopus(const basis::astring &name, int max_size_per_entity);
 
  virtual ~octopus();
 
  DEFINE_CLASS_NAME("octopus");
 
  const basis::astring &name() const;
 
  // tentacle management functions...
 
  basis::outcome add_tentacle(tentacle *to_add, bool filter = false);
 
  basis::outcome remove_tentacle(const structures::string_array &group_name, tentacle * &free_me);
 
  basis::outcome zap_tentacle(const structures::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.
 
  basis::outcome restore(const structures::string_array &classifier, basis::byte_array &packed_form,
          infoton * &reformed);
 
  basis::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 structures::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:
  basis::astring *_name;  
  modula_oblongata *_tentacles;  
  basis::mutex *_molock;  
  entity_data_bin *_responses;  
  int _disallow_removals;
 
  timely::time_stamp *_next_cleaning;  
  basis::mutex *_clean_lock;  
  filter_list *_filters;  
  processes::safe_roller *_sequencer;  
  mathematics::chaos *_rando;  
 
  // not accessible.
  octopus(const octopus &);
  octopus &operator =(const octopus &);
};
 
} //namespace.
 
#endif