Home | History | Annotate | Download | only in base
      1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
      2 // Use of this source code is governed by a BSD-style license that can be
      3 // found in the LICENSE file.
      4 
      5 #ifndef NET_BASE_IP_ENDPOINT_H_
      6 #define NET_BASE_IP_ENDPOINT_H_
      7 
      8 #include <string>
      9 
     10 #include "base/basictypes.h"
     11 #include "base/compiler_specific.h"
     12 #include "net/base/address_family.h"
     13 #include "net/base/net_export.h"
     14 #include "net/base/net_util.h"
     15 
     16 struct sockaddr;
     17 
     18 namespace net {
     19 
     20 // An IPEndPoint represents the address of a transport endpoint:
     21 //  * IP address (either v4 or v6)
     22 //  * Port
     23 class NET_EXPORT IPEndPoint {
     24  public:
     25   IPEndPoint();
     26   virtual ~IPEndPoint();
     27   IPEndPoint(const IPAddressNumber& address, int port);
     28   IPEndPoint(const IPEndPoint& endpoint);
     29 
     30   const IPAddressNumber& address() const { return address_; }
     31   int port() const { return port_; }
     32 
     33   // Returns AddressFamily of the address.
     34   AddressFamily GetFamily() const;
     35 
     36   // Returns the sockaddr family of the address, AF_INET or AF_INET6.
     37   int GetSockAddrFamily() const;
     38 
     39   // Convert to a provided sockaddr struct.
     40   // |address| is the sockaddr to copy into.  Should be at least
     41   //    sizeof(struct sockaddr_storage) bytes.
     42   // |address_length| is an input/output parameter.  On input, it is the
     43   //    size of data in |address| available.  On output, it is the size of
     44   //    the address that was copied into |address|.
     45   // Returns true on success, false on failure.
     46   bool ToSockAddr(struct sockaddr* address, socklen_t* address_length) const
     47       WARN_UNUSED_RESULT;
     48 
     49   // Convert from a sockaddr struct.
     50   // |address| is the address.
     51   // |address_length| is the length of |address|.
     52   // Returns true on success, false on failure.
     53   bool FromSockAddr(const struct sockaddr* address, socklen_t address_length)
     54       WARN_UNUSED_RESULT;
     55 
     56   // Returns value as a string (e.g. "127.0.0.1:80"). Returns empty
     57   // string if the address is invalid, and cannot not be converted to a
     58   // string.
     59   std::string ToString() const;
     60 
     61   // As above, but without port.
     62   std::string ToStringWithoutPort() const;
     63 
     64   bool operator<(const IPEndPoint& that) const;
     65   bool operator==(const IPEndPoint& that) const;
     66 
     67  private:
     68   IPAddressNumber address_;
     69   int port_;
     70 };
     71 
     72 }  // namespace net
     73 
     74 #endif  // NET_BASE_IP_ENDPOINT_H_
     75