clicache/src/impl/ManagedCacheLoader.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 <vcclr.h>
#include "../begin_native.hpp"
#include <geode/CacheLoader.hpp>
#include "../end_native.hpp"


#include "../ICacheLoader.hpp"
#include "CacheLoader.hpp"

namespace apache
{
  namespace geode
  {
    namespace client
    {

      /// <summary>
      /// Wraps the managed <see cref="Apache.Geode.Client.ICacheLoader" />
      /// object and implements the native <c>apache::geode::client::CacheLoader</c> interface.
      /// </summary>
      class ManagedCacheLoaderGeneric
        : public apache::geode::client::CacheLoader
      {
      public:

        /// <summary>
        /// Constructor to initialize with the provided managed object.
        /// </summary>
        /// <param name="userptr">
        /// The managed object.
        /// </param>
        inline ManagedCacheLoaderGeneric(
          /*Generic::ICacheLoader<Object^, Object^>^ managedptr,*/ Object^ userptr)
          : /*m_managedptr( managedptr ),*/ m_userptr(userptr) { }

        /// <summary>
        /// Static function to create a <c>ManagedCacheLoader</c> using given
        /// managed assembly path and given factory function.
        /// </summary>
        /// <param name="assemblyPath">
        /// The path of the managed assembly that contains the <c>ICacheLoader</c>
        /// factory function.
        /// </param>
        /// <param name="factoryFunctionName">
        /// The name of the factory function of the managed class for creating
        /// an object that implements <c>ICacheLoader</c>.
        /// This should be a static function of the format
        /// {Namespace}.{Class Name}.{Method Name}.
        /// </param>
        /// <exception cref="IllegalArgumentException">
        /// If the managed library cannot be loaded or the factory function fails.
        /// </exception>
        static apache::geode::client::CacheLoader* create(const char* assemblyPath,
          const char* factoryFunctionName);

        virtual ~ManagedCacheLoaderGeneric() { }

        /// <summary>
        /// Loads a value. Application writers should implement this
        /// method to customize the loading of a value.
        /// </summary>
        /// <remarks>
        /// This method is called by the caching service when the requested
        /// value is not in the cache. Any exception thrown by this method
        /// is propagated back to and thrown by the invocation of
        /// <see cref="Apache.Geode.Client.Region.Get" /> that triggered this load.
        /// </remarks>
        /// <param name="region">a Region Pointer for which this is called.</param>
        /// <param name="key">the key for the cacheable</param>
        /// <param name="aCallbackArgument">any related user data, or null</param>
        /// <returns>
        /// the value supplied for this key, or null if no value can be
        /// supplied. 
        /// If every available loader returns
        /// a null value, <see cref="Apache.Geode.Client.Region.Get" />
        /// will return null.
        /// </returns>
        /// <seealso cref="Apache.Geode.Client.Region.Get" />
        virtual std::shared_ptr<Cacheable> load(Region& region,
          const std::shared_ptr<CacheableKey>& key, const std::shared_ptr<Serializable>& aCallbackArgument);

        /// <summary>
        /// Called when the region containing this callback is destroyed, when
        /// the cache is closed.
        /// </summary>
        /// <remarks>
        /// Implementations should clean up any external
        /// resources, such as database connections. Any runtime exceptions this method
        /// throws will be logged.
        /// <para>
        /// It is possible for this method to be called multiple times on a single
        /// callback instance, so implementations must be tolerant of this.
        /// </para>
        /// </remarks>
        /// <param name="region">the region pointer</param>
        /// <seealso cref="Apache.Geode.Client.Cache.Close" />
        /// <seealso cref="Apache.Geode.Client.Region.DestroyRegion" />
        virtual void close(Region& region);

        /*
        /// <summary>
        /// Returns the wrapped managed object reference.
        /// </summary>
        inline Apache::Geode::Client::ICacheLoader^ ptr( ) const
        {
        return m_managedptr;
        }
        */

        inline void setptr(Apache::Geode::Client::ICacheLoaderProxy^ managedptr)
        {
          m_managedptr = managedptr;
        }

        inline Object^ userptr() const
        {
          return m_userptr;
        }


      private:

        /// <summary>
        /// Using gcroot to hold the managed delegate pointer (since it cannot be stored directly).
        /// Note: not using auto_gcroot since it will result in 'Dispose' of the ICacheLoader
        /// to be called which is not what is desired when this object is destroyed. Normally this
        /// managed object may be created by the user and will be handled automatically by the GC.
        /// </summary>
        gcroot<Apache::Geode::Client::ICacheLoaderProxy^> m_managedptr;

        gcroot<Object^> m_userptr;

        // Disable the copy and assignment constructors
        ManagedCacheLoaderGeneric(const ManagedCacheLoaderGeneric&);
        ManagedCacheLoaderGeneric& operator = (const ManagedCacheLoaderGeneric&);
      };

    }  // namespace client
  }  // namespace geode
}  // namespace apache