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.1.2.4 2001/08/17 13:08:54 ru Exp $
  27 .\" "
  28 .Dd November 15, 2000
  29 .Os
  30 .Dt ACCF_DATA 9
  31 .Sh NAME
  32 .Nm accf_data
  33 .Nd buffer incoming connections until data arrives
  34 .Sh SYNOPSIS
  35 .Nm options INET
  36 .Nm options ACCEPT_FILTER_DATA
  37 .Nm kldload accf_data
  38 .Sh DESCRIPTION
  39 This is a filter to be placed on a socket that will be using
  40 .Fn accept
  41 to receive incoming connections.
  42 .Pp
  43 It prevents the application from receiving the connected descriptor via
  44 .Fn accept
  45 until data arrives on the connection.
  46 .Pp
  47 The
  48 .Fa ACCEPT_FILTER_DATA
  49 kernel option is also a module that can be enabled at runtime via
  50 .Xr kldload 8
  51 if the INET option has been compiled into the kernel.
  52 .Sh EXAMPLE
  53 Assuming ACCEPT_FILTER_DATA has been included in the kernel config
  54 file or the module
  55 .Xr accf_data 9
  56 has been loaded, this will enable the data accept filter
  57 on the socket
  58 .Fa sok .
  59 .Bd -literal -offset 0i
  60         struct accept_filter_arg afa;
  61
  62         bzero(&afa, sizeof(afa));
  63         strcpy(afa.af_name, "dataready");
  64         setsockopt(sok, SOL_SOCKET, SO_ACCEPTFILTER, &afa, sizeof(afa));
  65 .Ed
  66 .Sh SEE ALSO
  67 .Xr setsockopt 2 ,
  68 .Xr accept_filter 9 ,
  69 .Xr accf_http 9
  70 .Sh HISTORY
  71 The accept filter mechanism and the
  72 accf_data filter were introduced in
  73 .Fx 4.0 .
  74 .Sh AUTHORS
  75 This manual page and the filter were written by
  76 .An Alfred Perlstein .