Source: packetaddress.h


Annotated List
Files
Globals
Hierarchy
Index

/*
 *  $Id: packetaddress_h.html,v 1.4 2001/11/30 14:02:34 dreibh Exp $
 *
 * SCTP implementation according to RFC 2960.
 * Copyright (C) 1999-2001 by Thomas Dreibholz
 *
 * Realized in co-operation between Siemens AG
 * and University of Essen, Institute of Computer Networking Technology.
 *
 * 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 program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * There are two mailinglists available at www.sctp.de which should be used for
 * any discussion related to this implementation.
 *
 * Contact: discussion@sctp.de
 *          dreibh@exp-math.uni-essen.de
 *
 * Purpose: Packet address implementation
 *
 */


#ifndef PACKETADDRESS_H
#define PACKETADDRESS_H


#include "tdsystem.h"
#include "strings.h"
#include "socketaddress.h"


#if (SYSTEM == OS_Linux)

#include <linux/if.h>


namespace Coral {


/**
  * This class manages a packet socket address.
  *
  * @short   Packet Address
  * @author  Thomas Dreibholz (dreibh@exp-math.uni-essen.de)
  * @version 1.0
  */            
class PacketAddress : virtual public SocketAddress
{
   // ====== Constructors/Destructor ========================================
   public:
   /**
     * Constructor for an empty packet address.
     */
   PacketAddress();

   /**
     * Constructor for an packet address from an packet address.
     *
     * @param address Packet address.
     */
   PacketAddress(const PacketAddress& address);

   /**
     * Constructor for a packet address given by a string.
     * Examples: "/tmp/test.socket".
     *
     * @param name Address string.
     */
   PacketAddress(const String& name);

   /**
     * Constructor for a packet address from the system's sockaddr structure.
     *
     * @param address sockaddr.
     * @param length Length of sockaddr.
     */
   PacketAddress(sockaddr* address, cardinal length);

   /**
     * Destructor.
     */
   ~PacketAddress();


   // ====== Initialization =================================================
   /**
     * Reset packet address.
     */
   void reset();

   /**
     * Initialize packet address from packet address.
     */
   void init(const PacketAddress& address);

   /**
     * Initialize packet address from socket name.
     */
   void init(const String& name);

   /**
     * Implementation of = operator.
     */
   inline PacketAddress& operator=(const PacketAddress& source);


   // ====== Address functions ==============================================
   /**
     * isValid() implementation of SocketAddress.
     *
     * @see SocketAddress#isValid
     */
   bool isValid() const;

   /**
     * getFamily() implementation of SocketAddress.
     *
     * @see SocketAddress#getFamily
     */
   integer getFamily() const;

   /**
     * getAddressString() implementation of SocketAddress.
     *
     * @see SocketAddress#getAddress
     */
   String getAddressString(const cardinal format = PF_Default) const;

   /**
     * Check, if the address is null.
     *
     * @return true, if the address is not null; false otherwise.
     */
   inline bool isNull() const;


   // ====== getPort() dummy ================================================
   /**
     * getPort() implementation of SocketAddress.
     *
     * @see SocketAddress#getPort
     */
   card16 getPort() const;

   /**
     * setPort() implementation of SocketAddress.
     *
     * @see SocketAddress#setPort
     */
   void setPort(const card16 port);


   // ====== Get/set system sockaddr structure ==============================
   /**
     * getSystemAddress() implementation of SocketAddress
     *
     * @see SocketAddress#getSystemAddress
     */
   cardinal getSystemAddress(sockaddr*       buffer,
                             const socklen_t length,
                             const cardinal  type) const;

   /**
     * setSystemAddress() implementation of SocketAddress.
     *
     * @see SocketAddress#setSystemAddress
     */
   bool setSystemAddress(sockaddr* address, const socklen_t length);


    // ====== Comparision operators =========================================
   /**
     * Implementation of == operator.
     */
   int operator==(const PacketAddress& address) const;

   /**
     * Implementation of != operator.
     */
   inline int operator!=(const PacketAddress& address) const;

   /**
     * Implementation of < operator.
     */
   int operator<(const PacketAddress& address) const;

   /**
     * Implementation of <= operator.
     */
   inline int operator<=(const PacketAddress& address) const;

   /**
     * Implementation of > operator.
     */
   int operator>(const PacketAddress& address) const;

   /**
     * Implementation of >= operator.
     */
   inline int operator>=(const PacketAddress& address) const;


   // ====== Private data ===================================================
   private:
   static const cardinal MaxNameLength = IFNAMSIZ - 1;

   char Name[MaxNameLength + 1];
};


}


#include "packetaddress.icc"


#endif


#endif

Generated by: dreibh@kappes on Fri Nov 30 14:03:21 2001, using kdoc 2.0a53.