GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  ACCEPT_FILTER (9)

NAME

accept_filter, accept_filt_add, accept_filt_del, accept_filt_generic_mod_event, accept_filt_get - filter incoming connections

CONTENTS

Synopsis
Description
Implementation Notes
See Also
History
Authors

SYNOPSIS


.In sys/types.h
.In sys/module.h
.In sys/socket.h
.Fd #define ACCEPT_FILTER_MOD
.In sys/socketvar.h int accept_filt_add struct accept_filter *filt int accept_filt_del char *name int accept_filt_generic_mod_event module_t mod int event void *data struct accept_filter * accept_filt_get char *name

DESCRIPTION

Accept filters allow an application to request that the kernel pre-process incoming connections. An accept filter is requested via the setsockopt(2) system call, passing in an optname of SO_ACCEPTFILTER.

IMPLEMENTATION NOTES

A module that wants to be an accept filter must provide a
.Vt struct accept_filter to the system:
struct accept_filter {
        char    accf_name[16];
        void    (*accf_callback)(struct socket *so, void *arg, int waitflag);
        void *  (*accf_create)(struct socket *so, char *arg);
        void    (*accf_destroy)(struct socket *so);
        SLIST_ENTRY(accept_filter) accf_next;   /* next on the list */
};

The module should register it with the function accept_filt_add, passing a pointer to a
.Vt struct accept_filter , allocated with malloc(9).

The fields of
.Vt struct accept_filter are as follows:
accf_name Name of the filter; this is how it will be accessed from userland.
accf_callback
  The callback that the kernel will do once the connection is established. It is the same as a socket upcall and will be called when the connection is established and whenever new data arrives on the socket, unless the callback modifies the socket’s flags.
accf_create Called whenever a setsockopt(2) installs the filter onto a listening socket.
accf_destroy Called whenever the user removes the accept filter on the socket.

The accept_filt_del function passed the same string used in accept_filter.accf_name during registration with accept_filt_add, the kernel will then disallow and further userland use of the filter.

The accept_filt_get function is used internally to locate which accept filter to use via the setsockopt(2) system call.

The accept_filt_generic_mod_event function provides a simple way to avoid duplication of code for accept filters which do not use the argument field to load and unload themselves. This function can be used in the
.Vt moduledata_t struct for the DECLARE_MODULE(9) macro.

SEE ALSO

setsockopt(2), accf_data(9), accf_dns(9), accf_http(9), malloc(9)

HISTORY

The accept filter mechanism was introduced in
.Fx 4.0 .

AUTHORS

This manual page was written by
.An -nosplit
.An Alfred Perlstein ,
.An Sheldon Hearn and
.An Jeroen Ruigrok van der Werven.

The accept filter concept was pioneered by
.An David Filo at Yahoo! and refined to be a loadable module system by
.An Alfred Perlstein .

Search for    or go to Top of page |  Section 9 |  Main Index


Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.