clHandleApi.h

Go to the documentation of this file.

/*
 * Copyright (C) 2002-2012 OpenClovis Solutions Inc.  All Rights Reserved.
 *
 * This file is available  under  a  commercial  license  from  the
 * copyright  holder or the GNU General Public License Version 2.0.
 * 
 * The source code for  this program is not published  or otherwise 
 * divested of  its trade secrets, irrespective  of  what  has been 
 * deposited with the U.S. Copyright office.
 * 
 * This program is distributed in the  hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied  warranty  of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
 * General Public License for more details.
 * 
 * For more  information, see  the file  COPYING provided with this
 * material.
 */
/*******************************************************************************
 * ModuleName  : utils
 * File        : clHandleApi.h
 *******************************************************************************/

/*******************************************************************************
 * Description :
 *
 * This is the interface to a client side handle management service.
 *
 * Part of this code was inspired by the openais code, hence I retained
 * the copyright below.
 *
 *
 *****************************************************************************/

/*
 * Copyright (c) 2002-2003 MontaVista Software, Inc.
 *
 * All rights reserved.
 *
 * Author: Steven Dake (sdake@mvista.com)
 *
 * This software licensed under BSD license, the text of which follows:
 * 
 * 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 the MontaVista Software, Inc. 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 AND CONTRIBUTORS "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.
 */

#ifndef _CL_HANDLE_API_H_
#define _CL_HANDLE_API_H_

#ifdef __cplusplus
extern "C"
{
#endif

#include <clCommon.h>

#define CL_HANDLE_INVALID_VALUE     0x0
#define CL_HDL_IDX_MASK     0x00000000FFFFFFFFULL
#define CL_HDL_IDX(hdl) (ClUint32T)( (hdl) & CL_HDL_IDX_MASK)

typedef ClPtrT  ClHandleDatabaseHandleT;

extern ClRcT clHandleDatabaseCreate(
        CL_IN    void                    (*destructor)(void*),
        CL_OUT   ClHandleDatabaseHandleT  *databaseHandle);

extern ClRcT clHandleDatabaseDestroy(
        CL_IN    ClHandleDatabaseHandleT   databaseHandle);

extern ClRcT clHandleCreate(
        CL_IN    ClHandleDatabaseHandleT   databaseHandle,
            CL_IN    ClInt32T                  instanceSize,
            CL_OUT   ClHandleT                *handle);

extern ClRcT clHandleDestroy(
        CL_IN    ClHandleDatabaseHandleT   databaseHandle,
            CL_IN    ClHandleT                 handle);

extern ClRcT clHandleCheckout(
        CL_IN    ClHandleDatabaseHandleT   databaseHandle,
            CL_IN    ClHandleT                 handle,
        CL_OUT   void                    **instance);

extern ClRcT clHandleCheckin(
        CL_IN    ClHandleDatabaseHandleT   databaseHandle,
            CL_IN    ClHandleT                 handle);

extern ClRcT clHandleMove(
        CL_IN    ClHandleDatabaseHandleT   databaseHandle,
            CL_IN    ClHandleT                 oldHandle,
        CL_IN    ClHandleT                 newHandle);

#ifdef __cplusplus
}
#endif

#endif /* _CL_HANDLE_API_H_ */