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

#define GEODE_PDXWRAPPER_H_


#include <iosfwd>

#include <memory>

#include <string>


#include "PdxSerializable.hpp"

#include "PdxSerializer.hpp"

#include "internal/geode_base.hpp"


namespace apache {

namespace geode {

namespace client {


class CacheableKey;

class DataInput;

class DataOutput;

class PdxReader;

class PdxWriter;


class APACHE_GEODE_EXPORT PdxWrapper : public PdxSerializable {

 public:

  PdxWrapper(std::shared_ptr<void> userObject, std::string className);


  std::shared_ptr<void> getObject();


  const std::string& getClassName() const override;


  bool operator==(const CacheableKey& other) const override;


  int32_t hashcode() const override;


  void toData(PdxWriter& output) const override;


  void fromData(PdxReader& input) override;


  std::string toString() const override;


  ~PdxWrapper() noexcept override {}


 private:

  PdxWrapper() = delete;


  std::shared_ptr<void> m_userObject;

  std::string m_className;

};

}  // namespace client

}  // namespace geode

}  // namespace apache


#endif  // GEODE_PDXWRAPPER_H_

apache::geode::client::CacheableKey
Represents a cacheable key.
Definition CacheableKey.hpp:40

apache::geode::client::PdxReader
A PdxReader will be passed to PdxSerializable.fromData or during deserialization of a PDX.
Definition PdxReader.hpp:58

apache::geode::client::PdxSerializable
An interface for objects whose contents can be serialized as PDX types.
Definition PdxSerializable.hpp:41

apache::geode::client::PdxWrapper
The PdxWrapper class allows domain classes to be used in Region operations.
Definition PdxWrapper.hpp:46

apache::geode::client::PdxWrapper::getClassName
const std::string & getClassName() const override
Get the Type for the Object.

apache::geode::client::PdxWrapper::hashcode
int32_t hashcode() const override
return the hashcode for this key.

apache::geode::client::PdxWrapper::fromData
void fromData(PdxReader &input) override
Deserialize this object.

apache::geode::client::PdxWrapper::toData
void toData(PdxWriter &output) const override
Serialize this object in Geode PDX format.

apache::geode::client::PdxWrapper::toString
std::string toString() const override
Display this object as 'string', which depends on the implementation in the subclasses.

apache::geode::client::PdxWrapper::operator==
bool operator==(const CacheableKey &other) const override
return true if this key matches other.

apache::geode::client::PdxWrapper::getObject
std::shared_ptr< void > getObject()
Returns the pointer to the user object which is deserialized with a PdxSerializer.

apache::geode::client::PdxWrapper::PdxWrapper
PdxWrapper(std::shared_ptr< void > userObject, std::string className)
Constructor which takes the address of the user object to contain for PDX serialization.

apache::geode::client::PdxWriter
A PdxWriter will be passed to PdxSerializable.toData when it is serializing the domain class.
Definition PdxWriter.hpp:41