sopc_threads.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_THREADS_H_
#define SOPC_THREADS_H_
 
#include <stddef.h>
 
#include "sopc_enums.h"
#include "sopc_mutexes.h"
 
/*****************************************************************************
 *   Abstract interface types
 *****************************************************************************/
 
typedef struct SOPC_Thread_Impl SOPC_Thread_Impl;
typedef SOPC_Thread_Impl* SOPC_Thread;
#define SOPC_INVALID_THREAD NULL
 
/*****************************************************************************
 *   Platform-dependant functions interfaces
 *****************************************************************************/
SOPC_ReturnStatus SOPC_Thread_Create(SOPC_Thread* thread,
                                     void* (*startFct)(void*),
                                     void* startArgs,
                                     const char* taskName);
 
SOPC_ReturnStatus SOPC_Thread_CreatePrioritized(SOPC_Thread* thread,
                                                void* (*startFct)(void*),
                                                void* startArgs,
                                                int priority,
                                                const char* taskName);
 
SOPC_ReturnStatus SOPC_Thread_Join(SOPC_Thread* thread);
 
void SOPC_Sleep(unsigned int milliseconds);
 
#endif /* SOPC_THREADS_H_ */