2013-10-02 14:58:37 +02:00
|
|
|
/****************************************************************************
|
|
|
|
* include/net/route.h
|
|
|
|
*
|
|
|
|
* Copyright (C) 2013 Gregory Nutt. All rights reserved.
|
|
|
|
* Author: Gregory Nutt <gnutt@nuttx.org>
|
|
|
|
*
|
|
|
|
* 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 <nuttx/config.h>
|
|
|
|
|
|
|
|
#include <sys/socket.h>
|
|
|
|
|
|
|
|
#include <nuttx/net/ioctl.h>
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* 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).
|
|
|
|
*/
|
|
|
|
|
2013-10-02 18:51:48 +02:00
|
|
|
struct rtentry
|
2013-10-02 14:58:37 +02:00
|
|
|
{
|
2019-11-10 19:35:15 +01:00
|
|
|
struct sockaddr_storage rt_dst; /* Address of the network */
|
|
|
|
struct sockaddr_storage rt_gateway; /* Gateway address associated with
|
|
|
|
* the hop */
|
|
|
|
struct sockaddr_storage rt_genmask; /* Network mask defining the sub-net */
|
|
|
|
uint16_t rt_flags;
|
2013-10-02 14:58:37 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Public Data
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
#define EXTERN extern "C"
|
|
|
|
extern "C"
|
|
|
|
{
|
|
|
|
#else
|
|
|
|
#define EXTERN extern
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Public Function Prototypes
|
|
|
|
****************************************************************************/
|
|
|
|
|
2013-10-02 18:51:48 +02:00
|
|
|
/****************************************************************************
|
2017-04-22 00:33:14 +02:00
|
|
|
* Name: net_addroute
|
2013-10-02 18:51:48 +02:00
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* Add a new route to the routing table. This is just a convenience
|
|
|
|
* wrapper for the SIOCADDRT ioctl call.
|
|
|
|
*
|
2018-03-13 16:52:27 +01:00
|
|
|
* Input Parameters:
|
2013-10-02 18:51:48 +02:00
|
|
|
* sockfd - Any socket descriptor
|
2013-10-05 20:05:51 +02:00
|
|
|
* 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.
|
2013-10-02 18:51:48 +02:00
|
|
|
*
|
|
|
|
* 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,
|
2013-10-05 20:05:51 +02:00
|
|
|
FAR struct sockaddr_storage *router);
|
2013-10-02 18:51:48 +02:00
|
|
|
|
|
|
|
/****************************************************************************
|
2017-04-22 00:33:14 +02:00
|
|
|
* Name: net_delroute
|
2013-10-02 18:51:48 +02:00
|
|
|
*
|
|
|
|
* Description:
|
2020-01-31 19:09:01 +01:00
|
|
|
* Delete a route from the routing table. This is just a convenience
|
|
|
|
* wrapper for the SIOCDELRT ioctl call.
|
2013-10-02 18:51:48 +02:00
|
|
|
*
|
2018-03-13 16:52:27 +01:00
|
|
|
* Input Parameters:
|
2013-10-02 18:51:48 +02:00
|
|
|
* sockfd - Any socket descriptor
|
2013-10-05 20:05:51 +02:00
|
|
|
* target - Target address on the remote network (required)
|
|
|
|
* netmask - Network mask defining the external network (required)
|
2013-10-02 18:51:48 +02:00
|
|
|
*
|
|
|
|
* 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);
|
|
|
|
|
2013-10-02 14:58:37 +02:00
|
|
|
#undef EXTERN
|
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#endif /* __INCLUDE_NET_ROUTE_H */
|