C++ Client API Reference for Oracle Coherence: coherence/net/messaging/ConnectionException.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_CONNECTION_EXCEPTION_HPP
00008 #define COH_CONNECTION_EXCEPTION_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 #include "coherence/io/pof/PortableException.hpp"
00013 
00014 COH_OPEN_NAMESPACE3(coherence,net,messaging)
00015 
00016 using coherence::io::pof::PortableException;
00017 
00018 /**
00019 * Signals that an underlying communication channel used by a Connection may
00020 * have been closed, severed, or become unusable.
00021 *
00022 * After this exception is thrown, any attempt to use the Connection (or any
00023 * Channel created by the Connection) may result in an exception.
00024 *
00025 * @author jh  2007.12.19
00026 */
00027 class COH_EXPORT ConnectionException
00028     : public throwable_spec<ConnectionException,
00029         extends<PortableException> >
00030     {
00031     friend class factory<ConnectionException>;
00032 
00033     // ----- constructors ---------------------------------------------------
00034 
00035     protected:
00036         /**
00037         * Create a ConnectionException.
00038         *
00039         * @param vsMsg        the detail message
00040         * @param vCause       the underlying cause of the exception
00041         * @param vConnection  the connection where the exception occurred
00042         *
00043         * @return a new ConnectionException
00044         */
00045         ConnectionException(String::View vsMsg = String::null_string,
00046                 Exception::View vCause = NULL,
00047                 Object::View vConnection = NULL);
00048 
00049     protected:
00050         /**
00051         * Blocked copy constructor.
00052         */
00053         ConnectionException(const ConnectionException&);
00054     };
00055 
00056 COH_CLOSE_NAMESPACE3
00057 
00058 #endif // COH_CONNECTION_EXCEPTION_HPP