C++ Client API Reference for Oracle Coherence: coherence/io/pof/IdentityHolder.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_IDENTITY_HOLDER_HPP
00008 #define COH_IDENTITY_HOLDER_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 #include "coherence/io/pof/PofBufferReader.hpp"
00013 
00014 COH_OPEN_NAMESPACE3(coherence,io,pof)
00015 
00016 
00017 /**
00018 * A thread local storage to hold the identity of an object and its corresponding
00019 * POF stream reader.
00020 *
00021 * @author lh  2011.07.19
00022 *
00023 * @since Coherence 3.7.1
00024 */
00025 class COH_EXPORT IdentityHolder
00026       : public class_spec<IdentityHolder,
00027         extends <Object> >
00028     {
00029     friend class factory<IdentityHolder>;
00030 
00031     // ----- member methods -------------------------------------------------
00032 
00033     public:
00034         /**
00035         * Store an identity for an object a POF stream reader just read.
00036         *
00037         * @param hReader  the POF stream reader
00038         * @param nId      the identity of an object
00039         */
00040         static void set(PofBufferReader::Handle hReader, int32_t nId);
00041 
00042         /**
00043         * Register an object.
00044         *
00045         * @param hReader  the POF stream reader
00046         * @param nId      the identity of an object
00047         * @param oh       the object
00048         */
00049         static void reset(PofBufferReader::Handle hReader, int32_t nId, Object::Holder oh);
00050     };
00051 
00052 COH_CLOSE_NAMESPACE3
00053 
00054 #endif // COH_IDENTITY_HOLDER_HPP
00055