socketaddress.h

Go to the documentation of this file.

/*
 *  $Id: socketaddress.h 1259 2011-12-17 13:26:09Z dreibh $
 *
 * SocketAPI implementation for the sctplib.
 * Copyright (C) 1999-2012 by Thomas Dreibholz
 *
 * Realized in co-operation between
 * - Siemens AG
 * - University of Essen, Institute of Computer Networking Technology
 * - University of Applied Sciences, Muenster
 *
 * Acknowledgement
 * This work was partially funded by the Bundesministerium fuer Bildung und
 * Forschung (BMBF) of the Federal Republic of Germany (Foerderkennzeichen 01AK045).
 * The authors alone are responsible for the contents.
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 * Contact: discussion@sctp.de
 *          dreibh@iem.uni-due.de
 *          tuexen@fh-muenster.de
 *
 * Purpose: Socket Adress
 *
 */


#ifndef SOCKETADDRESS_H
#define SOCKETADDRESS_H


#include "tdsystem.h"
#include "tdstrings.h"


#include <sys/socket.h>
#include <sys/un.h>



class SocketAddress
{
   // ====== Destructor =====================================================
   public:
   virtual ~SocketAddress();


   // ====== Duplication ====================================================
   virtual SocketAddress* duplicate() const = 0;


   // ====== Reset ==========================================================
   virtual void reset() = 0;


   // ====== Check, if address is valid =====================================
   virtual bool isValid() const = 0;


   // ====== Print format ===================================================
   enum PrintFormat {
      PF_Address  = (1 << 0),

      PF_Hostname = (1 << 1),

      PF_Full = (PF_Address | PF_Hostname),

      PF_HidePort = (1 << 15),

      PF_Legacy = (1 << 16),

      PF_Default = (PF_Address | PF_Legacy)
   };


   inline cardinal getPrintFormat() const;

   inline void setPrintFormat(const cardinal format);


   // ====== Address management =============================================
   virtual card16 getPort() const = 0;

   virtual void setPort(const card16 port) = 0;

   virtual integer getFamily() const = 0;


   // ====== Get local address for a connection =============================
   static SocketAddress* getLocalAddress(const SocketAddress& peer);


   // ====== Get address string =============================================
   virtual String getAddressString(const cardinal format = PF_Default) const = 0;


   // ====== SocketAddress creation =========================================
   static SocketAddress* createSocketAddress(const integer family);

   static SocketAddress* createSocketAddress(const cardinal flags, const String& name);

   static SocketAddress* createSocketAddress(const cardinal flags,
                                             const String&  name,
                                             const card16   port);

   static SocketAddress* createSocketAddress(const cardinal  flags,
                                             sockaddr*       address,
                                             const socklen_t length);


   // ====== Get/set system sockaddr structure ==============================
   virtual cardinal getSystemAddress(sockaddr*       buffer,
                                     const socklen_t length,
                                     const cardinal  type = AF_UNSPEC) const = 0;

   virtual bool setSystemAddress(const sockaddr* address, const socklen_t length) = 0;


   // ====== SocketAddress lists ============================================
   static SocketAddress** newAddressList(const cardinal entries);

   static void deleteAddressList(SocketAddress**& addressArray);


   // ====== Constants ======================================================
   static const cardinal MaxSockLen =
      (sizeof(sockaddr_un) > sizeof(sockaddr_storage)) ? sizeof(sockaddr_un) : sizeof(sockaddr_storage);


   // ====== Protected data =================================================
   protected:
   cardinal Format;


   friend inline std::ostream& operator<<(std::ostream& os, const SocketAddress& sa);
};


inline std::ostream& operator<<(std::ostream& os, const SocketAddress& sa);


#include "socketaddress.icc"


#endif