geode-client-native/src/clicache/CacheStatisticsM.hpp

/*=========================================================================
 * Copyright (c) 2002-2014 Pivotal Software, Inc. All Rights Reserved.
 * This product is protected by U.S. and international copyright
 * and intellectual property laws. Pivotal products are covered by
 * more patents listed at http://www.pivotal.io/patents.
 *=========================================================================
 */

#pragma once

#include "gf_defs.hpp"
#include "cppcache/CacheStatistics.hpp"
#include "impl/NativeWrapper.hpp"


namespace GemStone
{
  namespace GemFire
  {
    namespace Cache
    {

      /// <summary>
      /// Defines common statistical information for both the region and its entries.
      /// </summary>
      /// <remarks>
      /// All of these methods may throw a <c>CacheClosedException</c>,
      /// <c>RegionDestroyedException</c>, or <c>EntryDestroyedException</c>.
      /// </remarks>
      /// <seealso cref="Region.Statistics" />
      /// <seealso cref="RegionEntry.Statistics" />
        [Obsolete("Use classes and APIs from the GemStone.GemFire.Cache.Generic namespace")]
      public ref class CacheStatistics sealed
        : public Internal::SBWrap<gemfire::CacheStatistics>
      {
      public:

        /// <summary>
        /// For an entry, returns the time that the entry's value was last modified.
        /// For a region, returns the last time any of the region's entries' values or
        /// the values in subregions' entries were modified.
        /// </summary>
        /// <remarks>
        /// <para>
        /// The modification may have been initiated locally, or it may have been
        /// an update distributed from another cache. It may also have been a new
        /// value provided by a loader. The modification time on a region is
        /// propagated upward to parent regions, transitively, to the root region.
        /// </para><para>
        /// The number is expressed as the number of milliseconds since January 1, 1970.
        /// The granularity may be as coarse as 100ms, so the accuracy may be off by
        /// up to 50ms.
        /// </para><para>
        /// Entry and subregion creation will update the modification time on a
        /// region, but <c>Region.Destroy</c>, <c>Region.DestroyRegion</c>,
        /// <c>Region.Invalidate</c>, and <c>Region.InvalidateRegion</c>
        /// do not update the modification time.
        /// </para>
        /// </remarks>
        /// <returns>
        /// the last modification time of the region or the entry;
        /// returns 0 if the entry is invalid or the modification time is uninitialized.
        /// </returns>
        /// <seealso cref="Region.Put" />
        /// <seealso cref="Region.Get" />
        /// <seealso cref="Region.Create" />
        /// <seealso cref="Region.CreateSubRegion" />
        property uint32_t LastModifiedTime
        {
          /// <summary>
          /// Get the last modified time of an entry or a region.
          /// </summary>
          /// <returns>
          /// the last accessed time expressed as the number of milliseconds since
          /// January 1, 1970.
          /// </returns>
          uint32_t get( );
        }

        /// <summary>
        /// For an entry, returns the last time it was accessed via <c>Region.Get</c>.
        /// For a region, returns the last time any of its entries or the entries of
        /// its subregions were accessed with <c>Region.Get</c>.
        /// </summary>
        /// <remarks>
        /// <para>
        /// Any modifications will also update the <c>LastAccessedTime</c>,
        /// so <c>LastAccessedTime</c> is always greater than or equal to
        /// <c>LastModifiedTime</c>. The <c>LastAccessedTime</c> on a region is
        /// propagated upward to parent regions, transitively, to the the root region.
        /// </para><para>
        /// The number is expressed as the number of milliseconds since
        /// January 1, 1970. The granularity may be as coarse as 100ms, so
        /// the accuracy may be off by up to 50ms.
        /// </para>
        /// </remarks>
        /// <returns>
        /// the last access time of the region or the entry's value;
        /// returns 0 if entry is invalid or access time is uninitialized.
        /// </returns>
        /// <seealso cref="Region.Get" />
        /// <seealso cref="LastModifiedTime" />
        property uint32_t LastAccessedTime
        {
          /// <summary>
          /// Get the last accessed time of an entry or a region.
          /// </summary>
          /// <returns>
          /// the last accessed time expressed as the number of milliseconds since
          /// January 1, 1970.
          /// </returns>
          uint32_t get( );
        }


      internal:

        /// <summary>
        /// Internal factory function to wrap a native object pointer inside
        /// this managed class with null pointer check.
        /// </summary>
        /// <param name="nativeptr">The native object pointer</param>
        /// <returns>
        /// The managed wrapper object; null if the native pointer is null.
        /// </returns>
        inline static CacheStatistics^ Create( gemfire::CacheStatistics* nativeptr )
        {
          return ( nativeptr != nullptr ?
            gcnew CacheStatistics( nativeptr ) : nullptr );
        }


      private:

        /// <summary>
        /// Private constructor to wrap a native object pointer
        /// </summary>
        /// <param name="nativeptr">The native object pointer</param>
        inline CacheStatistics( gemfire::CacheStatistics* nativeptr )
          : SBWrap( nativeptr ) { }
      };

    }
  }
}