Oracle Coherence for C++ API
Release 3.6.1.0
E18813-01

- Main Page
- Namespaces
- Classes
- Files

# coherence/io/pof/PortableException.hpp

    00001 /*
    00002 * PortableException.hpp
    00003 *
    00004 * Copyright (c) 2000, 2010, Oracle and/or its affiliates. All rights reserved.
    00005 *
    00006 * Oracle is a registered trademarks of Oracle Corporation and/or its
    00007 * affiliates.
    00008 *
    00009 * This software is the confidential and proprietary information of Oracle
    00010 * Corporation. You shall not disclose such confidential and proprietary
    00011 * information and shall use it only in accordance with the terms of the
    00012 * license agreement you entered into with Oracle.
    00013 *
    00014 * This notice may not be removed or altered.
    00015 */
    00016 #ifndef COH_PORTABLE_EXCEPTION_HPP
    00017 #define COH_PORTABLE_EXCEPTION_HPP
    00018
    00019 #include "coherence/lang.ns"
    00020
    00021 #include "coherence/io/pof/PofReader.hpp"
    00022 #include "coherence/io/pof/PofWriter.hpp"
    00023 #include "coherence/io/pof/PortableObject.hpp"
    00024
    00025 COH_OPEN_NAMESPACE3(coherence,io,pof)
    00026
    00027
    00028 /**
    00029 * A PortableException is an exception that allows information about a remote
    00030 * exception or error to be serialized and deserialized to/from a POF stream.
    00031 *
    00032 * @author jh,mf  2008.01.23
    00033 */
    00034 class COH_EXPORT PortableException
    00035     : public throwable_spec<PortableException,
    00036         extends<RuntimeException>,
    00037         implements<PortableObject> >
    00038     {
    00039     friend class factory<PortableException>;
    00040
    00041     // ----- constructors ---------------------------------------------------
    00042
    00043     protected:
    00044         /**
    00045         * Construct a PortableException from a Throwable object and an
    00046         * additional description.
    00047         *
    00048         * @param vsMessage  the additional description
    00049         * @param ve         the cause exception
    00050         */
    00051         PortableException(String::View vsMessage = String::NULL_STRING,
    00052                 Exception::View ve = NULL);
    00053
    00054         /**
    00055         * {{@inheritDoc}}
    00056         */
    00057         virtual void onInit();
    00058
    00059     // ----- PortableObject interface ---------------------------------------
    00060
    00061     public:
    00062         /**
    00063         * {@inheritDoc}
    00064         */
    00065         virtual void readExternal(PofReader::Handle hIn);
    00066
    00067         /**
    00068         * {@inheritDoc}
    00069         */
    00070         virtual void writeExternal(PofWriter::Handle hOut) const;
    00071
    00072
    00073     // ----- Exception interface --------------------------------------------
    00074
    00075     public:
    00076         /**
    00077         * {@inheritDoc}
    00078         */
    00079         virtual String::View getName() const;
    00080
    00081         /**
    00082         * {@inheritDoc}
    00083         */
    00084         virtual ObjectArray::View getStackTrace() const;
    00085
    00086
    00087     // ----- data members ---------------------------------------------------
    00088
    00089     protected:
    00090         /**
    00091         * The exception's name.
    00092         */
    00093         MemberView<String> m_vsName;
    00094
    00095         /**
    00096         * A raw representaion of the remote stack trace for this exception.
    00097         */
    00098         MemberView<ObjectArray> m_vaStackRemote;
    00099     };
    00100
    00101 COH_CLOSE_NAMESPACE3
    00102
    00103 #endif // COH_PORTABLE_EXCEPTION_HPP

Copyright © 2000, 2010, Oracle and/or its affiliates. All rights reserved.