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

coherence/net/RequestTimeoutException.hpp

/*
* RequestTimeoutException.hpp
*
* Copyright (c) 2000, 2010, Oracle and/or its affiliates. All rights reserved.
*
* Oracle is a registered trademarks of Oracle Corporation and/or its
* affiliates.
*
* This software is the confidential and proprietary information of Oracle
* Corporation. You shall not disclose such confidential and proprietary
* information and shall use it only in accordance with the terms of the
* license agreement you entered into with Oracle.
*
* This notice may not be removed or altered.
*/
#ifndef COH_REQUEST_TIMEOUT_EXCEPTION_HPP
#define COH_REQUEST_TIMEOUT_EXCEPTION_HPP

#include "coherence/lang.ns"

#include "coherence/io/pof/PofReader.hpp"
#include "coherence/io/pof/PofWriter.hpp"
#include "coherence/io/pof/PortableException.hpp"

COH_OPEN_NAMESPACE2(coherence,net)

using coherence::io::pof::PofReader;
using coherence::io::pof::PofWriter;
using coherence::io::pof::PortableException;

/**
* Signals that a request execution in a clustered environment did not
* complete in a pre-determined amount of time. For some specific requests
* this exception could carry a partial execution result.
*
* @author jh  2008.02.14
*/
class COH_EXPORT RequestTimeoutException
    : public throwable_spec<RequestTimeoutException,
        extends<PortableException> >
    {
    friend class factory<RequestTimeoutException>;

    // ----- constructors ---------------------------------------------------

    protected:
        /**
        * Create a RequestTimeoutException.
        *
        * @param vsMsg   the detail message
        * @param vCause  the underlying cause of the exception
        */
        RequestTimeoutException(String::View vsMsg = String::NULL_STRING,
                Exception::View vCause = NULL);


    // ----- RequestTimeoutException interface ------------------------------

    public:
        /**
        * Return a partial execution result that may have been assembled
        * prior to the timeout. The result type is usually the same as the
        * type of the return value for the corresponding request.
        *
        * @return a partial execution result
        */
        virtual Object::Holder getPartialResult() const;

        /**
        * Specify a partial execution result.
        *
        * @param ohPartialResult  a partial execution result
        */
        virtual void setPartialResult(Object::Holder ohPartialResult);


    // ----- PortableObject interface ---------------------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual void readExternal(PofReader::Handle hIn);

        /**
        * {@inheritDoc}
        */
        virtual void writeExternal(PofWriter::Handle hOut) const;


    // ----- data members ---------------------------------------------------

    protected:
        /**
        * Partial execution result (optional).
        */
        MemberHolder<Object> m_ohPartialResult;
    };

COH_CLOSE_NAMESPACE2

#endif // COH_REQUEST_TIMEOUT_EXCEPTION_HPP

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