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

GateMonitor.h File Reference


Detailed Description

Header file for Gate based on Monitor.

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 GateMonitor.h.

Go to the source code of this file.

Defines

#define GateMonitor_E_INVALIDARG   -1
 Argument passed to a function is invalid.
#define GateMonitor_E_MEMORY   -2
 Memory allocation failed.
#define GateMonitor_E_BUSY   -3
 The name is already registered or not.
#define GateMonitor_E_FAIL   -4
 Generic failure.
#define GateMonitor_E_NOTFOUND   -5
 Name not found in the nameserver.
#define GateMonitor_E_INVALIDSTATE   -6
 Module is not initialized.
#define GateMonitor_E_INUSE   -7
 Indicates that the instance is in use.
#define GateMonitor_E_HANDLE   -8
 An invalid handle was provided.
#define GateMonitor_S_SUCCESS   0
 Operation successful.

Typedefs

typedef GateMonitor_Object GateMonitor_Object
 Object for Gate Mutex.
typedef GateMonitor_ObjectGateMonitor_Handle
 Handle for Gate Mutex.
typedef Void GateMonitor_Params

Functions

GateMonitor_Handle GateMonitor_create (const GateMonitor_Params *params)
Int GateMonitor_delete (GateMonitor_Handle *handle)


Define Documentation

#define GateMonitor_E_BUSY   -3
 

The name is already registered or not.

Definition at line 79 of file GateMonitor.h.

#define GateMonitor_E_FAIL   -4
 

Generic failure.

Definition at line 85 of file GateMonitor.h.

#define GateMonitor_E_HANDLE   -8
 

An invalid handle was provided.

Definition at line 109 of file GateMonitor.h.

#define GateMonitor_E_INUSE   -7
 

Indicates that the instance is in use.

Definition at line 103 of file GateMonitor.h.

#define GateMonitor_E_INVALIDARG   -1
 

Argument passed to a function is invalid.

Definition at line 67 of file GateMonitor.h.

#define GateMonitor_E_INVALIDSTATE   -6
 

Module is not initialized.

Definition at line 97 of file GateMonitor.h.

#define GateMonitor_E_MEMORY   -2
 

Memory allocation failed.

Definition at line 73 of file GateMonitor.h.

#define GateMonitor_E_NOTFOUND   -5
 

Name not found in the nameserver.

Definition at line 91 of file GateMonitor.h.

#define GateMonitor_S_SUCCESS   0
 

Operation successful.

Definition at line 115 of file GateMonitor.h.


Typedef Documentation

typedef struct GateMonitor_Object* GateMonitor_Handle
 

Handle for Gate Mutex.

Definition at line 126 of file GateMonitor.h.

typedef struct GateMonitor_Object GateMonitor_Object
 

Object for Gate Mutex.

Definition at line 123 of file GateMonitor.h.

typedef Void GateMonitor_Params
 

No parameters for GateMutex creation

Definition at line 129 of file GateMonitor.h.


Function Documentation

GateMonitor_Handle GateMonitor_create const GateMonitor_Params params  ) 
 

Int GateMonitor_delete GateMonitor_Handle handle  ) 
 


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