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