rso_interface_4.h

Go to the documentation of this file.

/*! \file
  \brief  Defines the RSO interface v4, which extends v3 to add \link disti::RSOInterface4#ResourceObserver ResourceObserver\endlink

  \par Copyright Information

  Copyright (c) 2018 by The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/
#ifndef INCLUDED_RSO_INTERFACE_4_H
#define INCLUDED_RSO_INTERFACE_4_H

#include "rso_interface_3.h"

namespace disti
{
////////////////////////////////////////////////////////////////////////////////
// In order for the RSO to be discovered in a .DLL or .so file,
// The following "C" funtions need to be defined.
// They are only comments here.
////////////////////////////////////////////////////////////////////////////////
// RSOInterface1* CreateRSOInterface4_ClassNameHere()
// Optionally:
// const char* GlsDefaultClassName()
////////////////////////////////////////////////////////////////////////////////

/** The RSOInterface4 class defines an abstract interface to an RSO instance. 
  */
class RSOInterface4 : public RSOInterface3
{
public:
    /** Class used to call a callback method that takes a DistiAttributeBase */
    class ResourceObserver
    {
    public:
        /** Called when the resource value has changed
        * \param handle the handle to the resource that changed
        */
        virtual void Call( ResourceHandle handle ) = 0;

        /** deletes the observer */
        virtual void Destroy() = 0;

    protected:
        virtual ~ResourceObserver() {}
    };

    /// Type for unique identifiers
    typedef unsigned int CallbackID;

    /** Register a resource observer to be notified when a resource changes *
    * \param resourceHandle the resource handle
    * \param observer the observer to be notified. The RSO takes ownership of the observer and will call Destroy to delete it when needed.
    * \return the id used to unregister the observer in combination with the original resourceHandle
    */
    virtual CallbackID RegisterResourceObserver( ResourceHandle resourceHandle, ResourceObserver* observer ) = 0;

    /** Unregister a resource observer
    * \param resourceHandle the resource handle used to register the observer
    * \param id the id used to register the resource observer
    */
    virtual void UnregisterResourceObserver( ResourceHandle resourceHandle, CallbackID id ) = 0;

protected:
    ////////////////////////////////////////////////////////////////////////////////
    /// Protected destructor so it can't be deleted directly.
    ////////////////////////////////////////////////////////////////////////////////
    virtual ~RSOInterface4() {}
};

} // end namespace disti

#endif