nbdkit-rotational-filter - Man Page

set if a plugin is rotational or not

Synopsis

 nbdkit --filter=rotational PLUGIN [rotational=true|false]

Description

nbdkit-rotational-filter is a filter for nbdkit(1) which lets you change the rotational property of a plugin.

The rotational property is a boolean flag which hints to the client whether the plugin behaves like a spinning disk (if rotational is true) or like a solid state disk or RAM (if rotational is false).  If a disk is rotational, then the client may attempt to schedule disk accesses to reduce seek times using the elevator algorithm (https://en.wikipedia.org/wiki/Elevator_algorithm).

Adding this filter without using the rotational parameter forces the plugin to advertise that it is rotational.  You can explicitly set the rotational property by using rotational=true or rotational=false.

Parameters

rotational=true

Set the rotational property, indicating that the plugin behaves like a spinning disk.  This is the default when you enable this filter.

rotational=false

Clear the rotational property, indicating that the plugin behaves like a solid state disk or RAM.

Files

$filterdir/nbdkit-rotational-filter.so

The filter.

Use nbdkit --dump-config to find the location of $filterdir.

Version

nbdkit-rotational-filter first appeared in nbdkit 1.40.

See Also

nbdkit(1), nbdkit-file-plugin(1), nbdkit-readonly-filter(1), nbdkit-spinning-filter(1), nbdinfo(1), nbdkit-filter(3), https://en.wikipedia.org/wiki/Elevator_algorithm.

Authors

Richard W.M. Jones

License

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

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.

Referenced By

nbdkit(1), nbdkit-filter(3), nbdkit-release-notes-1.40(1), nbdkit-spinning-filter(1).

2024-10-14 nbdkit-1.41.8