oracular (3) nbdkit_parse_delay.3.gz

Provided by: nbdkit-plugin-dev_1.40.4-1ubuntu1_amd64 bug

NAME
       nbdkit_parse_delay - parse human-readable delays and sleeps for nbdkit


SYNOPSIS
        #include <nbdkit-plugin.h>

        int nbdkit_parse_delay (const char *what, const char *str,
                                unsigned *sec, unsigned *nsec);


DESCRIPTION
       The utility function "nbdkit_parse_delay" can be used to parse configuration parameters on the nbdkit(1)
       command line specifying delays and sleeps.

       The "str" parameter is a string in one of the following formats:

       1
       1.2
       "1.2s"
           Seconds

       "1.2ms"
       "120ms"
           Milliseconds

       "1.2us"
       "1.2μs"
       "120μs"
           Microseconds

       "1ns"
           Nanoseconds, the smallest possible time division for this function.

       The "what" parameter is printed in error messages to provide context.

       The output ("sec", "nsec") can be passed straight to nbdkit_nanosleep(3).


RETURN VALUE
       On success the function returns 0 and sets *sec and *nsec to the seconds and nanoseconds parsed.

       If there is an error it calls nbdkit_error(3) and returns -1.  In this case, *sec and *nsec are not
       touched.


LANGUAGE BINDINGS
       In nbdkit-ocaml-plugin(3):

        NBDKit.parse_delay : string -> string -> int * int

       In nbdkit-python-plugin(3):

        import nbdkit
        (sec, nsec) = nbdkit.parse_delay(what, str)


HISTORY
       "nbdkit_parse_delay" was added in nbdkit 1.40.


SEE ALSO
       nbdkit(1), nbdkit_parse_bool(3), nbdkit_parse_int(3), nbdkit_parse_probability(3), nbdkit_parse_size(3),
       nbdkit_nanosleep(3), nbdkit-plugin(3), nbdkit-filter(3), nbdkit-delay-filter(1).


AUTHORS
       Richard W.M. Jones


       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.