address_base.h

Go to the documentation of this file.

#ifndef ADDRESS_BASE_CLASS
#define ADDRESS_BASE_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : address_base                                                      *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*  Purpose:                                                                   *
*                                                                             *
*    Provides a way to describe an endpoint for communication.                *
*                                                                             *
*******************************************************************************
* Copyright (c) 1995-$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 "sockets_dll.h"

#include <basis/object_base.h>
#include <basis/packable.h>

// forward.
class machine_uid;

class SOCKETS_CLASS_STYLE address_base
: public packable,
  public virtual object_base
{
public:
  virtual ~address_base();

  virtual bool same_host(const address_base &to_compare) const = 0;
  virtual bool same_port(const address_base &to_compare) const = 0;
    // returns true if the host or port are identical.

  virtual bool shareable(const address_base &to_compare) const = 0;
    // returns true if the two transports can be shared.

  virtual istring text_form() const = 0;
    // returns a readable string representing the address.

  virtual int packed_size() const = 0;
    // returns the size that this object should take when packed into bytes.

  // these flip the address into a string and back.  this is different from
  // text_form() because the reversal must be possible.
  virtual istring tokenize() const = 0;
  virtual bool detokenize(const istring &info) = 0;

  virtual machine_uid convert() const = 0;
    // returns the address in the uniquifying format.

  virtual address_base *create_copy() const = 0;
    // creates a new address that's a copy of this one.  note that this
    // allocates memory that must be deleted by the caller.
};

#endif

---