InetAddrBSD.h

Go to the documentation of this file.

/****************** <VPR heading BEGIN do not edit this line> *****************
 *
 * VR Juggler Portable Runtime
 *
 * Original Authors:
 *   Allen Bierbaum, Patrick Hartling, Kevin Meinert, Carolina Cruz-Neira
 *
 * -----------------------------------------------------------------
 * File:          $RCSfile$
 * Date modified: $Date: 2005-12-16 08:07:50 -0600 (Fri, 16 Dec 2005) $
 * Version:       $Revision: 18288 $
 * -----------------------------------------------------------------
 *
 ****************** <VPR heading END do not edit this line> ******************/

/*************** <auto-copyright.pl BEGIN do not edit this line> **************
 *
 * VR Juggler is (C) Copyright 1998-2005 by Iowa State University
 *
 * Original Authors:
 *   Allen Bierbaum, Christopher Just,
 *   Patrick Hartling, Kevin Meinert,
 *   Carolina Cruz-Neira, Albert Baker
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 *************** <auto-copyright.pl END do not edit this line> ***************/

#ifndef _VPR_INET_ADDR_BSD_H_
#define _VPR_INET_ADDR_BSD_H_

#include <vpr/vprConfig.h>

#include <sys/types.h>
#include <netinet/in.h>
#include <string>
#include <vector>

#include <vpr/IO/Socket/InetAddrBase.h>
#include <vpr/IO/Socket/SocketTypes.h>


// XXX: Extend to work with IPv6.

namespace vpr
{

// Forward declare this.  It is defined in vpr/IO/Socket/InetAddr.h which may
// not be included by this file.
struct InetAddrHash;

class InetAddrBSD : public InetAddrBase
{
public:
   static const InetAddrBSD AnyAddr;

   typedef vpr::InetAddrHash hash;

   InetAddrBSD();

   InetAddrBSD(const InetAddrBSD& addr)
   {
      copy(addr);
   }

   static vpr::ReturnStatus getLocalHost(vpr::InetAddrBSD& hostAddr);

   static vpr::ReturnStatus
      getAllLocalAddrs(std::vector<vpr::InetAddrBSD>& hostAddrs,
                       const bool withLoopback = false);

   vpr::ReturnStatus setAddress(const std::string& address);

   vpr::ReturnStatus setAddress(const std::string& address, const Uint16 port);

   vpr::ReturnStatus setAddress(const vpr::Uint32 address,
                                const vpr::Uint16 port);

   unsigned char getLength() const;

   void setLength(const unsigned char length);

   vpr::SocketTypes::Domain getFamily() const;

   void setFamily(const vpr::SocketTypes::Domain family);

   vpr::Uint16 getPort() const;

   void setPort(const vpr::Uint16 port);

   vpr::Uint32 getAddressValue() const;

   std::string getAddressString() const;

   vpr::ReturnStatus getHostname(std::string& hostname) const;

   std::vector<std::string> getHostnames() const;

   InetAddrBSD& operator= (const InetAddrBSD& addr)
   {
      copy(addr);
      return *this;
   }

   bool operator== (const InetAddrBSD& addr) const;

   bool operator!= (const InetAddrBSD& addr) const
   {
      return ! (*this == addr);
   }

protected:
   friend class vpr::SocketImplBSD;
   friend class vpr::SocketDatagramImplBSD;
   friend class vpr::SocketStreamImplBSD;

   InetAddrBSD(const struct sockaddr* addr)
   {
      setSockaddr(addr);
   }

   void copyAddressValue(const char* addrValue);

   void setAddressValue(const vpr::Uint32 addrValue);

   size_t size() const;

   size_t addressSize() const;

   void setSockaddr(const struct sockaddr* addr);

   struct sockaddr_in toSockaddrInet();

   void copy(const InetAddrBSD& addr);

   vpr::ReturnStatus lookupAddress(const std::string& addr);

   struct sockaddr_in mAddr;    
};

} // End of vpr namespace


#endif   /* _VPR_INET_ADDR_H_ */

---