filters/retry-request/nbdkit-retry-request-filter.pod

   1 =head1 NAME
   2
   3 nbdkit-retry-request-filter - retry single requests on error
   4
   5 =head1 SYNOPSIS
   6
   7  nbdkit --filter=retry-request PLUGIN
   8                    [retry-request-retries=N] [retry-request-delay=N]
   9                    [retry-request-open=false]
  10
  11 =head1 DESCRIPTION
  12
  13 C<nbdkit-retry-request-filter> is a filter for nbdkit that
  14 transparently retries single requests if they fail.  This is useful
  15 for plugins that are not completely reliable or have random behaviour.
  16 For example L<nbdkit-curl-plugin(1)> might behave this way if pointed
  17 at a load balancer which sometimes redirects to a web server that is
  18 not responsive.
  19
  20 An alternative filter with different trade-offs is
  21 L<nbdkit-retry-filter(1)>.  That filter is more heavyweight because it
  22 always reopens the whole plugin connection on failure.
  23
  24 =head1 PARAMETERS
  25
  26 =over 4
  27
  28 =item B<retry-request-retries=>N
  29
  30 The number of times any single request will be retried before we give
  31 up and fail the operation.  The default is 2.
  32
  33 =item B<retry-request-delay=>N
  34
  35 The number of seconds to wait before retrying.  The default is 2
  36 seconds.
  37
  38 =item B<retry-request-open=false>
  39
  40 If set to false, do not retry opening the plugin.  The default is to
  41 treat plugin open in the same way as other requests.
  42
  43 =back
  44
  45 =head1 FILES
  46
  47 =over 4
  48
  49 =item F<$filterdir/nbdkit-retry-request-filter.so>
  50
  51 The filter.
  52
  53 Use C<nbdkit --dump-config> to find the location of C<$filterdir>.
  54
  55 =back
  56
  57 =head1 VERSION
  58
  59 C<nbdkit-retry-filter> first appeared in nbdkit 1.30.
  60
  61 =head1 SEE ALSO
  62
  63 L<nbdkit(1)>,
  64 L<nbdkit-filter(3)>,
  65 L<nbdkit-readahead-filter(1)>,
  66 L<nbdkit-retry-filter(1)>.
  67
  68 =head1 AUTHORS
  69
  70 Richard W.M. Jones
  71
  72 =head1 COPYRIGHT
  73
  74 Copyright Red Hat