ResourceProvider.h

Go to the documentation of this file.

//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of NVIDIA CORPORATION nor the names of its
//    contributors may be used to endorse or promote products derived
//    from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright (c) 2018 NVIDIA Corporation. All rights reserved.



#ifndef RESOURCE_PROVIDER_H
#define RESOURCE_PROVIDER_H

#include "ApexUsingNamespace.h"

namespace nvidia
{
namespace apex
{

class ResourceCallback;

PX_PUSH_PACK_DEFAULT

class ResourceProvider
{
public:
    virtual void        registerCallback(ResourceCallback* impl) = 0;

    virtual void        setResource(const char* nameSpace, const char* name, void* resource, bool incRefCount = false) = 0;


    virtual void        setResourceU32(const char* nameSpace, const char* name, uint32_t id, bool incRefCount = false) = 0;

    virtual void*       getResource(const char* nameSpace, const char* name) = 0;

    virtual uint32_t    releaseAllResourcesInNamespace(const char* nameSpace) = 0;

    virtual uint32_t    releaseResource(const char* nameSpace, const char* name) = 0;

    virtual bool        findRefCount(const char* nameSpace, const char* name, uint32_t& refCount) = 0;

    virtual void*       findResource(const char* nameSpace, const char* name) = 0;

    virtual uint32_t    findResourceU32(const char* nameSpace, const char* name) = 0;

    virtual void**      findAllResources(const char* nameSpace, uint32_t& count) = 0;

    virtual const char** findAllResourceNames(const char* nameSpace, uint32_t& count) = 0;

    virtual const char** findNameSpaces(uint32_t& count) = 0;

    virtual void dumpResourceTable() = 0;

    virtual bool isCaseSensitive() = 0;
};

PX_POP_PACK

}
} // end namespace nvidia::apex

#endif // RESOURCE_PROVIDER_H