SharpGen.Runtime/ICallbackable.cs

// Copyright (c) 2010-2014 SharpDX - Alexandre Mutel
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

using System;

namespace SharpGen.Runtime
{
    /// <summary>
    /// Use this interface to tag a class that is called by an unmanaged
    /// object. A <see cref="ICallbackable"/> class must dispose the <see cref="Shadow"/>
    /// on dispose.
    /// </summary>
    public interface ICallbackable : IDisposable
    {
        /// <summary>
        /// Gets or sets the unmanaged shadow callback.
        /// </summary>
        /// <value>The unmanaged shadow callback.</value>
        /// <remarks>
        /// This property is set whenever this instance has an unmanaged shadow callback
        /// registered. This callback must be disposed when disposing this instance. 
        /// </remarks>
        ShadowContainer Shadow { get; }
    }
}