mailbox.h

Go to the documentation of this file.

#ifndef MAILBOX_CLASS
#define MAILBOX_CLASS
 
/*****************************************************************************\
*                                                                             *
*  Name   : mailbox                                                           *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 1998-$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/mutex.h>
#include <structures/set.h>
#include <structures/unique_id.h>
 
namespace processes {
 
class letter;
class mailbox_bank;
 
 
class mailbox : public virtual basis::root_object
{
public:
  mailbox();
  virtual ~mailbox();
 
  void drop_off(const structures::unique_int &id, letter *package);
 
  bool pick_up(const structures::unique_int &id, letter * &package);
 
  int waiting(const structures::unique_int &id) const;
 
  void get_ids(structures::int_set &to_fill);
 
  bool close_out(const structures::unique_int &id);
 
  void show(basis::astring &to_fill);
 
  void clean_up();
 
  void limit_boxes(int max_letters);
 
  enum apply_outcomes {
    OKAY = basis::common::OKAY,   
 
    DEFINE_OUTCOME(APPLY_STOP, -46, "Halt the apply process"),
    DEFINE_OUTCOME(APPLY_WHACK, -47, "Removes the current letter, but "
        "continues"),
    DEFINE_OUTCOME(APPLY_WHACK_STOP, -48, "Halts apply and trashes the "
        "current letter")
  };
 
  typedef basis::outcome apply_function(letter &current, int uid, void *data_link);
 
  void apply(apply_function *to_apply, void *data_link);
 
private:
  basis::mutex *_transaction_lock;  
  mailbox_bank *_packages;  
 
  // prohibited.
  mailbox(const mailbox &);
  mailbox &operator =(const mailbox &);
};
 
} //namespace.
 
#endif