juce_IPAddress.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   The code included in this file is provided under the terms of the ISC license
   http://www.isc.org/downloads/software-support-policy/isc-license. Permission
   To use, copy, modify, and/or distribute this software for any purpose with or
   without fee is hereby granted provided that the above copyright notice and
   this permission notice appear in all copies.
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  IPAddress  final
{
public:
    //==============================================================================
    static IPAddress any() noexcept;

    static IPAddress broadcast() noexcept;

    static IPAddress local (bool IPv6 = false) noexcept;
 
    //==============================================================================
    static void findAllAddresses (Array<IPAddress>& results, bool includeIPv6 = false);

    static Array<IPAddress> getAllAddresses (bool includeIPv6 = false);

    static IPAddress getLocalAddress (bool includeIPv6 = false);
 
    //==============================================================================
    IPAddress() noexcept;

    explicit IPAddress (const uint8* bytes, bool IPv6 = false) noexcept;

    explicit IPAddress (const uint16* bytes) noexcept;

    IPAddress (uint8 address1, uint8 address2, uint8 address3, uint8 address4) noexcept;

    IPAddress (uint16 address1, uint16 address2, uint16 address3, uint16 address4,
               uint16 address5, uint16 address6, uint16 address7, uint16 address8) noexcept;

    explicit IPAddress (uint32 asNativeEndian32Bit) noexcept;

    explicit IPAddress (const String& address);

    bool isNull() const;
 
    //==============================================================================
    String toString() const;

    int compare (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;
    bool operator>= (const IPAddress&) const noexcept;
 
    //==============================================================================
    uint8 address[16];
 
    bool isIPv6 = false;
 
    //==============================================================================
    static String getFormattedAddress (const String& unformattedAddress);

    static bool isIPv4MappedAddress (const IPAddress& mappedAddress);

    static IPAddress convertIPv4MappedAddressToIPv4 (const IPAddress& mappedAddress);

    static IPAddress convertIPv4AddressToIPv4Mapped (const IPAddress& addressToMap);

    static IPAddress getInterfaceBroadcastAddress (const IPAddress& interfaceAddress);
};
 
} // namespace juce