C++ Client API Reference for Oracle Coherence: coherence/io/pof/PortableException.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_PORTABLE_EXCEPTION_HPP
00008 #define COH_PORTABLE_EXCEPTION_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 #include "coherence/io/pof/PofReader.hpp"
00013 #include "coherence/io/pof/PofWriter.hpp"
00014 #include "coherence/io/pof/PortableObject.hpp"
00015 
00016 COH_OPEN_NAMESPACE3(coherence,io,pof)
00017 
00018 
00019 /**
00020 * A PortableException is an exception that allows information about a remote
00021 * exception or error to be serialized and deserialized to/from a POF stream.
00022 *
00023 * @author jh,mf  2008.01.23
00024 */
00025 class COH_EXPORT PortableException
00026     : public throwable_spec<PortableException,
00027         extends<RuntimeException>,
00028         implements<PortableObject> >
00029     {
00030     friend class factory<PortableException>;
00031 
00032     // ----- constructors ---------------------------------------------------
00033 
00034     protected:
00035         /**
00036         * Construct a PortableException from a Throwable object and an
00037         * additional description.
00038         *
00039         * @param vsMessage  the additional description
00040         * @param ve         the cause exception
00041         */
00042         PortableException(String::View vsMessage = String::null_string,
00043                 Exception::View ve = NULL);
00044 
00045     protected:
00046         /**
00047         * Copy constructor.
00048         */
00049         PortableException(const PortableException&);
00050 
00051 
00052     // ----- PortableObject interface ---------------------------------------
00053 
00054     public:
00055         /**
00056         * {@inheritDoc}
00057         */
00058         virtual void readExternal(PofReader::Handle hIn);
00059 
00060         /**
00061         * {@inheritDoc}
00062         */
00063         virtual void writeExternal(PofWriter::Handle hOut) const;
00064 
00065 
00066     // ----- Exception interface --------------------------------------------
00067 
00068     public:
00069         /**
00070         * {@inheritDoc}
00071         */
00072         virtual String::View getName() const;
00073 
00074         /**
00075         * {@inheritDoc}
00076         */
00077         virtual ObjectArray::View getStackTrace() const;
00078 
00079 
00080     // ----- data members ---------------------------------------------------
00081 
00082     protected:
00083         /**
00084         * The exception's name.
00085         */
00086         mutable FinalView<String> f_vsName;
00087 
00088         /**
00089         * A raw representaion of the remote stack trace for this exception.
00090         */
00091         FinalView<ObjectArray> f_vaStackRemote;
00092     };
00093 
00094 COH_CLOSE_NAMESPACE3
00095 
00096 #endif // COH_PORTABLE_EXCEPTION_HPP