Add a streamable class (Host) that represents an address and port,

or a unix domain socket.

maxutils/maxbase/include/maxbase/host.hh

@@ -0,0 +1,111 @@
+/*
+ * Copyright (c) 2019 MariaDB Corporation Ab
+ *
+ * Use of this software is governed by the Business Source License included
+ * in the LICENSE.TXT file and at www.mariadb.com/bsl11.
+ *
+ * Change Date: 2022-01-01
+ *
+ * On the date above, in accordance with the Business Source License, use
+ * of this software will be governed by version 2 or later of the General
+ * Public License.
+ */
+#pragma once
+
+#include <maxbase/ccdefs.hh>
+
+#include <string>
+#include <iosfwd>
+
+/** Host is a streamable class that represents an address and port, or a unix domain socket.
+ */
+namespace maxbase
+{
+
+class Host;
+
+std::ostream& operator<<(std::ostream&, const Host& host);
+std::istream& operator>>(std::istream&, Host& host);
+
+class Host
+{
+public:
+    enum class Type {Invalid, UnixDomainSocket, HostName, IPV4, IPV6};      // to_string() provided
+    static constexpr int DefaultPort = 3306;
+
+    Host() = default;   // type() returns Type::Invalid
+
+    /**
+     * Constructor
+     * @param str.  A string parsed according to this format (the brackets are real brackets):
+     *              unix_domain_socket | addr | [addr] | [addr]:port
+     *              'addr' is a plain ipv4, ipv6, host name or unix domain socket.
+     *              An ipv6 address with a port must use the format [ipv6]:port.
+     *              A unix domain socket must start with a forward slash ('/') and must not specify a port.
+     *              The default port is 3306.
+     */
+    explicit Host(const std::string& input);
+
+    /**
+     * Constructor
+     * @param addr. Plain ipv4, ipv6, host name or unix domain socket (no brackets or port specifiers).
+     * @param port. A valid port number. Ignored if 'addr' is a unix domain socket (starts with '/').
+     */
+    Host(const std::string& addr, int port);
+
+    Type               type() const;
+    bool               is_valid() const;
+    const std::string& address() const;
+    int                port() const;
+
+    const std::string& org_input() const;       // for better error messages
+private:
+    void set_type(bool port_string_specified);      // set m_type based on m_address and m_port
+
+    std::string m_address;
+    int         m_port = DefaultPort;
+    Type        m_type = Type::Invalid;
+    std::string m_org_input;
+};
+
+std::string to_string(Host::Type type);
+
+// impl below
+inline Host::Type Host::type() const
+{
+    return m_type;
+}
+
+inline bool Host::is_valid() const
+{
+    return m_type != Type::Invalid;
+}
+
+inline const std::string& Host::address() const
+{
+    return m_address;
+}
+
+inline int Host::port() const
+{
+    return m_port;
+}
+
+inline const std::string& Host::org_input() const
+{
+    return m_org_input;
+}
+
+inline bool operator==(const Host& l, const Host& r)
+{
+    bool port_ok = (l.port() == r.port())
+        || (l.type() == Host::Type::UnixDomainSocket && r.type() == Host::Type::UnixDomainSocket);
+
+    return port_ok && l.address() == r.address() && l.type() == r.type();
+}
+
+inline bool operator!=(const Host& l, const Host& r)
+{
+    return !(l == r);
+}
+}