puthread.h

Go to the documentation of this file.

/*
 * The MIT License
 *
 * Copyright (C) 2010-2017 Alexander Saprykin <saprykin.spb@gmail.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * 'Software'), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#if !defined (PLIBSYS_H_INSIDE) && !defined (PLIBSYS_COMPILATION)
#  error "Header files shouldn't be included directly, consider using <plibsys.h> instead."
#endif

#ifndef PLIBSYS_HEADER_PUTHREAD_H
#define PLIBSYS_HEADER_PUTHREAD_H

#include <pmacros.h>
#include <ptypes.h>

P_BEGIN_DECLS

typedef ppointer (*PUThreadFunc) (ppointer arg);

typedef struct PUThread_ PUThread;

typedef struct PUThreadKey_ PUThreadKey;

typedef enum PUThreadPriority_ {
        P_UTHREAD_PRIORITY_INHERIT      = 0,    
        P_UTHREAD_PRIORITY_IDLE         = 1,    
        P_UTHREAD_PRIORITY_LOWEST       = 2,    
        P_UTHREAD_PRIORITY_LOW          = 3,    
        P_UTHREAD_PRIORITY_NORMAL       = 4,    
        P_UTHREAD_PRIORITY_HIGH         = 5,    
        P_UTHREAD_PRIORITY_HIGHEST      = 6,    
        P_UTHREAD_PRIORITY_TIMECRITICAL = 7     
} PUThreadPriority;

P_LIB_API PUThread *    p_uthread_create_full   (PUThreadFunc           func,
                                                 ppointer               data,
                                                 pboolean               joinable,
                                                 PUThreadPriority       prio,
                                                 psize                  stack_size);

P_LIB_API PUThread *    p_uthread_create        (PUThreadFunc           func,
                                                 ppointer               data,
                                                 pboolean               joinable);

P_LIB_API void          p_uthread_exit          (pint                   code);

P_LIB_API pint          p_uthread_join          (PUThread               *thread);

P_LIB_API pint          p_uthread_sleep         (puint32                msec);

P_LIB_API pboolean      p_uthread_set_priority  (PUThread               *thread,
                                                 PUThreadPriority       prio);

P_LIB_API void          p_uthread_yield         (void);

P_LIB_API P_HANDLE      p_uthread_current_id    (void);

P_LIB_API PUThread *    p_uthread_current       (void);

P_LIB_API pint          p_uthread_ideal_count   (void);

P_LIB_API void          p_uthread_ref           (PUThread               *thread);

P_LIB_API void          p_uthread_unref         (PUThread               *thread);

P_LIB_API PUThreadKey * p_uthread_local_new     (PDestroyFunc           free_func);

P_LIB_API void          p_uthread_local_free    (PUThreadKey            *key);

P_LIB_API ppointer      p_uthread_get_local     (PUThreadKey            *key);

P_LIB_API void          p_uthread_set_local     (PUThreadKey            *key,
                                                 ppointer               value);

P_LIB_API void          p_uthread_replace_local (PUThreadKey            *key,
                                                 ppointer               value);

P_END_DECLS

#endif /* PLIBSYS_HEADER_PUTHREAD_H */