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

#define GEODE_STRUCT_H_


#include <unordered_map>

#include <vector>


#include "CacheableBuiltins.hpp"

#include "SelectResults.hpp"

#include "Serializable.hpp"

#include "StructSet.hpp"

#include "internal/DataSerializableFixedId.hpp"

#include "internal/geode_globals.hpp"


namespace apache {

namespace geode {

namespace client {


class StructSet;


class APACHE_GEODE_EXPORT Struct

    : public internal::DataSerializableFixedId_t<internal::DSFid::Struct> {

 public:

  typedef std::vector<std::shared_ptr<Serializable>>::iterator iterator;


  Struct(StructSet* ssPtr,

         std::vector<std::shared_ptr<Serializable>>& fieldValues);


  Struct() = default;


  ~Struct() noexcept override = default;


  static std::shared_ptr<Serializable> createDeserializable();


  const std::shared_ptr<Serializable> operator[](int32_t index) const;


  const std::shared_ptr<Serializable> operator[](

      const std::string& fieldName) const;


  const std::shared_ptr<StructSet> getStructSet() const;


  iterator begin();


  iterator end();


  int32_t size() const;


  void fromData(DataInput& input) override;


  void toData(DataOutput& output) const override;


  virtual const std::string& getFieldName(const int32_t index) const;


  size_t objectSize() const override {

    return 0;  // does not get cached, so no need to account for it

  }


 private:

  void skipClassName(DataInput& input);


  typedef std::unordered_map<std::string, int32_t> FieldNameToIndexMap;


  StructSet* m_parent = nullptr;

  std::vector<std::shared_ptr<Serializable>> m_fieldValues;

  FieldNameToIndexMap m_fieldNameToIndex;

};

}  // namespace client

}  // namespace geode

}  // namespace apache


#endif  // GEODE_STRUCT_H_

CacheableBuiltins.hpp
Contains generic template definitions for Cacheable types and instantiations for built-in types.

SelectResults.hpp

StructSet.hpp

apache::geode::client::DataInput
Provide operations for reading primitive data values, byte arrays, strings, Serializable objects from...
Definition DataInput.hpp:59

apache::geode::client::DataOutput
Provide operations for writing primitive data values, byte arrays, strings, Serializable objects to a...
Definition DataOutput.hpp:48

apache::geode::client::Serializable
This base class is the superclass of all user objects in the cache that can be serialized.
Definition Serializable.hpp:53

apache::geode::client::Struct
A Struct has a StructSet as its parent.
Definition Struct.hpp:50

apache::geode::client::Struct::Struct
Struct(StructSet *ssPtr, std::vector< std::shared_ptr< Serializable > > &fieldValues)
Constructor - meant only for internal use.

apache::geode::client::StructSet
A StructSet may be obtained after executing a Query which is obtained from a QueryService which in tu...
Definition StructSet.hpp:42