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_THREAD_LOCAL_REFERENCE_HPP 00008 #define COH_THREAD_LOCAL_REFERENCE_HPP 00009 00010 #include "coherence/lang/compatibility.hpp" 00011 00012 #include "coherence/lang/Object.hpp" 00013 #include "coherence/lang/Reference.hpp" 00014 #include "coherence/lang/TypedHandle.hpp" 00015 00016 COH_OPEN_NAMESPACE2(coherence,lang) 00017 00018 00019 /** 00020 * ThreadLocalReferences provide a means to store a Handle to an Object in 00021 * thread local storage. A single native thread-local is used to manage 00022 * all ThreadLocalReferences, which means that users are free to allocate 00023 * any number of ThreadLocalReferences. 00024 * 00025 * The memory associated with a thread's ThreadLocals is automatically freed 00026 * when then thread terminates. The memory associated with a non-static 00027 * ThreadLocalReference will be automatically freed at some point after the 00028 * ThreadLocalReference has been reclaimed, and is done in such a way that 00029 * repeated creation and destruction of ThreadLocalReferences will not leak 00030 * memory. 00031 */ 00032 class COH_EXPORT ThreadLocalReference 00033 : public class_spec<ThreadLocalReference, 00034 extends<Object>, 00035 implements<Reference> > 00036 { 00037 friend class factory<ThreadLocalReference>; 00038 00039 // ----- constructors --------------------------------------------------- 00040 00041 protected: 00042 /** 00043 * Create a new ThreadLocalReference. 00044 * 00045 * @return a handle to the new ThreadLocalReference 00046 */ 00047 ThreadLocalReference(); 00048 00049 00050 // ----- Object interface ----------------------------------------------- 00051 00052 public: 00053 /** 00054 * {@inheritDoc} 00055 */ 00056 virtual TypedHandle<const String> toString() const; 00057 00058 00059 // ----- Reference<Object> interface ------------------------------------ 00060 00061 public: 00062 /** 00063 * Specify the Object to be referenced by the calling thread. 00064 * 00065 * @param ohObject the referenced object 00066 */ 00067 virtual void set(Object::Holder hObject); 00068 00069 /** 00070 * Return a Holder to the calling threads referenced Object, or 00071 * NULL if none has been set for the thread. 00072 * 00073 * @return a Holder to the referenced Object 00074 */ 00075 virtual Object::Holder get() const; 00076 00077 /** 00078 * Return a Holder to the calling threads referenced Object, or 00079 * NULL if none has been set for the thread. 00080 * 00081 * @return a Holder to the referenced Object 00082 */ 00083 virtual Object::Holder get(); 00084 }; 00085 00086 COH_CLOSE_NAMESPACE2 00087 00088 #endif // COH_THREAD_LOCAL_REFERENCE_HPP