thread.h

/******************************************************************************
 * Copyright 2022 ETC Inc.
 *
 * Licensed 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.
 *******************************************************************************
 * This file is a part of EtcPal. For more information, go to:
 * https://github.com/ETCLabs/EtcPal
 ******************************************************************************/
 
#ifndef ETCPAL_THREAD_H_
#define ETCPAL_THREAD_H_
 
#include "etcpal/error.h"
#include "etcpal/os_thread.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct EtcPalThreadParams
{
  unsigned int priority;
  unsigned int stack_size;
  const char* thread_name;
  void* platform_data;
} EtcPalThreadParams;
 
#define ETCPAL_THREAD_SET_DEFAULT_PARAMS(threadparamsptr)              \
  do                                                                   \
  {                                                                    \
    (threadparamsptr)->priority      = ETCPAL_THREAD_DEFAULT_PRIORITY; \
    (threadparamsptr)->stack_size    = ETCPAL_THREAD_DEFAULT_STACK;    \
    (threadparamsptr)->thread_name   = ETCPAL_THREAD_DEFAULT_NAME;     \
    (threadparamsptr)->platform_data = NULL;                           \
  } while (0)
 
#define ETCPAL_THREAD_PARAMS_INIT_VALUES \
  ETCPAL_THREAD_DEFAULT_PRIORITY, ETCPAL_THREAD_DEFAULT_STACK, ETCPAL_THREAD_DEFAULT_NAME, NULL
 
#define ETCPAL_THREAD_PARAMS_INIT    \
  {                                  \
    ETCPAL_THREAD_PARAMS_INIT_VALUES \
  }
 
etcpal_error_t            etcpal_thread_create(etcpal_thread_t*          id,
                                               const EtcPalThreadParams* params,
                                               void (*thread_fn)(void*),
                                               void* thread_arg);
etcpal_error_t            etcpal_thread_join(etcpal_thread_t* id);
etcpal_error_t            etcpal_thread_timed_join(etcpal_thread_t* id, int timeout_ms);
etcpal_error_t            etcpal_thread_terminate(etcpal_thread_t* id);
etcpal_thread_os_handle_t etcpal_thread_get_os_handle(etcpal_thread_t* id);
 
#if !defined(etcpal_thread_sleep) || DOXYGEN
void etcpal_thread_sleep(unsigned int sleep_ms);
#endif
 
#if !defined(etcpal_thread_get_current_os_handle) || DOXYGEN
etcpal_thread_os_handle_t etcpal_thread_get_current_os_handle(void);
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* ETCPAL_THREAD_H_ */