C++ Client API Reference for Oracle Coherence: coherence/net/SocketAddress.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_SOCKET_ADDRESS_HPP
00008 #define COH_SOCKET_ADDRESS_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 
00013 
00014 COH_OPEN_NAMESPACE2(coherence,net)
00015 
00016 
00017 /**
00018 * SocketAddress interface.
00019 *
00020 * @author mf  2008.03.21
00021 */
00022 class COH_EXPORT SocketAddress
00023     : public interface_spec<SocketAddress>
00024     {
00025     // ----- SocketAddress interface ----------------------------------------
00026 
00027     public:
00028         /**
00029         * Identify if the SocketAddress has been resolved.
00030         */
00031         virtual bool isUnresolved() const = 0;
00032 
00033         /**
00034         * Resolve the SocketAddress.
00035         *
00036         * If the address was already in a resolved state the returned address
00037         * may be the original address.
00038         *
00039         * @return a resolved SocketAddress
00040         *
00041         * @throws IOException upon resolution failure.
00042         */
00043         virtual SocketAddress::View resolve() const = 0;
00044     };
00045 
00046 COH_CLOSE_NAMESPACE2
00047 
00048 #endif // COH_SOCKET_ADDRESS_HPP