:orphan:

.. index:: pair: struct; netconf_route
.. _doxid-structnetconf__route:

struct netconf_route
====================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Routing table entry :ref:`More...<details-structnetconf__route>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <netconf.h>
	
	struct netconf_route {
		// fields
	
		unsigned char :ref:`family<doxid-structnetconf__route_1a1df06d0715e3ba6a2da54f14bdc57e20>`;
		unsigned char :ref:`dstlen<doxid-structnetconf__route_1a09fb6207c1e657c4115cde2bf8a39a83>`;
		unsigned char :ref:`srclen<doxid-structnetconf__route_1a865498d31b0f43c17e63086ff089e24e>`;
		unsigned char :ref:`tos<doxid-structnetconf__route_1ac5f9ffcbdb45baa5228cf9fbcfe8acb1>`;
		:ref:`netconf_route_table<doxid-netconf_8h_1a2aac7022de92afc39ac8f1fb6944d106>` :ref:`table<doxid-structnetconf__route_1a998c775bb96596ebc2514e92725c624b>`;
		:ref:`netconf_route_prot<doxid-netconf_8h_1ad83c72e33f0d0fb0569c61d29a292d98>` :ref:`protocol<doxid-structnetconf__route_1a4916eb2a0c87eb66adea1aa0c10b71cf>`;
		:ref:`netconf_route_scope<doxid-netconf_8h_1ac00172233d04dabd55c5e7b3acfddab2>` :ref:`scope<doxid-structnetconf__route_1aa14f5a9112ac5eebfe5d9abd76e64a9c>`;
		:ref:`netconf_route_type<doxid-netconf_8h_1aff9c592136d7980910d76e2ed5e12e93>` :ref:`type<doxid-structnetconf__route_1adb696ef1798859c7ab74b6de4cd28b99>`;
		unsigned int :ref:`flags<doxid-structnetconf__route_1a8c00506b25d695ba7b12e3e57c298511>`;
		int :ref:`oifindex<doxid-structnetconf__route_1ac3fcf2466bbb8bbbee79486be3e22d0b>`;
		uint8_t* :ref:`dst<doxid-structnetconf__route_1af6d655beebc1af2db87767e447a206f8>`;
		uint8_t* :ref:`src<doxid-structnetconf__route_1acba4a31a36e3956c9053dc1d708fa926>`;
		uint8_t* :ref:`gateway<doxid-structnetconf__route_1ab234a16befbfbbd2956bf6a73edbd690>`;
		int :ref:`metric<doxid-structnetconf__route_1ae19a50dec692fb32c93e6dd827bd0cc3>`;
		uint32_t :ref:`mtu<doxid-structnetconf__route_1a12f7104bbd2f7cb1e7acd1c7204188f6>`;
		uint32_t :ref:`win<doxid-structnetconf__route_1aee9bea174bc321d2c8a4977723edf1db>`;
		uint32_t :ref:`irtt<doxid-structnetconf__route_1ae93017892ca0428a3f2ed269a0ce2d2b>`;
		uint32_t :ref:`hoplimit<doxid-structnetconf__route_1a49e829225b691ada2f52ad8eeacfbc69>`;
		int32_t :ref:`expires<doxid-structnetconf__route_1a198821f99a16ad0495581b4093573393>`;
		netconf_route_nexthops :ref:`hops<doxid-structnetconf__route_1aec3c4bf638cadf88b9e460d77ac9c0ee>`;
	};
.. _details-structnetconf__route:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Routing table entry

Fields
------

.. index:: pair: variable; family
.. _doxid-structnetconf__route_1a1df06d0715e3ba6a2da54f14bdc57e20:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unsigned char family

Address family of route

.. index:: pair: variable; dstlen
.. _doxid-structnetconf__route_1a09fb6207c1e657c4115cde2bf8a39a83:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unsigned char dstlen

Prefix length of destination

.. index:: pair: variable; srclen
.. _doxid-structnetconf__route_1a865498d31b0f43c17e63086ff089e24e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unsigned char srclen

Prefix length of preferred source

.. index:: pair: variable; tos
.. _doxid-structnetconf__route_1ac5f9ffcbdb45baa5228cf9fbcfe8acb1:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unsigned char tos

Type Of Service key

.. index:: pair: variable; table
.. _doxid-structnetconf__route_1a998c775bb96596ebc2514e92725c624b:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`netconf_route_table<doxid-netconf_8h_1a2aac7022de92afc39ac8f1fb6944d106>` table

Routing table id

.. index:: pair: variable; protocol
.. _doxid-structnetconf__route_1a4916eb2a0c87eb66adea1aa0c10b71cf:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`netconf_route_prot<doxid-netconf_8h_1ad83c72e33f0d0fb0569c61d29a292d98>` protocol

Protocol of this route

.. index:: pair: variable; scope
.. _doxid-structnetconf__route_1aa14f5a9112ac5eebfe5d9abd76e64a9c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`netconf_route_scope<doxid-netconf_8h_1ac00172233d04dabd55c5e7b3acfddab2>` scope

Route scope

.. index:: pair: variable; type
.. _doxid-structnetconf__route_1adb696ef1798859c7ab74b6de4cd28b99:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`netconf_route_type<doxid-netconf_8h_1aff9c592136d7980910d76e2ed5e12e93>` type

Type of route entry

.. index:: pair: variable; flags
.. _doxid-structnetconf__route_1a8c00506b25d695ba7b12e3e57c298511:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unsigned int flags

Route flags

.. index:: pair: variable; oifindex
.. _doxid-structnetconf__route_1ac3fcf2466bbb8bbbee79486be3e22d0b:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	int oifindex

Output device index

.. index:: pair: variable; dst
.. _doxid-structnetconf__route_1af6d655beebc1af2db87767e447a206f8:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	uint8_t* dst

Destination of the route

.. index:: pair: variable; src
.. _doxid-structnetconf__route_1acba4a31a36e3956c9053dc1d708fa926:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	uint8_t* src

Preferred source

.. index:: pair: variable; gateway
.. _doxid-structnetconf__route_1ab234a16befbfbbd2956bf6a73edbd690:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	uint8_t* gateway

Gateway address

.. index:: pair: variable; metric
.. _doxid-structnetconf__route_1ae19a50dec692fb32c93e6dd827bd0cc3:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	int metric

Route priority

.. index:: pair: variable; mtu
.. _doxid-structnetconf__route_1a12f7104bbd2f7cb1e7acd1c7204188f6:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	uint32_t mtu

Route MTU

.. index:: pair: variable; win
.. _doxid-structnetconf__route_1aee9bea174bc321d2c8a4977723edf1db:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	uint32_t win

Route window size

.. index:: pair: variable; irtt
.. _doxid-structnetconf__route_1ae93017892ca0428a3f2ed269a0ce2d2b:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	uint32_t irtt

Route transfer time

.. index:: pair: variable; hoplimit
.. _doxid-structnetconf__route_1a49e829225b691ada2f52ad8eeacfbc69:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	uint32_t hoplimit

Route hoplimit (influences both IPv4 TTL and IPv6 Hop Limit header fields)

.. index:: pair: variable; expires
.. _doxid-structnetconf__route_1a198821f99a16ad0495581b4093573393:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	int32_t expires

Route expiration time

.. index:: pair: variable; hops
.. _doxid-structnetconf__route_1aec3c4bf638cadf88b9e460d77ac9c0ee:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	netconf_route_nexthops hops

Nexthops of a multipath route.