VMware GemFire Native C++ Reference  9.1
RegionEvent.hpp
Go to the documentation of this file.
1 #pragma once
2 
3 #ifndef GEODE_REGIONEVENT_H_
4 #define GEODE_REGIONEVENT_H_
5 
6 /*
7  * Licensed to the Apache Software Foundation (ASF) under one or more
8  * contributor license agreements. See the NOTICE file distributed with
9  * this work for additional information regarding copyright ownership.
10  * The ASF licenses this file to You under the Apache License, Version 2.0
11  * (the "License"); you may not use this file except in compliance with
12  * the License. You may obtain a copy of the License at
13  *
14  * http://www.apache.org/licenses/LICENSE-2.0
15  *
16  * Unless required by applicable law or agreed to in writing, software
17  * distributed under the License is distributed on an "AS IS" BASIS,
18  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19  * See the License for the specific language governing permissions and
20  * limitations under the License.
21  */
22 #include "geode_globals.hpp"
23 #include "geode_types.hpp"
24 #include "Region.hpp"
25 #include "CacheableKey.hpp"
26 #include "UserData.hpp"
27 
31 namespace apache {
32 namespace geode {
33 namespace client {
34 
39  protected:
41  const UserDataPtr
43  const bool m_remoteOrigin;
45  public:
47  RegionEvent();
49  RegionEvent(const RegionPtr& region, const UserDataPtr& aCallbackArgument,
50  const bool remoteOrigin);
51 
53  ~RegionEvent();
54 
56  inline RegionPtr getRegion() const { return m_region; }
57 
63  inline UserDataPtr getCallbackArgument() const { return m_callbackArgument; }
64 
66  inline bool remoteOrigin() const { return m_remoteOrigin; }
67 
68  private:
69  // never implemented.
70  RegionEvent(const RegionEvent& other);
71  void operator=(const RegionEvent& other);
72 };
73 } // namespace client
74 } // namespace geode
75 } // namespace apache
76 
77 #endif // GEODE_REGIONEVENT_H_
Each enum represents a predefined RegionAttributes in a Cache.
Definition: Assert.hpp:31
#define CPPCACHE_EXPORT
Defines a Geode CPPCACHE export.
Definition: geode_base.hpp:58
const UserDataPtr m_callbackArgument
Callback argument for this event, if any.
Definition: RegionEvent.hpp:42
bool remoteOrigin() const
If the event originated in a remote process, returns true.
Definition: RegionEvent.hpp:66
const RegionPtr m_region
Region for this event.
Definition: RegionEvent.hpp:40
Declares region events.
Definition: RegionEvent.hpp:38
RegionPtr getRegion() const
Return the region this event occurred in.
Definition: RegionEvent.hpp:56
const bool m_remoteOrigin
True if from a remote process.
Definition: RegionEvent.hpp:43
UserDataPtr getCallbackArgument() const
Returns the callbackArgument passed to the method that generated this event.
Definition: RegionEvent.hpp:63
This namespace contains all the Geode C++ API classes, enumerations and globals.

Pivotal GemFire C++ Cache API Documentation