---
name: "nbdkit_nanosleep"
section: "3"
platform: "linux"
package: "nbdkit-plugin-dev"
version: "1.42.3-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/nbdkit_nanosleep"
---

# nbdkit\_nanosleep(3)

suspend the current thread for nbdkit

## NAME

nbdkit\_nanosleep - suspend the current thread for nbdkit

## SYNOPSIS

```
 #include <nbdkit-plugin.h>
 int nbdkit_nanosleep (unsigned sec, unsigned nsec);
```

## DESCRIPTION

The utility function `"nbdkit_nanosleep"` suspends the current [**nbdkit**(1)](/nbdkit/1.md) thread for `"sec"` seconds plus `"nsec"` nanoseconds.

Plugins or filters that need to sleep may call **sleep**(2), [**nanosleep**(2)](/nanosleep/2.md) and similar.  However that can cause nbdkit to delay excessively when shutting down (since the server must wait for any plugin or filter which is sleeping).  The purpose of this function is to provide a way for sleeps to be interrupted when nbdkit is shutting down.

Use [**nbdkit\_parse\_delay**(3)](/nbdkit_parse_delay/3.md) to parse delays and sleeps from configuration parameters for use by this function.

## RETURN VALUE

This function returns `0` if it slept at least as many seconds and nanoseconds as requested.

If there is an error it calls [**nbdkit\_error**(3)](/nbdkit_error/3.md) and returns `-1`. Attempts to sleep more than `"INT_MAX"` seconds are treated as an error.

## LANGUAGE BINDINGS

In **nbdkit-ocaml-plugin**(3):

```
 NBDKit.nanosleep : int -> int -> unit
```

In [**nbdkit-python-plugin**(3)](/nbdkit-python-plugin/3.md):

```
 import nbdkit
 nbdkit.nanosleep(sec, nsec)
```

## HISTORY

`"nbdkit_nanosleep"` was added in nbdkit 1.16.

## SEE ALSO

[**nbdkit**(1)](/nbdkit/1.md), [**nbdkit\_shutdown**(3)](/nbdkit_shutdown/3.md), [**nbdkit-plugin**(3)](/nbdkit-plugin/3.md), [**nbdkit-filter**(3)](/nbdkit-filter/3.md), [**nbdkit-delay-filter**(1)](/nbdkit-delay-filter/1.md), [**nbdkit\_parse\_delay**(3)](/nbdkit_parse_delay/3.md).

## AUTHORS

Eric Blake

## COPYRIGHT

Copyright Red Hat

## LICENSE

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

- •

  Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

- •

  Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

- •

  Neither the name of Red Hat nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.