pthread_delay_np Subroutine

Edit online

Purpose

Causes a thread to wait for a specified period.

Library

Threads Library (libpthreads.a)

Syntax

#include <pthread.h>

int pthread_delay_np ( interval)
struct timespec *interval;

Description

The pthread_delay_np subroutine causes the calling thread to delay execution for a specified period of elapsed wall clock time. The period the thread waits is at least according to the number of seconds and nanoseconds specified in the interval parameter.

Note:
  1. The pthread.h header file must be the first included file of each source file that uses the threads library. Otherwise, the -D_THREAD_SAFE compilation flag must be used, or the cc_r compiler used. In this case, the flag is automatically set.
  2. The pthread_delay_np subroutine is not portable.

This subroutine is not POSIX compliant and is provided only for compatibility with DCE threads. It must not be used when writing new applications.

Parameters

Table 1. Parameters
Item Description
interval Points to the time structure specifying the wait period.

Return Values

Upon successful completion, 0 is returned. Otherwise, an error code is returned.

Error Codes

The pthread_delay_np subroutine is unsuccessful if the following is true:

Table 2. Error Codes
Item Description
EINVAL The interval parameter is not valid.