sopc_mutexes.h

Go to the documentation of this file.

/*
 * Licensed to Systerel under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Systerel licenses this file to you under the Apache
 * License, Version 2.0 (the "License"); you may not use this
 * file except in compliance with the License. You may obtain
 * a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#ifndef SOPC_MUTEXES_H_
#define SOPC_MUTEXES_H_
 
#include <stdint.h>
 
#include "sopc_enums.h"
 
/*****************************************************************************
 *   Abstract interface types
 *****************************************************************************/
typedef struct SOPC_Condition_Impl SOPC_Condition_Impl;
typedef SOPC_Condition_Impl* SOPC_Condition;
#define SOPC_INVALID_COND NULL
 
typedef struct SOPC_Mutex_Impl SOPC_Mutex_Impl;
typedef SOPC_Mutex_Impl* SOPC_Mutex;
#define SOPC_INVALID_MUTEX NULL
 
/*****************************************************************************
 *   Platform-dependant functions interfaces
 *****************************************************************************/
SOPC_ReturnStatus SOPC_Condition_Init(SOPC_Condition* cond);
 
SOPC_ReturnStatus SOPC_Condition_Clear(SOPC_Condition* cond);
 
SOPC_ReturnStatus SOPC_Condition_SignalAll(SOPC_Condition* cond);
 
SOPC_ReturnStatus SOPC_Mutex_Initialization(SOPC_Mutex* mut);
 
SOPC_ReturnStatus SOPC_Mutex_Clear(SOPC_Mutex* mut);
 
SOPC_ReturnStatus SOPC_Mutex_Lock(SOPC_Mutex* mut);
 
SOPC_ReturnStatus SOPC_Mutex_Unlock(SOPC_Mutex* mut);
 
SOPC_ReturnStatus SOPC_Mutex_UnlockAndWaitCond(SOPC_Condition* cond, SOPC_Mutex* mut);
 
SOPC_ReturnStatus SOPC_Mutex_UnlockAndTimedWaitCond(SOPC_Condition* cond, SOPC_Mutex* mut, uint32_t milliSecs);
 
#endif /* SOPC_MUTEXES_H_ */