C++ Client API Reference for Oracle Coherence: coherence/util/processor/PreloadRequest.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_PRELOAD_REQUEST_HPP
00008 #define COH_PRELOAD_REQUEST_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 #include "coherence/util/InvocableMap.hpp"
00016 #include "coherence/util/ValueExtractor.hpp"
00017 #include "coherence/util/processor/AbstractProcessor.hpp"
00018 
00019 COH_OPEN_NAMESPACE3(coherence,util, processor)
00020 
00021 using coherence::io::pof::PofReader;
00022 using coherence::io::pof::PofWriter;
00023 using coherence::io::pof::PortableObject;
00024 using coherence::util::InvocableMap;
00025 using coherence::util::ValueExtractor;
00026 
00027 
00028 /**
00029 * PreloadRequest is a simple EntryProcessor that performs a
00030 * InvocableMap::Entry#getValue() call. No results are reported back to the
00031 * caller.
00032 *
00033 * The PreloadRequest process provides a means to "pre-load" an entry or a
00034 * collection of entries into the cache using the cache's loader without
00035 * incurring the cost of sending the value(s) over the network. If the
00036 * corresponding entry (or entries) already exists in the cache, or if the
00037 * cache does not have a loader, then invoking this EntryProcessor has no
00038 * effect.
00039 *
00040 * @author tb  2008.04.28
00041 */
00042 class COH_EXPORT PreloadRequest
00043     : public class_spec<PreloadRequest,
00044         extends<AbstractProcessor>,
00045         implements<PortableObject> >
00046     {
00047     friend class factory<PreloadRequest>;
00048 
00049     // ----- constructors ---------------------------------------------------
00050 
00051     protected:
00052         /**
00053         * Construct a PreloadRequest.
00054         */
00055         PreloadRequest();
00056 
00057 
00058     // ----- InvocableMap::EntryProcessor interface -------------------------
00059 
00060     public:
00061         /**
00062         * {@inheritDoc}
00063         */
00064         virtual Object::Holder process(
00065                 InvocableMap::Entry::Handle hEntry) const;
00066 
00067         /**
00068         * {@inheritDoc
00069         */
00070         virtual Map::View processAll(Set::View vsetEntries) const;
00071 
00072 
00073     // ----- PortableObject interface ---------------------------------------
00074 
00075     public:
00076         /**
00077         * {@inheritDoc}
00078         */
00079         virtual void readExternal(PofReader::Handle hIn);
00080 
00081         /**
00082         * {@inheritDoc}
00083         */
00084         virtual void writeExternal(PofWriter::Handle hOut) const;
00085 
00086 
00087     // ----- Object interface -----------------------------------------------
00088 
00089     public:
00090         /**
00091         * {@inheritDoc}
00092         */
00093         virtual bool equals(Object::View v) const;
00094 
00095         /**
00096         * {@inheritDoc}
00097         */
00098         virtual size32_t hashCode() const;
00099 
00100     };
00101 
00102 COH_CLOSE_NAMESPACE3
00103 
00104 #endif // COH_PRELOAD_REQUEST_HPP