vmware-gemfire-native-client-c++-api-reference/10.4/a00215_source.html

/*

 * Licensed to the Apache Software Foundation (ASF) under one or more

 * contributor license agreements.  See the NOTICE file distributed with

 * this work for additional information regarding copyright ownership.

 * The ASF licenses this file to You under the Apache License, Version 2.0

 * (the "License"); you may not use this file except in compliance with

 * the License.  You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */


#pragma once


#ifndef GEODE_REGIONEVENT_H_

#define GEODE_REGIONEVENT_H_


#include "CacheableKey.hpp"

#include "Region.hpp"

#include "internal/geode_globals.hpp"


namespace apache {

namespace geode {

namespace client {


class APACHE_GEODE_EXPORT RegionEvent {

 protected:

  const std::shared_ptr<Region> m_region;

  const std::shared_ptr<Serializable>

      m_callbackArgument;

  const bool m_remoteOrigin;

 public:

  RegionEvent();

  RegionEvent(const std::shared_ptr<Region>& region,

              const std::shared_ptr<Serializable>& aCallbackArgument,

              const bool remoteOrigin);


  ~RegionEvent();


  inline std::shared_ptr<Region> getRegion() const { return m_region; }


  inline std::shared_ptr<Serializable> getCallbackArgument() const {

    return m_callbackArgument;

  }


  inline bool remoteOrigin() const { return m_remoteOrigin; }


 private:

  // never implemented.

  RegionEvent(const RegionEvent& other);

  void operator=(const RegionEvent& other);

};

}  // namespace client

}  // namespace geode

}  // namespace apache


#endif  // GEODE_REGIONEVENT_H_

CacheableKey.hpp

apache::geode::client::RegionEvent
Declares region events.
Definition RegionEvent.hpp:37

apache::geode::client::RegionEvent::RegionEvent
RegionEvent(const std::shared_ptr< Region > &region, const std::shared_ptr< Serializable > &aCallbackArgument, const bool remoteOrigin)
Constructor, given the values.

apache::geode::client::RegionEvent::getRegion
std::shared_ptr< Region > getRegion() const
Return the region this event occurred in.
Definition RegionEvent.hpp:56

apache::geode::client::RegionEvent::remoteOrigin
bool remoteOrigin() const
If the event originated in a remote process, returns true.
Definition RegionEvent.hpp:68

apache::geode::client::RegionEvent::m_callbackArgument
const std::shared_ptr< Serializable > m_callbackArgument
Callback argument for this event, if any.
Definition RegionEvent.hpp:41

apache::geode::client::RegionEvent::RegionEvent
RegionEvent()
Constructor.

apache::geode::client::RegionEvent::getCallbackArgument
std::shared_ptr< Serializable > getCallbackArgument() const
Returns the callbackArgument passed to the method that generated this event.
Definition RegionEvent.hpp:63

apache::geode::client::RegionEvent::m_remoteOrigin
const bool m_remoteOrigin
True if from a remote process.
Definition RegionEvent.hpp:42

apache::geode::client::RegionEvent::m_region
const std::shared_ptr< Region > m_region
Region for this event.
Definition RegionEvent.hpp:39

apache::geode::client::RegionEvent::~RegionEvent
~RegionEvent()
Destructor.