zing_table.h

Go to the documentation of this file.

#ifndef ZING_TABLE_CLASS
#define ZING_TABLE_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : zing_table                                                        *
*  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 "living_item.h"

#include <basis/object_base.h>

// forward.
class byte_array;
class istring;
class int_set;
class memory_limiter;
class mutex;
class zing_queue_amorph;


class EVENT_FLOW_CLASS_STYLE zing_table : public virtual object_base
{
public:
  zing_table(int overall_memory, int per_user_memory);

  ~zing_table();

  IMPLEMENT_CLASS_NAME("zing_table");

  bool add_client(int new_client_id);

  bool remove_client(int outgoing_client_id);

  void zing_event(int client_id, int event, const byte_array &data);
  void zing_event(int client_id, int event, const byte_array &data,
          const int_set &targets);

  int show_events(int client_id, const istring &name, istring &output,
          int indentation);

  bool pop_event(int client_id, int &event, byte_array &event_data,
          int_set &targets);

  bool peek_event(int client_id, int &event, int &data_length,
          int_set &targets) const;

  bool pop_events(int client_id, int &count, byte_array &event_data,
          int max_size);

  bool peek_events(int client_id, int &count, int &data_length) const;

  void flush_events(int client_id);

private:
  zing_queue_amorph *_clients;  
  mutex *_lock;  
  memory_limiter *_limiter;  

  // forbidden.
  zing_table(const zing_table &);
  zing_table &operator =(const zing_table &);
};

#endif

---