vmware-gemfire-native-client-c++-api-reference/10.4/a00122_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_ENTRYEVENT_H_

#define GEODE_ENTRYEVENT_H_


#include <memory>


#include "CacheableKey.hpp"

#include "Region.hpp"

#include "geode/Serializable.hpp"

#include "internal/geode_globals.hpp"


namespace apache {

namespace geode {

namespace client {


class CacheableKey;

class Region;

class Serializable;


class APACHE_GEODE_EXPORT EntryEvent {

 protected:

  std::shared_ptr<Region> m_region;

  std::shared_ptr<CacheableKey> m_key;

  std::shared_ptr<Cacheable> m_oldValue;

  std::shared_ptr<Cacheable> m_newValue;

  std::shared_ptr<Serializable>

      m_callbackArgument;

  bool m_remoteOrigin;

 public:

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

             const std::shared_ptr<CacheableKey>& key,

             const std::shared_ptr<Cacheable>& oldValue,

             const std::shared_ptr<Cacheable>& newValue,

             const std::shared_ptr<Serializable>& aCallbackArgument,

             const bool remoteOrigin);


  virtual ~EntryEvent();


  EntryEvent();


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


  inline std::shared_ptr<CacheableKey> getKey() const { return m_key; }


  inline std::shared_ptr<Cacheable> getOldValue() const { return m_oldValue; }


  inline std::shared_ptr<Cacheable> getNewValue() const { return m_newValue; }


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

    return m_callbackArgument;

  }


  inline bool remoteOrigin() const { return m_remoteOrigin; }


 private:

  // never implemented.

  EntryEvent(const EntryEvent& other);

  void operator=(const EntryEvent& other);

};

}  // namespace client

}  // namespace geode

}  // namespace apache


#endif  // GEODE_ENTRYEVENT_H_

CacheableKey.hpp

apache::geode::client::EntryEvent
Represents an entry event affecting an entry, including its identity and the the circumstances of the...
Definition EntryEvent.hpp:44

apache::geode::client::EntryEvent::EntryEvent
EntryEvent(const std::shared_ptr< Region > &region, const std::shared_ptr< CacheableKey > &key, const std::shared_ptr< Cacheable > &oldValue, const std::shared_ptr< Cacheable > &newValue, const std::shared_ptr< Serializable > &aCallbackArgument, const bool remoteOrigin)
Constructor, given all values.

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

apache::geode::client::EntryEvent::m_remoteOrigin
bool m_remoteOrigin
True if from a remote (non-local) process.
Definition EntryEvent.hpp:52

apache::geode::client::EntryEvent::getOldValue
std::shared_ptr< Cacheable > 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:79

apache::geode::client::EntryEvent::m_oldValue
std::shared_ptr< Cacheable > m_oldValue
Old value.
Definition EntryEvent.hpp:48

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

apache::geode::client::EntryEvent::m_newValue
std::shared_ptr< Cacheable > m_newValue
New value.
Definition EntryEvent.hpp:49

apache::geode::client::EntryEvent::~EntryEvent
virtual ~EntryEvent()
Destructor.

apache::geode::client::EntryEvent::m_key
std::shared_ptr< CacheableKey > m_key
Cacheable key.
Definition EntryEvent.hpp:47

apache::geode::client::EntryEvent::getKey
std::shared_ptr< CacheableKey > getKey() const
Definition EntryEvent.hpp:73

apache::geode::client::EntryEvent::getRegion
std::shared_ptr< Region > getRegion() const
Definition EntryEvent.hpp:70

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

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

apache::geode::client::EntryEvent::getNewValue
std::shared_ptr< Cacheable > getNewValue() const
If the event is a destroy or invalidate operation, then the new value will be nullptr.
Definition EntryEvent.hpp:85

apache::geode::client::EntryEvent::m_region
std::shared_ptr< Region > m_region
Region.
Definition EntryEvent.hpp:46