UT_NetUtil.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        UT_NetUtil.h (UT Library, C++)
 *
 * COMMENTS:
 */

#ifndef __UT_NETUTIL_H_INCLUDED__
#define __UT_NETUTIL_H_INCLUDED__

#include "UT_API.h"

#ifdef _WIN32
    #include <ws2tcpip.h>
#else
    #include <netinet/in.h>
#endif

/// @file
/// Common network utilities

template <typename T> class UT_Array;
class UT_IpAddress;
class UT_IpAddressV4;
class UT_String;
class UT_StringHolder;
class UT_StringRef;
class UT_WorkBuffer;

/// Given host, resolves it to the canonical name if possible.
/// If false is returned, then host is untouched.
UT_API extern bool UTresolveCanonicalHostname(UT_String& host, UT_StringHolder& error);

/// Convert an IP address to a hostname
/// @{
UT_API extern UT_StringHolder UTipAddressToHostname(const UT_StringRef& ip_address, UT_StringHolder& error);
UT_API extern UT_StringHolder UTipAddressToHostname(const UT_IpAddress& address, UT_StringHolder& error);
/// @}

/// Convert either an IP address or host alias to its given name.
UT_API extern bool UTgetHostnameByAlias(UT_StringHolder& host, const char* alias, UT_StringHolder& error);

/// Remove the domain name and append back the port number if provided.
/// i.e. matane.local -> matane, matane.local:3080 -> matane:3080
/// @{
UT_API extern void UTstripDomainName(UT_String& host);
UT_API extern void UTstripDomainName(UT_WorkBuffer& host);
/// @}

/// Check if the ports match both hosts ports
/// @{
UT_API extern bool UTdoPortsMatch(const UT_String& host1, const UT_String& host2);
UT_API extern bool UTdoPortsMatch(const UT_WorkBuffer& host1, const UT_WorkBuffer& host2);
/// @}

/// Check if string is at a delimeter (at end of string or at '.')
UT_API extern bool UTatHostnameDelimeter(const char* p);

/// Check if rest of string is non alpha character from a hostname
UT_API extern bool UTisHostnameAllNonAlpha(const char* str);

/// Get list of IP addresses for local interfaces on this machine
UT_API extern bool UTgetLocalInterfaces(UT_Array<UT_IpAddress> &local_addrs);

/// Convert a hostname to a list of resolved ip addresses
UT_API extern bool UThostnameToIpAddress(
        const UT_StringRef& host,
        UT_Array<UT_IpAddress>& address);

#endif // __UT_NETUTIL_H_INCLUDED__