C++ Client API Reference for Oracle Coherence: coherence/net/InetSocketAddress.hpp Source File

00001 /*
00002  * Copyright (c) 2000, 2020, Oracle and/or its affiliates.
00003  *
00004  * Licensed under the Universal Permissive License v 1.0 as shown at
00005  * http://oss.oracle.com/licenses/upl.
00006  */
00007 #ifndef COH_INET_SOCKET_ADDRESS_HPP
00008 #define COH_INET_SOCKET_ADDRESS_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 #include "coherence/net/InetAddress.hpp"
00013 #include "coherence/net/SocketAddress.hpp"
00014 
00015 
00016 
00017 COH_OPEN_NAMESPACE2(coherence,net)
00018 
00019 
00020 /**
00021 * InetSocketAddress represents an endpoint of a IP socket connection.
00022 *
00023 * @author mf  2008.03.13
00024 */
00025 class COH_EXPORT InetSocketAddress
00026     : public abstract_spec<InetSocketAddress,
00027         extends<Object>,
00028         implements<SocketAddress> >
00029     {
00030     friend class factory<InetSocketAddress>;
00031 
00032     // ----- factory methods ------------------------------------------------
00033 
00034     public:
00035         /**
00036         * Create a new InetSocketAddress.
00037         *
00038         * @param vAddr  the IP address of the endpoint
00039         * @param nPort  the port of the endpoint
00040         *
00041         * @return a new InetSocketAddress
00042         */
00043         static InetSocketAddress::Handle create(InetAddress::View vAddr,
00044                 uint16_t nPort);
00045 
00046         /**
00047         * Create a new InetSocketAddress.
00048         *
00049         * @param vsHost    the host name of the endpoint
00050         * @param nPort     the port of the endpoint
00051         * @param fResolve  specifies if the hostname should be resolved
00052         *
00053         * @return a new InetSocketAddress
00054         */
00055         static InetSocketAddress::Handle create(String::View vsHost,
00056                 uint16_t nPort, bool fResolve = true);
00057 
00058 
00059     // ----- InetSocketAddress interface ------------------------------------
00060 
00061     public:
00062         /**
00063         * Return the associated InetAddress.
00064         *
00065         * @return the associated InetAddress.
00066         */
00067         virtual InetAddress::View getAddress() const = 0;
00068 
00069         /**
00070         * Return the associated port.
00071         *
00072         * @return the associated port
00073         */
00074         virtual uint16_t getPort() const = 0;
00075 
00076         /**
00077         * Return the hostname associated with the InetAddress.
00078         *
00079         * @return the associated hostname
00080         */
00081         virtual String::View getHostName() const = 0;
00082 
00083 
00084     // ----- Object interface -----------------------------------------------
00085 
00086     public:
00087         /**
00088         * {@inheritDoc}
00089         */
00090         virtual TypedHandle<const String> toString() const;
00091         };
00092 
00093 COH_CLOSE_NAMESPACE2
00094 
00095 #endif // COH_INET_SOCKET_ADDRESS_HPP