]>
git.gir.st - tmk_keyboard.git/blob - tmk_core/protocol/usb_hid/arduino-1.0.1/cores/arduino/IPAddress.h
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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
23 * adrianm@mcqn.com 1/1/2011
29 #include <Printable.h>
31 // A class to make it easier to handle and pass around IP addresses
33 class IPAddress
: public Printable
{
35 uint8_t _address
[4]; // IPv4 address
36 // Access the raw byte array containing the address. Because this returns a pointer
37 // to the internal structure rather than a copy of the address this function should only
38 // be used when you know that the usage of the returned uint8_t* will be transient and not
40 uint8_t* raw_address() { return _address
; };
45 IPAddress(uint8_t first_octet
, uint8_t second_octet
, uint8_t third_octet
, uint8_t fourth_octet
);
46 IPAddress(uint32_t address
);
47 IPAddress(const uint8_t *address
);
49 // Overloaded cast operator to allow IPAddress objects to be used where a pointer
50 // to a four-byte uint8_t array is expected
51 operator uint32_t() { return *((uint32_t*)_address
); };
52 bool operator==(const IPAddress
& addr
) { return (*((uint32_t*)_address
)) == (*((uint32_t*)addr
._address
)); };
53 bool operator==(const uint8_t* addr
);
55 // Overloaded index operator to allow getting and setting individual octets of the address
56 uint8_t operator[](int index
) const { return _address
[index
]; };
57 uint8_t& operator[](int index
) { return _address
[index
]; };
59 // Overloaded copy operators to allow initialisation of IPAddress objects from other types
60 IPAddress
& operator=(const uint8_t *address
);
61 IPAddress
& operator=(uint32_t address
);
63 virtual size_t printTo(Print
& p
) const;
65 friend class EthernetClass
;
69 friend class DhcpClass
;
70 friend class DNSClient
;
73 const IPAddress
INADDR_NONE(0,0,0,0);