share/man/man9/ieee80211_node.9

   1 .\"
   2 .\" Copyright (c) 2004 Bruce M. Simpson <bms@spc.org>
   3 .\" Copyright (c) 2004 Darron Broad <darron@kewl.org>
   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 AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD$
  28 .\" $Id: ieee80211_node.9,v 1.6 2004/03/04 12:33:27 bruce Exp $
  29 .\"
  30 .Dd March 2, 2004
  31 .Dt ieee80211_node 9
  32 .Os
  33 .Sh NAME
  34 .Nm ieee80211_node
  35 .Nd software 802.11 stack node management functions
  36 .Sh SYNOPSIS
  37 .In net80211/ieee80211_var.h
  38 .In net80211/ieee80211_proto.h
  39 .In net80211/ieee80211_node.h
  40 .Ft void
  41 .Fn ieee80211_node_attach "struct ifnet *ifp"
  42 .Ft void
  43 .Fn ieee80211_node_lateattach "struct ifnet *ifp"
  44 .Ft void
  45 .Fn ieee80211_node_detach "struct ifnet *ifp"
  46 .Ft void
  47 .Fn ieee80211_begin_scan "struct ifnet *ifp"
  48 .Ft void
  49 .Fn ieee80211_next_scan "struct ifnet *ifp"
  50 .Ft void
  51 .Fn ieee80211_create_ibss "struct ieee80211com *ic" "struct ieee80211_channel *chan"
  52 .Ft void
  53 .Fn ieee80211_end_scan "struct ifnet *ifp"
  54 .Ft struct ieee80211_node *
  55 .Fn ieee80211_alloc_node "struct ieee80211com *ic" "u_int8_t *macaddr"
  56 .Ft struct ieee80211_node *
  57 .Fn ieee80211_dup_bss "struct ieee80211com *ic" "u_int8_t *macaddr"
  58 .Ft struct ieee80211_node *
  59 .Fn ieee80211_find_node "struct ieee80211com *ic" "u_int8_t *macaddr"
  60 .Ft struct ieee80211_node *
  61 .Fn ieee80211_lookup_node "struct ieee80211com *ic" "u_int8_t *macaddr" "struct ieee80211_channel *chan"
  62 .Ft void
  63 .Fn ieee80211_free_node "struct ieee80211com *ic" "struct ieee80211_node *ni"
  64 .Ft void
  65 .Fn ieee80211_free_allnodes "struct ieee80211com *ic"
  66 .Ft void
  67 .Fn ieee80211_timeout_nodes "struct ieee80211com *ic"
  68 .Ft void
  69 .Fn ieee80211_iterate_nodes "struct ieee80211com *ic" "ieee80211_iter_func *f" "void *arg"
  70 .Sh DESCRIPTION
  71 The
  72 .Nm
  73 collection of functions are used to manage node lists within the software
  74 802.11 stack.
  75 These lists are typically used for implementing host-mode AP functionality,
  76 or providing signal quality information about neighbouring nodes.
  77 .Sh SEE ALSO
  78 .Xr ieee80211 9 ,
  79 .Xr ifnet 9
  80 .Sh HISTORY
  81 The
  82 .Nm
  83 series of functions first appeared in
  84 .Nx 1.5 ,
  85 and were later ported to
  86 .Fx 4.6 .
  87 .Sh AUTHORS
  88 This man page was written by
  89 .An Bruce M. Simpson Aq bms@FreeBSD.org
  90 and
  91 .An Darron Broad Aq darron@kewl.org .