Main Page | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals

GateMutex.h File Reference


Detailed Description

Gate based on Mutex.

02.00.00.68_beta1

============================================================================

Copyright (c) 2008-2009, Texas Instruments Incorporated

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 Texas Instruments Incorporated 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. Contact information for paper mail: Texas Instruments Post Office Box 655303 Dallas, Texas 75265 Contact information: http://www-k.ext.ti.com/sc/technical-support/product-information-centers.htm? DCMP=TIHomeTracking&HQS=Other+OT+home_d_contact ============================================================================

Definition in file GateMutex.h.

Go to the source code of this file.

Defines

#define GateMutex_E_INVALIDARG   -1
 Argument passed to a function is invalid.
#define GateMutex_E_MEMORY   -2
 Memory allocation failed.
#define GateMutex_E_BUSY   -3
 The name is already registered or not.
#define GateMutex_E_FAIL   -4
 Generic failure.
#define GateMutex_E_NOTFOUND   -5
 Name not found in the nameserver.
#define GateMutex_E_INVALIDSTATE   -6
 Module is not initialized.
#define GateMutex_E_INUSE   -7
 Indicates that the instance is in use.
#define GateMutex_S_SUCCESS   0
 Operation successful.

Typedefs

typedef GateMutex_Object GateMutex_Object
 Object for Gate Mutex.
typedef GateMutex_ObjectGateMutex_Handle
 Handle for Gate Mutex.
typedef Void GateMutex_Params

Functions

GateMutex_Handle GateMutex_create (const GateMutex_Params *params)
Int GateMutex_delete (GateMutex_Handle *gmHandle)


Define Documentation

#define GateMutex_E_BUSY   -3
 

The name is already registered or not.

Definition at line 80 of file GateMutex.h.

#define GateMutex_E_FAIL   -4
 

Generic failure.

Definition at line 86 of file GateMutex.h.

#define GateMutex_E_INUSE   -7
 

Indicates that the instance is in use.

Definition at line 104 of file GateMutex.h.

#define GateMutex_E_INVALIDARG   -1
 

Argument passed to a function is invalid.

Definition at line 68 of file GateMutex.h.

#define GateMutex_E_INVALIDSTATE   -6
 

Module is not initialized.

Definition at line 98 of file GateMutex.h.

#define GateMutex_E_MEMORY   -2
 

Memory allocation failed.

Definition at line 74 of file GateMutex.h.

#define GateMutex_E_NOTFOUND   -5
 

Name not found in the nameserver.

Definition at line 92 of file GateMutex.h.

#define GateMutex_S_SUCCESS   0
 

Operation successful.

Definition at line 110 of file GateMutex.h.


Typedef Documentation

typedef struct GateMutex_Object* GateMutex_Handle
 

Handle for Gate Mutex.

Definition at line 121 of file GateMutex.h.

typedef struct GateMutex_Object GateMutex_Object
 

Object for Gate Mutex.

Definition at line 118 of file GateMutex.h.

typedef Void GateMutex_Params
 

No parameters for GateMutex creation

Definition at line 124 of file GateMutex.h.


Function Documentation

GateMutex_Handle GateMutex_create const GateMutex_Params params  ) 
 

Int GateMutex_delete GateMutex_Handle gmHandle  ) 
 


Generated on Mon Mar 14 11:59:46 2011 for Syslink by  doxygen 1.4.4