1  /*
 2   *
 3   * MIT License:
 4   * Copyright (c) 2011 Adrian McEwen
 5   * Permission is hereby granted, free of charge, to any person obtaining a copy
 6   * of this software and associated documentation files (the "Software"), to deal
 7   * in the Software without restriction, including without limitation the rights
 8   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9   * copies of the Software, and to permit persons to whom the Software is
10   * furnished to do so, subject to the following conditions:
11   * 
12   * The above copyright notice and this permission notice shall be included in
13   * all copies or substantial portions of the Software.
14   * 
15   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21   * THE SOFTWARE.
22   *
23   * adrianm@mcqn.com 1/1/2011
24   */
25  
26  #if ARDUINO >= 100
27  #ifndef IPAddress_h
28  #define IPAddress_h
29  
30  #include <Printable.h>
31  
32  // A class to make it easier to handle and pass around IP addresses
33  
34  class IPAddress : public Printable {
35  private:
36      uint8_t _address[4];  // IPv4 address
37      // Access the raw byte array containing the address.  Because this returns a pointer
38      // to the internal structure rather than a copy of the address this function should only
39      // be used when you know that the usage of the returned uint8_t* will be transient and not
40      // stored.
41      uint8_t* raw_address() { return _address; };
42  
43  public:
44      // Constructors
45      IPAddress();
46      IPAddress(uint8_t first_octet, uint8_t second_octet, uint8_t third_octet, uint8_t fourth_octet);
47      IPAddress(uint32_t address);
48      IPAddress(const uint8_t *address);
49  
50      // Overloaded cast operator to allow IPAddress objects to be used where a pointer
51      // to a four-byte uint8_t array is expected
52      operator uint32_t() { return *((uint32_t*)_address); };
53      bool operator==(const IPAddress& addr) { return (*((uint32_t*)_address)) == (*((uint32_t*)addr._address)); };
54      bool operator==(const uint8_t* addr);
55  
56      // Overloaded index operator to allow getting and setting individual octets of the address
57      uint8_t operator[](int index) const { return _address[index]; };
58      uint8_t& operator[](int index) { return _address[index]; };
59  
60      // Overloaded copy operators to allow initialisation of IPAddress objects from other types
61      IPAddress& operator=(const uint8_t *address);
62      IPAddress& operator=(uint32_t address);
63  
64      virtual size_t printTo(Print& p) const;
65  
66      friend class EthernetClass;
67      friend class UDP;
68      friend class Client;
69      friend class Server;
70      friend class DhcpClass;
71      friend class DNSClient;
72  };
73  
74  const IPAddress INADDR_NONE(0,0,0,0);
75  
76  
77  #endif
78  #endif