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

#define GEODE_EXPIRATIONATTRIBUTES_H_


#include <chrono>


#include "ExpirationAction.hpp"

#include "internal/geode_globals.hpp"


namespace apache {

namespace geode {

namespace client {

class APACHE_GEODE_EXPORT ExpirationAttributes {

 public:

  ExpirationAttributes();


  explicit ExpirationAttributes(

      const std::chrono::seconds& expirationTime,

      const ExpirationAction expirationAction = ExpirationAction::INVALIDATE);


  const std::chrono::seconds& getTimeout() const;

  void setTimeout(const std::chrono::seconds& timeout);


  ExpirationAction getAction() const;

  void setAction(const ExpirationAction& action);


 private:

  ExpirationAction m_action;

  std::chrono::seconds m_timeout;

};


}  // namespace client

}  // namespace geode

}  // namespace apache


#endif  // GEODE_EXPIRATIONATTRIBUTES_H_

ExpirationAction.hpp

apache::geode::client::ExpirationAction
ExpirationAction
ExpirationAction.hpp Enumerated type for expiration actions.
Definition ExpirationAction.hpp:42

apache::geode::client::ExpirationAttributes
Immutable parameter object for accessing and setting the attributes associated with timeToLive and id...
Definition ExpirationAttributes.hpp:50

apache::geode::client::ExpirationAttributes::ExpirationAttributes
ExpirationAttributes()
public methods

apache::geode::client::ExpirationAttributes::getTimeout
const std::chrono::seconds & getTimeout() const
Returns the duration before a region or value expires.

apache::geode::client::ExpirationAttributes::getAction
ExpirationAction getAction() const
Returns the action that should take place when this value or region expires.

apache::geode::client::ExpirationAttributes::ExpirationAttributes
ExpirationAttributes(const std::chrono::seconds &expirationTime, const ExpirationAction expirationAction=ExpirationAction::INVALIDATE)
Constructs an ExpirationAttributes with the specified expiration time and expiration action.