filters/limit/nbdkit-limit-filter.pod

   1 =head1 NAME
   2
   3 nbdkit-limit-filter - limit number of clients that can connect concurrently
   4
   5 =head1 SYNOPSIS
   6
   7  nbdkit --filter=limit PLUGIN [limit=N]
   8
   9 =head1 DESCRIPTION
  10
  11 C<nbdkit-limit-filter> is an nbdkit filter that limits the number of
  12 clients which can connect concurrently.  If more than C<limit=N>
  13 (default: 1) clients try to connect at the same time then later
  14 clients are rejected.
  15
  16 =head1 PARAMETERS
  17
  18 =over 4
  19
  20 =item B<limit=>N
  21
  22 Limit the number of concurrent clients to C<N>.  This parameter is
  23 optional.  If not specified then the limit defaults to 1.  You can
  24 also set this to 0 to make the number of clients unlimited (ie.
  25 disable the filter).
  26
  27 =back
  28
  29 =head1 FILES
  30
  31 =over 4
  32
  33 =item F<$filterdir/nbdkit-limit-filter.so>
  34
  35 The filter.
  36
  37 Use C<nbdkit --dump-config> to find the location of C<$filterdir>.
  38
  39 =back
  40
  41 =head1 VERSION
  42
  43 C<nbdkit-limit-filter> first appeared in nbdkit 1.20.
  44
  45 =head1 SEE ALSO
  46
  47 L<nbdkit(1)>,
  48 L<nbdkit-exitlast-filter(1)>,
  49 L<nbdkit-exitwhen-filter(1)>,
  50 L<nbdkit-ip-filter(1)>,
  51 L<nbdkit-noparallel-filter(1)>,
  52 L<nbdkit-rate-filter(1)>,
  53 L<nbdkit-filter(3)>,
  54 L<nbdkit-plugin(3)>.
  55
  56 =head1 AUTHORS
  57
  58 Richard W.M. Jones
  59
  60 =head1 COPYRIGHT
  61
  62 Copyright Red Hat