Go to main content

man pages section 3: Extended Library Functions, Volume 2

Exit Print View

Updated: Thursday, June 13, 2019
 
 

dtrace_sleep (3DTRACE)

Name

dtrace_sleep - DTrace-specific sleep

Synopsis

     cc [ flag... ] file... -ldtrace [ library... ]
     #include <dtrace.h>

     void dtrace_sleep(dtrace_hdl_t *dtp)

Description

The calling thread is suspended from execution for a period of time determined by the values of the statusrate, aggrate, and switchrate arguments. See the dtrace_setopt(3DTRACE) man page for more information. The dtrace_sleep() function might return prior to the determined timeout if any traced process encounters an interesting event such as death of the process or the loading of a shared library by the process.

Return Values

The dtrace_sleep() function has no return value, although it sets the DTrace error number to indicate a failure. See the dtrace_errno(3DTRACE) man page for more information.

Errors

The dtrace_sleep() function will fail if:

EINVAL

The DTrace handle is NULL.

Examples

See the libdtrace(3LIB) man page for an example of using the dtrace_sleep() function.

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Architecture
All
Availability
system/dtrace
Interface Stability
Committed
MT-Level
Safe

See Also

libdtrace(3LIB), dtrace_errno(3DTRACE), dtrace_setopt(3DTRACE)