/**************************************************************************** * include/net/route.h * * Copyright (C) 2013 Gregory Nutt. All rights reserved. * Author: Gregory Nutt * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * 3. Neither the name NuttX nor the names of its contributors may be * used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED * AND ON 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 ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * ****************************************************************************/ #ifndef __INCLUDE_NET_ROUTE_H #define __INCLUDE_NET_ROUTE_H /**************************************************************************** * Included Files ****************************************************************************/ #include #include #include #ifdef CONFIG_NET_ROUTE /**************************************************************************** * Pre-processor Definitions ****************************************************************************/ /**************************************************************************** * Public Types ****************************************************************************/ /* This structure describes the route information passed with the SIOCADDRT * and SIOCDELRT ioctl commands (see include/nuttx/net/ioctl.h). */ struct rtentry { FAR struct sockaddr_storage *rt_target; /* Address of the network */ FAR struct sockaddr_storage *rt_netmask; /* Network mask defining the sub-net */ FAR struct sockaddr_storage *rt_router; /* Gateway address associated with the hop */ }; /**************************************************************************** * Public Data ****************************************************************************/ #ifdef __cplusplus #define EXTERN extern "C" extern "C" { #else #define EXTERN extern #endif /**************************************************************************** * Public Function Prototypes ****************************************************************************/ /**************************************************************************** * Name: net_addroute * * Description: * Add a new route to the routing table. This is just a convenience * wrapper for the SIOCADDRT ioctl call. * * Parameters: * sockfd - Any socket descriptor * target - Target address on external network(required) * netmask - Network mask defining the external network (required) * router - Router address that on our network that can forward to the * external network. * * Returned Value: * OK on success; -1 on failure with the errno variable set appropriately. * ****************************************************************************/ int addroute(int sockfd, FAR struct sockaddr_storage *target, FAR struct sockaddr_storage *netmask, FAR struct sockaddr_storage *router); /**************************************************************************** * Name: net_delroute * * Description: * Add a new route to the routing table. This is just a convenience * wrapper for the SIOCADDRT ioctl call. * * Parameters: * sockfd - Any socket descriptor * target - Target address on the remote network (required) * netmask - Network mask defining the external network (required) * * Returned Value: * OK on success; -1 on failure with the errno variable set appropriately. * ****************************************************************************/ int delroute(int sockfd, FAR struct sockaddr_storage *target, FAR struct sockaddr_storage *netmask); #undef EXTERN #ifdef __cplusplus } #endif #endif /* CONFIG_NET_ROUTE */ #endif /* __INCLUDE_NET_ROUTE_H */