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 August 8, 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 .In sys/socket.h
  37 .Ft int
  38 .Fn setfib "int fib"
  39 .Sh DESCRIPTION
  40 The
  41 .Fn setfib
  42 system call sets the associated fib for all sockets opened
  43 subsequent to the call, to be that of the argument
  44 .Fa fib .
  45 The
  46 .Fa fib
  47 argument
  48 may be between 0 and the current system maximum which
  49 may be retrieved by the
  50 .Va net.fibs
  51 sysctl.
  52 The default fib of the process will be applied to all protocol families
  53 that support multiple fibs, and ignored by those that do not.
  54 The default fib for a process may be overridden for a socket with the use
  55 of the
  56 .Dv SO_SETFIB
  57 socket option.
  58 .Sh RETURN VALUES
  59 .Rv -std setfib
  60 .Sh ERRORS
  61 The
  62 .Fn setfib
  63 system call
  64 will fail and no action will be taken and return
  65 .Er EINVAL
  66 if the
  67 .Fa fib
  68 argument is greater than the current system maximum.
  69 .Sh SEE ALSO
  70 .Xr setfib 1 ,
  71 .Xr setsockopt 2
  72 .Sh STANDARDS
  73 The
  74 .Fn setfib
  75 system call is a
  76 .Fx
  77 extension however similar extensions
  78 have been added to many other
  79 .Ux style kernels.
  80 .Sh HISTORY
  81 The
  82 .Fn setfib
  83 function appeared in
  84 .Fx 7.1 .