buffer.h

Go to the documentation of this file.

#ifndef BUFFER_CLASS
#define BUFFER_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : buffer                                                            *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 1992-$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 "buffer_base.h"
#include "dll_buffers.h"

// forward:
class buffer_pack_array;
class span_manager;


class BUFFERS_CLASS_STYLE buffer : public buffer_base
{
public:
  buffer(const buffer_key &key, byte_array &contents, int packet_size);

  buffer(const buffer_key &key, int total_packets, int maximum_packet);

  buffer(const buffer_key &key, const buffer_base &to_copy);

  virtual ~buffer();

  IMPLEMENT_CLASS_NAME("buffer");

  virtual bool alive() const;

  virtual int packets() const;

  virtual buffer_key key() const;
  virtual void set_key(const buffer_key &to_set);

  virtual outcome store_packet(int packet_number, const byte_array &buffer);

  virtual byte_array get_packet(int packet_number) const;

  virtual int packet_length(int packet_number) const;

  virtual bool whole() const;

  virtual bool empty() const;

  virtual int full_length(int offset = 0) const;

  virtual int guess_size(int offset = 0);

  virtual bool did_estimate() const;
  virtual void reset_estimate();
  virtual int estimate() const;  

  virtual outcome dump(byte_array &storage_location, int offset = 0);

  virtual void release(int packet_number,
          release_style status_handling = KEEP_STATUS);

  virtual void release();

  virtual istring text_form() const;

  virtual istring detailed_form(bool really_detailed = false) const;

  virtual time_stamp last_add() const;
  virtual void set_last_add(const time_stamp &new_last_add);

  virtual bool owner_alerted() const;
  virtual void set_alerted(bool owner_alerted);

  virtual void get_attachment(byte_array &storage) const;
  virtual void set_attachment(const byte_array &new_attachment);

  virtual span_manager buffer_status() const;
  virtual int_array packet_sizes() const;

  // reference count management: we record the references in terms of
  // connection identifiers.

  int references() const;
  int_set get_references() const;
  void add_reference(int conn_id);
  void remove_reference(int conn_id);

private:
  mutex *_lock;  
  bool _owner_alerted;  
  bool _alive;  
  int _maximum_packet;  
  buffer_key *_key;  
  byte_array *_actual_storage;

  bool _is_storage_active;
  time_stamp *_last_add;
  byte_array *_attachment;
  buffer_pack_array *_packet_list;

  span_manager *_buffer_status;
  int _estimation;  
  int_set *_references;  

  // disallowed operations.
  buffer(const buffer &unused);
  buffer &operator =(const buffer &unused);
};

#endif

---