C++ Client API Reference for Oracle Coherence: coherence/io/pof/ReferenceLibrary.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_REFERENCE_LIBRARY_HPP
00008 #define COH_REFERENCE_LIBRARY_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 #include "coherence/util/IdentityHashMap.hpp"
00013 
00014 COH_OPEN_NAMESPACE3(coherence,io,pof)
00015 
00016 using coherence::util::IdentityHashMap;
00017 
00018 
00019 /**
00020 * A "library" of object references and their corresponding identities in
00021 * the POF stream.
00022 * @author wl  2010.09.21
00023 */
00024 class COH_EXPORT ReferenceLibrary
00025       : public class_spec<ReferenceLibrary,
00026         extends <Object> >
00027     {
00028     friend class factory<ReferenceLibrary>;
00029 
00030     // ----- constructors ---------------------------------------------------
00031 
00032     protected:
00033         /**
00034         * @internal
00035         */
00036         ReferenceLibrary();
00037 
00038 
00039     // ----- member methods -------------------------------------------------
00040 
00041     public:
00042         /**
00043         * Look up an identity for an object.
00044         *
00045         * @param v  the object
00046         *
00047         * @return the identity, or -1 if the object is not registered
00048         */
00049         virtual int32_t getIdentity(Object::View v) const;
00050 
00051         /**
00052         * Register an object.
00053         *
00054         * @param v  the object
00055         *
00056         * @return the assigned identity for the object
00057         *
00058         * @throws IllegalStateException  if the object is already registered
00059         */
00060         virtual int32_t registerReference(Object::View v);
00061 
00062 
00063     // ----- data members ---------------------------------------------------
00064 
00065     protected:
00066         /**
00067         * The reference counter.
00068         */
00069         int32_t m_cRefs;
00070 
00071         /**
00072         * A map from objects that can be referenced to their Integer
00073         * identities.
00074         */
00075         FinalHandle<IdentityHashMap> f_hMapIdentities;
00076     };
00077 
00078 COH_CLOSE_NAMESPACE3
00079 
00080 #endif // COH_REFERENCE_LIBRARY_HPP
00081