Pivotal GemFire Native Client Cache Reference  9.0.6
EntryEvent.hpp
Go to the documentation of this file.
1 #ifndef _GEMFIRE_ENTRYEVENT_HPP_
2 #define _GEMFIRE_ENTRYEVENT_HPP_
3 /*=========================================================================
4  * Copyright (c) 2002-2014 Pivotal Software, Inc. All Rights Reserved.
5  * This product is protected by U.S. and international copyright
6  * and intellectual property laws. Pivotal products are covered by
7  * more patents listed at http://www.pivotal.io/patents.
8  *=========================================================================
9  */
10 #include "gfcpp_globals.hpp"
11 #include "gf_types.hpp"
12 #include "Region.hpp"
13 #include "CacheableKey.hpp"
14 #include "UserData.hpp"
15 
19 namespace gemfire {
20 
23 {
24  protected:
25 
33  public:
35  EntryEvent( const RegionPtr& region,
36  const CacheableKeyPtr& key,
37  const CacheablePtr& oldValue,
38  const CacheablePtr& newValue,
39  const UserDataPtr& aCallbackArgument,
40  const bool remoteOrigin );
41 
43  virtual ~EntryEvent( ) ;
44 
46  EntryEvent();
47 
48 
50  inline RegionPtr getRegion() const
51  {
52  return m_region;
53  }
54 
56  inline CacheableKeyPtr getKey() const
57  {
58  return m_key;
59  }
60 
65  inline CacheablePtr getOldValue() const
66  {
67  return m_oldValue;
68  }
69 
74  inline CacheablePtr getNewValue() const
75  {
76  return m_newValue;
77  }
78 
85  {
86  return m_callbackArgument;
87  }
88 
90  inline bool remoteOrigin() const
91  {
92  return m_remoteOrigin;
93  }
94 
95  private:
96 
97  // never implemented.
98  EntryEvent( const EntryEvent& other );
99  void operator = ( const EntryEvent& other );
100 
101 
102 
103 };
104 
105 }
106 
107 
108 #endif
Represents an entry event affecting an entry, including its identity and the the circumstances of the...
Definition: EntryEvent.hpp:22
bool m_remoteOrigin
True if from a remote (non-local) process.
Definition: EntryEvent.hpp:31
RegionPtr m_region
Region.
Definition: EntryEvent.hpp:26
bool remoteOrigin() const
If the event originated in a remote process, returns true.
Definition: EntryEvent.hpp:90
This namespace contains all the GemFire C++ API classes, enumerations and globals.
Definition: Assert.hpp:19
UserDataPtr m_callbackArgument
Callback argument for this event, if any.
Definition: EntryEvent.hpp:30
CacheableKeyPtr getKey() const
Definition: EntryEvent.hpp:56
CacheablePtr getNewValue() const
If the event is a destroy or invalidate operation, then the new value will be NULLPTR.
Definition: EntryEvent.hpp:74
UserDataPtr getCallbackArgument() const
Returns the callbackArgument passed to the method that generated this event.
Definition: EntryEvent.hpp:84
CacheableKeyPtr m_key
Cacheable key.
Definition: EntryEvent.hpp:27
#define CPPCACHE_EXPORT
Defines a GemFire CPPCACHE export.
Definition: gf_base.hpp:51
This abstract base class is the base class of all user objects that have the shared capability of ref...
Definition: SharedBase.hpp:31
CacheablePtr getOldValue() const
If the prior state of the entry was invalid, or non-existent/destroyed, then the old value will be NU...
Definition: EntryEvent.hpp:65
RegionPtr getRegion() const
Definition: EntryEvent.hpp:50
CacheablePtr m_oldValue
Old value.
Definition: EntryEvent.hpp:28
CacheablePtr m_newValue
New value.
Definition: EntryEvent.hpp:29

GemFire C++ Cache API Documentation