C++ Client API Reference for Oracle Coherence: coherence/io/InterruptedIOException.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_INTERRUPTED_IO_EXCEPTION_HPP
00008 #define COH_INTERRUPTED_IO_EXCEPTION_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 #include "coherence/io/IOException.hpp"
00013 
00014 COH_OPEN_NAMESPACE2(coherence,io)
00015 
00016 
00017 /**
00018 * Signals that the current thread has been interrupted while blocked on IO.
00019 */
00020 class COH_EXPORT InterruptedIOException
00021     : public throwable_spec<InterruptedIOException,
00022         extends<IOException> >
00023     {
00024     friend class factory<InterruptedIOException>;
00025 
00026     // ----- constructors ---------------------------------------------------
00027 
00028     protected:
00029         /**
00030         * Create an InterruptedIOException.
00031         *
00032         * @param vsMsg             the detail message
00033         * @param cBytesTransfered  the number of bytes transfered during the
00034         *                          blocked operation prior to the interrupt
00035         * @param vCause            the underlying cause of the exception
00036         *
00037         * @return a new InterruptedIOException
00038         */
00039         InterruptedIOException(String::View vsMsg = String::null_string,
00040                 size32_t cBytesTransfered = 0,
00041                 Exception::View vCause = NULL);
00042 
00043     // ----- InterruptedIOException -----------------------------------------
00044 
00045     public:
00046         /**
00047         * Return the number of bytes trasfered during the blocking operation
00048         * prior to the interrupt.
00049         */
00050         virtual size32_t getBytesTransfered() const;
00051 
00052 
00053     // ----- data members ---------------------------------------------------
00054 
00055     public:
00056         /**
00057         * The number of bytes transfered during the blocking operation prior
00058         * to the interrupt.
00059         */
00060         size32_t m_cBytesTransfered;
00061     };
00062 
00063 COH_CLOSE_NAMESPACE2
00064 
00065 #endif // COH_INTERRUPTED_IO_EXCEPTION_HPP