clicache/src/ISerializable.hpp

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


#include "geode_defs.hpp"
#include "begin_native.hpp"
#include <geode/internal/geode_globals.hpp>
#include "end_native.hpp"

using namespace System;

namespace Apache
{
  namespace Geode
  {
    namespace Client
    {

      ref class DataOutput;
      ref class DataInput;
      ref class Serializable;

      /// <summary>
      /// This interface class is the superclass of all user objects 
      /// in the cache that can be serialized.
      /// </summary>
      public interface class ISerializable
      {
      public:
        /// <summary>
        /// Get the size of this object in bytes.
        /// This is only needed if you use the HeapLRU feature.
        /// </summary>
        /// <remarks>
        /// Note that you can simply return zero if you are not using the HeapLRU feature.
        /// </remarks>
        /// <returns>the size of this object in bytes.</returns>
        property System::UInt64 ObjectSize
        {
          System::UInt64 get( );
        }

        /// <summary>
        /// Return a string representation of the object.
        /// </summary>
        String^ ToString( );
      };

    }  // namespace Client
  }  // namespace Geode
}  // namespace Apache