Serializable.hpp

Go to the documentation of this file.

#pragma once

#ifndef GEODE_SERIALIZABLE_H_
#define GEODE_SERIALIZABLE_H_

/*
 * 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.
 */

#include "geode_globals.hpp"
#include "geode_types.hpp"

namespace apache {
namespace geode {
namespace client {

class DataOutput;
class DataInput;

typedef void (*CliCallbackMethod)();

typedef Serializable* (*TypeFactoryMethod)();

typedef PdxSerializable* (*TypeFactoryMethodPdx)();
class CPPCACHE_EXPORT Serializable : public SharedBase {
 public:
  virtual void toData(DataOutput& output) const = 0;

  virtual Serializable* fromData(DataInput& input) = 0;

  virtual int32_t classId() const = 0;

  virtual int8_t typeId() const;

  virtual int8_t DSFID() const;

  virtual uint32_t objectSize() const;

  static void registerType(TypeFactoryMethod creationFunction);

  static void registerPdxType(TypeFactoryMethodPdx creationFunction);

  static void registerPdxSerializer(PdxSerializerPtr pdxSerializer);

  virtual CacheableStringPtr toString() const;

  template <class PRIM>
  inline static SerializablePtr create(const PRIM value);

  virtual ~Serializable() {}

 protected:
  Serializable() : SharedBase() {}

 private:
  // Never defined.
  Serializable(const Serializable& other);
  void operator=(const Serializable& other);
};
}  // namespace client
}  // namespace geode
}  // namespace apache

#endif  // GEODE_SERIALIZABLE_H_