Return to uroute.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / libpdel / net

libpdel

.\" Copyright (c) 2001-2002 Packet Design, LLC.
.\" All rights reserved.
.\" 
.\" Subject to the following obligations and disclaimer of warranty,
.\" use and redistribution of this software, in source or object code
.\" forms, with or without modifications are expressly permitted by
.\" Packet Design; provided, however, that:
.\" 
.\"    (i)  Any and all reproductions of the source or object code
.\"         must include the copyright notice above and the following
.\"         disclaimer of warranties; and
.\"    (ii) No rights are granted, in any manner or form, to use
.\"         Packet Design trademarks, including the mark "PACKET DESIGN"
.\"         on advertising, endorsements, or otherwise except as such
.\"         appears in the above copyright notice or in the software.
.\" 
.\" THIS SOFTWARE IS BEING PROVIDED BY PACKET DESIGN "AS IS", AND
.\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, PACKET DESIGN MAKES NO
.\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING
.\" THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED
.\" WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
.\" OR NON-INFRINGEMENT.  PACKET DESIGN DOES NOT WARRANT, GUARANTEE,
.\" OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS
.\" OF THE USE OF THIS SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY,
.\" RELIABILITY OR OTHERWISE.  IN NO EVENT SHALL PACKET DESIGN BE
.\" LIABLE FOR ANY DAMAGES RESULTING FROM OR ARISING OUT OF ANY USE
.\" OF THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY DIRECT,
.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE, OR CONSEQUENTIAL
.\" DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, LOSS OF
.\" USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY THEORY OF
.\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
.\" THE USE OF THIS SOFTWARE, EVEN IF PACKET DESIGN IS ADVISED OF
.\" THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" Author: Archie Cobbs <archie@freebsd.org>
.\"
.\" $Id: uroute.3,v 1.1.1.1 2012/02/21 23:25:53 misho Exp $
.\"
.Dd April 22, 2002
.Dt UROUTE 3
.Os
.Sh NAME
.Nm uroute
.Nd networking route objects
.Sh LIBRARY
PDEL Library (libpdel, \-lpdel)
.Sh SYNOPSIS
.In sys/types.h
.In sys/socket.h
.In stdio.h
.In pdel/net/uroute.h
.Ft "struct uroute *"
.Fn uroute_create "const struct sockaddr *dest" "const struct sockaddr *gateway" "const struct sockaddr *netmask"
.Ft "void"
.Fn uroute_destroy "struct uroute **routep"
.Ft "const struct sockaddr *"
.Fn uroute_get_dest "struct uroute *route"
.Ft "const struct sockaddr *"
.Fn uroute_get_gateway "struct uroute *route"
.Ft "const struct sockaddr *"
.Fn uroute_get_netmask "struct uroute *route"
.Ft "int"
.Fn uroute_get_flags "struct uroute *route"
.Ft "void"
.Fn uroute_set_flags "struct uroute *route" "int flags"
.Ft "int"
.Fn uroute_add "struct uroute *route"
.Ft "int"
.Fn uroute_delete "struct uroute *route"
.Ft "struct uroute *"
.Fn uroute_get "const struct sockaddr *dest"
.Ft "int"
.Fn uroute_get_all "struct uroute ***listp" "const char *mtype"
.Ft "void"
.Fn uroute_print "struct uroute *route" "FILE *fp"
.Sh DESCRIPTION
These functions support
.Nm uroute
objects, used for representing kernel routes in user code.
Each
.Nm uroute
instance is represented by a
.Li "struct uroute" .
.Pp
.Fn uroute_create
creates a new
.Nm uroute
object using copies of the supplied
.Fa dest ,
.Fa gateway ,
and
.Fa netmask .
The
.Fa netmask
should be
.Dv NULL
to specify a host route instead of a network route.
.Pp
.Fn uroute_destroy
destroys the object pointed to by
.Fa "*routep" .
Upon return,
.Fa "*routep"
will be set to
.Dv NULL .
If
.Fa "*routep"
is already
.Dv NULL
when
.Fn uroute_destroy
is invoked, nothing happens.
.Pp
.Fn uroute_get_dest ,
.Fn uroute_get_gateway ,
and
.Fn uroute_get_netmask
return the addresses associated with the route.
Note that
.Fn uroute_get_netmask
returns
.Dv NULL
to indicate that
.Fa route
is a host route.
.Pp
.Fn uroute_get_flags
and
.Fn uroute_set_flags
are used to access or modify the flags associated with the route;
these flags are defined in the header file
.Li "<net/route.h>" .
The only flag set for a newly created route is
.Dv RTF_STATIC .
.Pp
.Fn uroute_add
attempts to add the
.Fa route
to the kernel routing table.
.Pp
.Fn uroute_delete
attempts to remove the
.Fa route
from the kernel routing table.
.Pp
.Fn uroute_get
attempts to retrieve the route matching
.Fa dest
from the kernel routing table.
.Pp
.Fn uroute_get_all
retrieves the entire kernel routing table.
Zero or more
.Nm uroute
objects are constructed and pointed to by the elements of a newly
allocated array of pointers.
The length of the array is returned by
.Fn uroute_get_all
and a pointer to the array is stored in
.Fa "*listp" .
The array itself is allocated with
.Xr typed_mem 3
type
.Fa mtype ,
and the caller is responsible for eventually freeing it (as well as
destroying the individudal
.Nm uroute
objects).
.Pp
.Fn uroute_print
prints out
.Fa uroute
to the stream
.Fa fp
for debugging purposes.
.Sh RETURN VALUES
.Fn uroute_create ,
.Fn uroute_add ,
.Fn uroute_delete ,
.Fn uroute_get ,
and
.Fn uroute_get_all
return -1 or
.Dv NULL
to indicate an error, with
.Va errno
set appropriately.
.Sh SEE ALSO
.Xr if_util 3 ,
.Xr libpdel 3 ,
.Xr typed_mem 3 ,
.Xr route_msg 3 ,
.Xr route 4
.Sh HISTORY
The PDEL library was developed at Packet Design, LLC.
.Dv "http://www.packetdesign.com/"
.Sh AUTHORS
.An Archie Cobbs Aq archie@freebsd.org