Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

pthread_create(3) [osx man page]

PTHREAD_CREATE(3)					   BSD Library Functions Manual 					 PTHREAD_CREATE(3)

NAME
pthread_create -- create a new thread SYNOPSIS
#include <pthread.h> int pthread_create(pthread_t *restrict thread, const pthread_attr_t *restrict attr, void *(*start_routine)(void *), void *restrict arg); DESCRIPTION
The pthread_create() function is used to create a new thread, with attributes specified by attr, within a process. If attr is NULL, the default attributes are used. If the attributes specified by attr are modified later, the thread's attributes are not affected. Upon suc- cessful completion, pthread_create() will store the ID of the created thread in the location specified by thread. Upon its creation, the thread executes start_routine, with arg as its sole argument. If start_routine returns, the effect is as if there was an implicit call to pthread_exit(), using the return value of start_routine as the exit status. Note that the thread in which main() was originally invoked differs from this. When it returns from main(), the effect is as if there was an implicit call to exit(), using the return value of main() as the exit status. Upon thread exit the storage for the thread must be reclaimed by another thread via a call to pthread_join(). Alternatively, pthread_detach() may be called on the thread to indicate that the system may automatically reclaim the thread storage upon exit. The pthread_attr_setdetachstate() function may be used on the attr argument passed to pthread_create() in order to achieve the same effect as a call to pthread_detach() on the newly created thread. The signal state of the new thread is initialized as: o The signal mask is inherited from the creating thread. o The set of signals pending for the new thread is empty. RETURN VALUES
If successful, the pthread_create() function will return zero. Otherwise, an error number will be returned to indicate the error. ERRORS
pthread_create() will fail if: [EAGAIN] The system lacked the necessary resources to create another thread, or the system-imposed limit on the total number of threads in a process [PTHREAD_THREADS_MAX] would be exceeded. [EINVAL] The value specified by attr is invalid. SEE ALSO
fork(2), pthread_cleanup_pop(3), pthread_cleanup_push(3), pthread_detach(3), pthread_exit(3), pthread_join(3) STANDARDS
pthread_create() conforms to ISO/IEC 9945-1:1996 (``POSIX.1''). BSD
April 4, 1996 BSD

Check Out this Related Man Page

PTHREAD_ATTR(3) 					   BSD Library Functions Manual 					   PTHREAD_ATTR(3)

NAME
pthread_attr_getdetachstate, pthread_attr_setdetachstate -- thread attribute operations SYNOPSIS
#include <pthread.h> int pthread_attr_getdetachstate(const pthread_attr_t *attr, int *detachstate); int pthread_attr_setdetachstate(pthread_attr_t *attr, int detachstate); DESCRIPTION
Thread attributes are used to specify parameters to pthread_create(). One attribute object can be used in multiple calls to pthread_create(), with or without modifications between calls. One of these thread attributes governs the creation state of the new thread. The new thread can be either created "detached" or "joinable". The constants corresponding to these states are PTHREAD_CREATE_DETACHED and PTHREAD_CREATE_JOINABLE respectively. Creating a "joinable" thread allows the user to call pthread_join() and pthread_detach(), with the new thread's ID. A "detached" thread's ID cannot be used with pthread_join() and pthread_detach(). The default value for the "detachstate" attribute is PTHREAD_CREATE_JOINABLE. The pthread_attr_setdetachstate() function sets the thread's "detachstate" attribute. The "detachstate" attribute is set within the attr argument, which can subsequently be used as an argument to pthread_create(). RETURN VALUES
If successful, these functions return 0. Otherwise, an error number is returned to indicate the error. pthread_attr_getdetachstate(), on success, will copy the value of the thread's "detachstate" attribute to the location pointed to by the second function parameter. ERRORS
pthread_attr_getdetachstate() will fail if: [EINVAL] Invalid value for attr pthread_attr_setdetachstate() will fail if: [EINVAL] Invalid value for attr or detachstate. SEE ALSO
pthread_create(3), pthread_join(3), pthread_attr_init(3), pthread_detach(3) STANDARDS
pthread_attr_setdetachstate(), pthread_attr_getdetachstate() conform to ISO/IEC 9945-1:1996 (``POSIX.1'') BSD
December 31, 2007 BSD
Man Page