Represents an IP address.
More...
#include <juce_IPAddress.h>
|
| | IPAddress () noexcept |
| | Creates a null address - 0.0.0.0 (IPv4) or ::, (IPv6)
|
| |
| | IPAddress (const String &address) |
| | Parses a string IP address of the form "1.2.3.4" (IPv4) or "1:2:3:4:5:6:7:8" (IPv6).
|
| |
| | IPAddress (const uint16 *bytes) noexcept |
| | Creates an IPv6 address from an array of 8 16-bit integers.
|
| |
| | IPAddress (const uint8 *bytes, bool IPv6=false) noexcept |
| | Creates an IPv4 or IPv6 address by reading 4 or 16 bytes from an array.
|
| |
| | IPAddress (uint16 address1, uint16 address2, uint16 address3, uint16 address4, uint16 address5, uint16 address6, uint16 address7, uint16 address8) noexcept |
| | Creates an IPv6 address from 8 16-bit integers.
|
| |
| | IPAddress (uint32 asNativeEndian32Bit) noexcept |
| | Creates an IPv4 address from a packed 32-bit integer, where the MSB is the first number in the address, and the LSB is the last.
|
| |
| | IPAddress (uint8 address1, uint8 address2, uint8 address3, uint8 address4) noexcept |
| | Creates an IPv4 address from 4 bytes.
|
| |
| int | compare (const IPAddress &) const noexcept |
| | Compares this IPAddress with another.
|
| |
| bool | isNull () const |
| | Returns whether the address contains the null address (e.g.
|
| |
| bool | operator!= (const IPAddress &) const noexcept |
| |
| bool | operator< (const IPAddress &) const noexcept |
| |
| bool | operator<= (const IPAddress &) const noexcept |
| |
| bool | operator== (const IPAddress &) const noexcept |
| |
| bool | operator> (const IPAddress &) const noexcept |
| |
| bool | operator>= (const IPAddress &) const noexcept |
| |
| String | toString () const |
| | Returns a dot- or colon-separated string in the form "1.2.3.4" (IPv4) or "1:2:3:4:5:6:7:8" (IPv6).
|
| |
Represents an IP address.
@tags{Core}
◆ IPAddress() [1/7]
| juce::IPAddress::IPAddress |
( |
| ) |
|
|
noexcept |
Creates a null address - 0.0.0.0 (IPv4) or ::, (IPv6)
◆ IPAddress() [2/7]
| juce::IPAddress::IPAddress |
( |
const uint8 * |
bytes, |
|
|
bool |
IPv6 = false |
|
) |
| |
|
explicitnoexcept |
Creates an IPv4 or IPv6 address by reading 4 or 16 bytes from an array.
- Parameters
-
| bytes | The array containing the bytes to read. |
| IPv6 | if true indicates that 16 bytes should be read instead of 4. |
◆ IPAddress() [3/7]
| juce::IPAddress::IPAddress |
( |
const uint16 * |
bytes | ) |
|
|
explicitnoexcept |
Creates an IPv6 address from an array of 8 16-bit integers.
- Parameters
-
| bytes | The array containing the bytes to read. |
◆ IPAddress() [4/7]
Creates an IPv4 address from 4 bytes.
◆ IPAddress() [5/7]
Creates an IPv6 address from 8 16-bit integers.
◆ IPAddress() [6/7]
| juce::IPAddress::IPAddress |
( |
uint32 |
asNativeEndian32Bit | ) |
|
|
explicitnoexcept |
Creates an IPv4 address from a packed 32-bit integer, where the MSB is the first number in the address, and the LSB is the last.
◆ IPAddress() [7/7]
| juce::IPAddress::IPAddress |
( |
const String & |
address | ) |
|
|
explicit |
Parses a string IP address of the form "1.2.3.4" (IPv4) or "1:2:3:4:5:6:7:8" (IPv6).
◆ any()
Returns an IP address meaning "any", equivalent to 0.0.0.0 (IPv4) or ::, (IPv6)
◆ broadcast()
| static IPAddress juce::IPAddress::broadcast |
( |
| ) |
|
|
staticnoexcept |
Returns an IPv4 address meaning "broadcast" (255.255.255.255)
◆ compare()
| int juce::IPAddress::compare |
( |
const IPAddress & |
| ) |
const |
|
noexcept |
Compares this IPAddress with another.
- Returns
- 0 if the two addresses are identical, negative if this address is smaller than the other one, or positive if is greater.
◆ convertIPv4AddressToIPv4Mapped()
| static IPAddress juce::IPAddress::convertIPv4AddressToIPv4Mapped |
( |
const IPAddress & |
addressToMap | ) |
|
|
static |
Converts an IPv4 address to an IPv4-mapped IPv6 address.
◆ convertIPv4MappedAddressToIPv4()
| static IPAddress juce::IPAddress::convertIPv4MappedAddressToIPv4 |
( |
const IPAddress & |
mappedAddress | ) |
|
|
static |
Converts an IPv4-mapped IPv6 address to an IPv4 address.
If the address is not IPv4-mapped, this will return a null address.
◆ findAllAddresses()
| void juce::IPAddress::findAllAddresses |
( |
Array< IPAddress > & |
results, |
|
|
bool |
includeIPv6 = false |
|
) |
| |
|
static |
Populates a list of all the IP addresses that this machine is using.
◆ getAllAddresses()
Populates a list of all the IP addresses that this machine is using.
◆ getFormattedAddress()
| static String juce::IPAddress::getFormattedAddress |
( |
const String & |
unformattedAddress | ) |
|
|
static |
Returns a formatted version of the provided IPv6 address conforming to RFC 5952 with leading zeros suppressed, lower case characters, and double-colon notation used to represent contiguous 16-bit fields of zeros.
- Parameters
-
| unformattedAddress | the IPv6 address to be formatted |
◆ getInterfaceBroadcastAddress()
| IPAddress juce::IPAddress::getInterfaceBroadcastAddress |
( |
const IPAddress & |
interfaceAddress | ) |
|
|
static |
If the IPAdress is the address of an interface on the machine, returns the associated broadcast address.
If the address is not an interface, it will return a null address.
◆ getLocalAddress()
| static IPAddress juce::IPAddress::getLocalAddress |
( |
bool |
includeIPv6 = false | ) |
|
|
static |
Returns the first 'real' address for the local machine.
Unlike local(), this will attempt to find the machine's actual assigned address rather than "127.0.0.1". If there are multiple network cards, this may return any of their addresses. If it doesn't find any, then it'll return local() as a fallback.
◆ isIPv4MappedAddress()
| static bool juce::IPAddress::isIPv4MappedAddress |
( |
const IPAddress & |
mappedAddress | ) |
|
|
static |
Returns true if the given IP address is an IPv4-mapped IPv6 address.
◆ isNull()
| bool juce::IPAddress::isNull |
( |
| ) |
const |
Returns whether the address contains the null address (e.g.
0.0.0.0).
◆ local()
Returns an IPv4 or IPv6 address meaning "localhost", equivalent to 127.0.0.1 (IPv4) or ::1 (IPv6)
◆ operator!=()
◆ operator<()
◆ operator<=()
◆ operator==()
◆ operator>()
◆ operator>=()
◆ toString()
| String juce::IPAddress::toString |
( |
| ) |
const |
Returns a dot- or colon-separated string in the form "1.2.3.4" (IPv4) or "1:2:3:4:5:6:7:8" (IPv6).
◆ address
| uint8 juce::IPAddress::address[16] |
The elements of the IP address.
◆ isIPv6
| bool juce::IPAddress::isIPv6 = false |
The documentation for this class was generated from the following files:
1.9.8