tis_cond_init

Initializes a condition variable.

Syntax

tis_cond_init(
              cond );
 



Argument         Data Type               Access

cond             opaque pthread_cond_t   write

C Binding

#include 


int
tis_cond_init (
            pthread_cond_t   *cond);

Arguments

cond

Address of the condition variable (passed by reference) to be initialized.

Description

A condition variable is a synchronization object used in conjunction with a mutex. A mutex controls access to shared data. When threads are present, a condition variable allows threads to wait for data to enter a defined state.

For further information about actions when threads are present, refer to the pthread_cond_init description.

The macro PTHREAD_COND_INITIALIZER can be used to initialize statically allocated condition variables to the default condition variable attributes. Use this macro as follows: pthread_cond_t condition = PTHREAD_COND_INITIALIZER;

When statically initialized, a condition variable should not also be initialized using tis_cond_init. Also, a statically initialized condition variable need not be destroyed using tis_cond_destroy.

Return Values

• The routine returns an integer value indicating the type of error.

• The condition variable is not initialized.

• The contents of conditon variable (cond) are undefined.

The possible return values are as follows:

Return        Description

0             Successful completion.

[EAGAIN]      The system lacks the necessary resources to initialize
              another condition variable, or

              The system-imposed limit on the total number of
              condition variables under execution by a single user
              is exceeded.

[EBUSY]       The implementation has detected an attempt to
              reinitialize the object referenced by cond,
              a previously initialized, but not yet destroyed
              condition variable.

[EINVAL]      The value specified by attr is invalid.

[ENOMEM]      Insufficient memory exists to initialize the condition
              variable.

Associated Routines

   tis_cond_broadcast
   tis_cond_destroy
   tis_cond_signal
   tis_cond_wait