buffer_key.h

Go to the documentation of this file.

#ifndef BUFFER_KEY_CLASS
#define BUFFER_KEY_CLASS

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

#include <data_struct/unique_id.h>

class buffer_id : public unique_int
{
public:
  buffer_id(int initial = 0) : unique_int(initial) {}
};



class BUFFERS_CLASS_STYLE buffer_key
{
public:
  // the "connection" should always be unique on a per program basis (in that
  // there is only one connection referred to by that identifier within this
  // application) and the "msg_id" should always be unique within that
  // connection's buffers.  the "buffer_id" should be unique within this
  // program also, and should be sufficient to find the buffer (once the id
  // is set) from anywhere the buffer might be needed in this program.

  buffer_id buff_id;  
  int connection;     
  int msg_id;         

  buffer_key(buffer_id buff = buffer_id(), int conn = 0, int msg = 0)
          : buff_id(buff), connection(conn), msg_id(msg) {}

  istring text_form() const;

  // these comparators allow keys to be related to each other.
  bool identical(const buffer_key &to_compare) const;
  bool same_buffer_id(const buffer_key &to_compare) const;
  bool same_connection(const buffer_key &to_compare) const;
  bool same_connection_and_message(const buffer_key &to_compare) const;
};

#endif

---