C++ Client API Reference for Oracle Coherence: coherence/lang/OutOfMemoryError.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_OUT_OF_MEMORY_ERROR
00008 #define COH_OUT_OF_MEMORY_ERROR
00009 
00010 #include "coherence/lang/compatibility.hpp"
00011 
00012 #include "coherence/lang/Exception.hpp"
00013 #include "coherence/lang/RuntimeException.hpp"
00014 #include "coherence/lang/String.hpp"
00015 
00016 COH_OPEN_NAMESPACE2(coherence,lang)
00017 
00018 
00019 /**
00020 * Thrown to indicate that an attempt to allocate an object failed due to
00021 * resource constraints.
00022 */
00023 class COH_EXPORT OutOfMemoryError
00024     : public throwable_spec<OutOfMemoryError,
00025         extends<RuntimeException, std::bad_alloc> >
00026     {
00027     friend class factory<OutOfMemoryError>;
00028 
00029     // ----- constructors ---------------------------------------------------
00030 
00031     protected:
00032         /**
00033         * Create a OutOfMemoryError.
00034         *
00035         * @param vsMsg   the detail message
00036         * @param vCause  the underlying cause of the exception
00037         */
00038         OutOfMemoryError(String::View vsMsg = String::null_string,
00039                 Exception::View vCause = NULL);
00040 
00041 
00042     // ----- static helpers -------------------------------------------------
00043 
00044     public:
00045         /**
00046         * Ensure that the supplied pointer is non-NULL.  If NULL then an
00047         * OutOfMemoryErrorWill be thrown.
00048         *
00049         * @param pAlloc  the pointer to validate
00050         * @param cb      the size of the allocation request
00051         */
00052         static void ensure(void* pAlloc, size_t cb = 0);
00053     };
00054 
00055 
00056 COH_CLOSE_NAMESPACE2
00057 
00058 #endif // COH_OUT_OF_MEMORY_ERROR