ndp_router_adv.h File Reference

Router advertisement service. More...

#include "core/net.h"
#include "ipv6/ipv6.h"

Go to the source code of this file.

Data Structures
struct	NdpRouterAdvPrefixInfo
	IPv6 prefix information. More...
struct	NdpRouterAdvRouteInfo
	Route information. More...
struct	NdpRouterAdvContextInfo
	Context information for 6LoWPAN header compression. More...
struct	NdpRouterAdvSettings
	RA service settings. More...
struct	_NdpRouterAdvContext
	RA service context. More...

Macros
#define	NDP_ROUTER_ADV_SUPPORT   DISABLED
#define	NDP_ROUTER_ADV_TICK_INTERVAL   100
#define	NDP_ROUTER_ADV_PRIVATE_CONTEXT
#define	NdpRouterAdvContext   struct _NdpRouterAdvContext

Typedefs
typedef void(*	NdpRouterAddOptionsCallback) (NdpRouterAdvContext *context, NdpRouterAdvMessage *message, size_t *length)
	Add Router Advertisement options callback. More...

Functions
void	ndpRouterAdvGetDefaultSettings (NdpRouterAdvSettings *settings)
	Initialize settings with default values. More...
error_t	ndpRouterAdvInit (NdpRouterAdvContext *context, const NdpRouterAdvSettings *settings)
	RA service initialization. More...
error_t	ndpRouterAdvStart (NdpRouterAdvContext *context)
	Start RA service. More...
error_t	ndpRouterAdvStop (NdpRouterAdvContext *context)
	Stop RA service. More...

Variables
systime_t	ndpRouterAdvTickCounter

Detailed Description

Router advertisement service.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author

Oryx Embedded SARL (www.oryx-embedded.com)

Version

2.4.0

Definition in file ndp_router_adv.h.

Macro Definition Documentation

NDP_ROUTER_ADV_PRIVATE_CONTEXT

#define NDP_ROUTER_ADV_PRIVATE_CONTEXT

Definition at line 54 of file ndp_router_adv.h.

NDP_ROUTER_ADV_SUPPORT

#define NDP_ROUTER_ADV_SUPPORT   DISABLED

Definition at line 40 of file ndp_router_adv.h.

NDP_ROUTER_ADV_TICK_INTERVAL

#define NDP_ROUTER_ADV_TICK_INTERVAL   100

Definition at line 47 of file ndp_router_adv.h.

NdpRouterAdvContext

#define NdpRouterAdvContext   struct _NdpRouterAdvContext

Definition at line 59 of file ndp_router_adv.h.

Typedef Documentation

NdpRouterAddOptionsCallback

typedef void(* NdpRouterAddOptionsCallback) (NdpRouterAdvContext *context, NdpRouterAdvMessage *message, size_t *length)

Add Router Advertisement options callback.

Definition at line 71 of file ndp_router_adv.h.

Function Documentation

ndpRouterAdvGetDefaultSettings()

void ndpRouterAdvGetDefaultSettings

(

NdpRouterAdvSettings *

settings

)

Initialize settings with default values.

Parameters

[out]

settings

Structure that contains the RA service configuration variables

Definition at line 49 of file ndp_router_adv.c.

ndpRouterAdvInit()

error_t ndpRouterAdvInit	(	NdpRouterAdvContext *	context,
		const NdpRouterAdvSettings *	settings
	)

RA service initialization.

Parameters

[in]	context	Pointer to the RA service context
[in]	settings	RA service configuration variables

Returns

Error code

Definition at line 128 of file ndp_router_adv.c.

ndpRouterAdvStart()

error_t ndpRouterAdvStart

(

NdpRouterAdvContext *

context

)

Start RA service.

Parameters

[in]

context

Pointer to the RA service context

Returns

Error code

Definition at line 174 of file ndp_router_adv.c.

ndpRouterAdvStop()

error_t ndpRouterAdvStop

(

NdpRouterAdvContext *

context

)

Stop RA service.

Parameters

[in]

context

Pointer to the RA service context

Returns

Error code

Definition at line 252 of file ndp_router_adv.c.

Variable Documentation

ndpRouterAdvTickCounter

systime_t ndpRouterAdvTickCounter

extern

Definition at line 51 of file ndp_router_adv_misc.c.