pthread_mutex_init man page on SmartOS

Printed from http://www.polarhome.com/service/man/?qf=pthread_mutex_init&af=0&tf=2&of=SmartOS

PTHREAD_MUTEX_INIT(3C)					PTHREAD_MUTEX_INIT(3C)

NAME
       pthread_mutex_init,  pthread_mutex_destroy  -  initialize  or destroy a
       mutex

SYNOPSIS
       cc -mt [ flag... ] file... -lpthread [ library... ]
       #include <pthread.h>

       int pthread_mutex_init(pthread_mutex_t *restrict mutex,
	    const pthread_mutexattr_t *restrict attr);

       int pthread_mutex_destroy(pthread_mutex_t *mutex);

       pthread_mutex_t mutex= PTHREAD_MUTEX_INITIALIZER;

DESCRIPTION
       The pthread_mutex_init() function initializes the mutex	referenced  by
       mutex  with  attributes specified by attr. If attr is NULL, the default
       mutex attributes are used; the  effect  is  the	same  as  passing  the
       address	of a default mutex attributes object. Upon successful initial‐
       ization, the state of the mutex becomes initialized and unlocked.

       Except for robust mutexes, attempting to initialize an already initial‐
       ized mutex results in undefined behavior.

       The  pthread_mutex_destroy()  function destroys the mutex object refer‐
       enced by mutex; the mutex object becomes, in effect,  uninitialized.  A
       destroyed     mutex     object	  can	 be    re-initialized	 using
       pthread_mutex_init(); the results of otherwise referencing  the	object
       after it has been destroyed are undefined.

       It is safe to destroy an initialized mutex that is unlocked. Attempting
       to destroy a locked mutex results in undefined behavior.

       In cases where default mutex  attributes	 are  appropriate,  the	 macro
       PTHREAD_MUTEX_INITIALIZER  can  be  used to initialize mutexes that are
       statically allocated. The effect is equivalent to  dynamic  initializa‐
       tion by a call to pthread_mutex_init() with parameter attr specified as
       NULL, except that no error checks are performed.

RETURN VALUES
       If successful,  the  pthread_mutex_init()  and  pthread_mutex_destroy()
       functions return	 0. Otherwise, an error number is returned to indicate
       the error.

ERRORS
       The pthread_mutex_init() function will fail if:

       EAGAIN
		 The system lacked the necessary resources (other than memory)
		 to initialize another mutex.

       EBUSY
		 An attempt was detected to  re-initialize a robust mutex pre‐
		 viously initialized but not yet destroyed. See pthread_mutex‐
		 attr_setrobust(3C).

       EINVAL
		 An  attempt was detected to re-initialize a robust mutex pre‐
		 viously initialized with a different set of  attributes.  See
		 pthread_mutexattr_setrobust(3C).

       ENOMEM
		 Insufficient memory exists to initialize the mutex.

       EPERM
		 The  caller does not have the privilege to perform the opera‐
		 tion.

       The pthread_mutex_init() function may fail if:

       EBUSY
		 An attempt was detected to re-initialize  the	object	refer‐
		 enced	by  mutex,  a mutex previously initialized but not yet
		 destroyed.

       EINVAL
		 The value specified by attr or mutex is invalid.

       The pthread_mutex_destroy() function may fail if:

       EBUSY
		 An attempt was detected to destroy the object	referenced  by
		 mutex	while  it  is locked or referenced (for example, while
		 being used in a pthread_cond_wait(3C) or  pthread_cond_timed‐
		 wait(3C)) by another thread.

       EINVAL
		 The value specified by mutex is invalid.

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       ┌────────────────────┬─────────────────┐
       │  ATTRIBUTE TYPE    │ ATTRIBUTE VALUE │
       ├────────────────────┼─────────────────┤
       │Interface Stability │ Standard	      │
       ├────────────────────┼─────────────────┤
       │MT-Level	    │ MT-Safe	      │
       └────────────────────┴─────────────────┘

SEE ALSO
       pthread_cond_wait(3C),  pthread_mutex_lock(3C),	pthread_mutexattr_set‐
       prioceiling(3C),	  pthread_mutexattr_setprotocol(3C),	pthread_mutex‐
       attr_setpshared(3C),   pthread_mutexattr_setrobust(3C),	pthread_mutex‐
       attr_settype(3C), attributes(5), mutex(5), standards(5)

				 Nov 11, 2008		PTHREAD_MUTEX_INIT(3C)
[top]

List of man pages available for SmartOS

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net