share/man/man9/accf_data.9

   1 .\"
   2 .\" Copyright (c) 2000 Alfred Perlstein
   3 .\"
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/share/man/man9/accf_data.9,v 1.8 2005/01/18 20:52:51 ru Exp $
  27 .\" "
  28 .Dd August 10, 2008
  29 .Dt ACCF_DATA 9
  30 .Os
  31 .Sh NAME
  32 .Nm accf_data
  33 .Nd buffer incoming connections until data arrives
  34 .Sh SYNOPSIS
  35 .Cd "options INET"
  36 .Cd "pseudo-device accf_data"
  37 .Sh DESCRIPTION
  38 This is a filter to be placed on a socket that will be using
  39 .Fn accept
  40 to receive incoming connections.
  41 .Pp
  42 It prevents the application from receiving the connected descriptor via
  43 .Fn accept
  44 until data arrives on the connection.
  45 .Sh EXAMPLES
  46 If the accf_data accept filter is present in the kernel configuration,
  47 this will enable the data accept filter
  48 on the socket
  49 .Fa sok .
  50 .Bd -literal -offset 0i
  51         struct accept_filter_arg afa;
  52
  53         bzero(&afa, sizeof(afa));
  54         strcpy(afa.af_name, "dataready");
  55         setsockopt(sok, SOL_SOCKET, SO_ACCEPTFILTER, &afa, sizeof(afa));
  56 .Ed
  57 .Sh SEE ALSO
  58 .Xr setsockopt 2 ,
  59 .Xr accept_filter 9 ,
  60 .Xr accf_http 9
  61 .Sh HISTORY
  62 The accept filter mechanism and the
  63 accf_data filter were introduced in
  64 .Fx 4.0 .
  65 They were ported to
  66 .Nx
  67 by Coyote Point Systems and appeared in
  68 .Nx 5.0 .
  69 .Sh AUTHORS
  70 This manual page and the filter were written by
  71 .An Alfred Perlstein .