entity_defs.h

Go to the documentation of this file.

#ifndef ENTITY_DEFINITIONS_GROUP
#define ENTITY_DEFINITIONS_GROUP
 
/*****************************************************************************\
*                                                                             *
*  Name   : various definitions for octopus                                   *
*  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 "infoton.h"
 
#include <basis/byte_array.h>
#include <basis/astring.h>
#include <structures/set.h>
#include <structures/amorph.h>
#include <structures/unique_id.h>
#include <timely/time_stamp.h>
 
namespace octopi {
 
 
class octopus_entity : public virtual basis::packable, public virtual basis::text_formable
{
public:
  octopus_entity();  
 
  octopus_entity(const basis::astring &hostname, int process_id, int sequencer,
          int add_in);
 
  octopus_entity(const octopus_entity &to_copy);
 
  ~octopus_entity();
 
  octopus_entity &operator = (const octopus_entity &to_copy);
 
  DEFINE_CLASS_NAME("octopus_entity");
 
  bool blank() const;
 
  // comparison operators.
  bool operator == (const octopus_entity &that) const;
 
  const basis::astring &hostname() const;  
  int process_id() const;   
  int sequencer() const;    
  int add_in() const;       
 
  void hostname(const basis::astring &new_host);  
  void process_id(int id);  
  void sequencer(int seq);  
  void add_in(int add);  
 
  basis::astring mangled_form() const;
 
  basis::astring text_form() const;
 
  virtual void text_form(basis::base_string &to_fill) const {
    to_fill.assign(text_form());
  }
 
  basis::astring to_text() const { return mangled_form(); }
  static octopus_entity from_text(const basis::astring &to_convert);
 
  static void breakout(const basis::astring &mangled_form, basis::astring &hostname,
          int &process_id, int &sequencer, int &add_in);
 
  int packed_size() const;
 
  virtual void pack(basis::byte_array &packed_form) const;
  virtual bool unpack(basis::byte_array &packed_form);
 
private:
  basis::astring *_hostname;
  int _pid;
  int _sequencer;
  int _add_in;
};
 
 
 
class octopus_request_id : public virtual basis::packable
{
public:
  octopus_entity _entity;  
  int _request_num;  
 
  octopus_request_id() : _entity(), _request_num(0) {}
 
  octopus_request_id(const octopus_entity &entity, int request_num)
      : _entity(entity), _request_num(request_num) {}
 
  static octopus_request_id randomized_id();
 
  bool operator == (const octopus_request_id &that) const
          { return (_entity == that._entity)
                && (_request_num == that._request_num); }
 
  bool blank() const;
 
  int packed_size() const;
 
  basis::astring mangled_form() const;  
  
  basis::astring text_form() const;  
 
  basis::astring to_text() const { return mangled_form(); }
  static octopus_request_id from_text(const basis::astring &to_convert);
 
  virtual void pack(basis::byte_array &packed_form) const;
  virtual bool unpack(basis::byte_array &packed_form);
};
 
class octopus_request_id_set : public structures::set<octopus_request_id>
{
public:
  octopus_request_id_set() {}
 
  octopus_request_id_set(const structures::set<octopus_request_id> &orig)
      : structures::set<octopus_request_id>(orig) {}
};
 
 
 
class infoton_id_pair : public virtual basis::root_object
{
public:
  infoton *_data;
  octopus_request_id _id;
 
  infoton_id_pair(infoton *data, const octopus_request_id &id)
      : _data(data), _id(id) {}
 
  ~infoton_id_pair() {
    delete _data;
    _data = NULL_POINTER;
  }
};
 
class infoton_list : public structures::amorph<infoton_id_pair> {};
 
} //namespace.
 
#endif