lib/libc/sys/setfib.2

   1 .\" Copyright (c) 2008 Cisco Systems.  All rights reserved.
   2 .\"    Author: Julian Elischer
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Neither the name of the Cisco Systems nor the names of its employees
  10 .\"    may be used to endorse or promote products derived from this software
  11 .\"    without specific prior written permission.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd May 9, 2008
  28 .Dt SETFIB 2
  29 .Os
  30 .Sh NAME
  31 .Nm setfib
  32 .Nd set the default FIB (routing table) for the calling process.
  33 .Sh LIBRARY
  34 .Lb libc
  35 .Sh SYNOPSIS
  36 .Ft int
  37 .Fn setfib "int fib"
  38 .Sh DESCRIPTION
  39 The
  40 .Fn setfib
  41 system call sets the associated fib for all sockets opened
  42 subsequent to the call, to be that of the argument
  43 .Fa fib .
  44 The
  45 .Fa fib
  46 argument
  47 may be between 0 and the current system maximum which
  48 may be retrieved by the
  49 .Em net.fibs
  50 sysctl.
  51 The default fib of the process will be applied to all protocol families
  52 that support multiple fibs, and ignored by those that do not.
  53 The default fib for a process may be overidden for a socket with the use
  54 of the SO_SETFIB socket option.
  55 .Sh RETURN VALUES
  56 .Rv -std setfib
  57 .Sh ERRORS
  58 The
  59 .Fn setfib
  60 system call
  61 will fail and no action will be taken and return
  62 .Er EINVAL
  63 if the
  64 .Fa fib
  65 argument is greater than the current system maximum.
  66 .El
  67 .Sh SEE ALSO
  68 .Xr setsockopt 2 ,
  69 .Xr setfib 8
  70 .Sh STANDARDS
  71 The
  72 .Fn setfib
  73 system call is a FreeBSD extension however similar extensions
  74 have been added to many other UNIX style kernels.
  75 .Sh HISTORY
  76 The
  77 .Fn setfib
  78 function appeared in
  79 .Fx 8.0 .