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...


#define NdpRouterAdvContext   struct _NdpRouterAdvContext


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


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...


systime_t ndpRouterAdvTickCounter

Detailed Description

Router advertisement service.


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.

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

Definition in file ndp_router_adv.h.

Macro Definition Documentation



Definition at line 54 of file ndp_router_adv.h.



Definition at line 40 of file ndp_router_adv.h.



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.

[out]settingsStructure 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.

[in]contextPointer to the RA service context
[in]settingsRA service configuration variables
Error code

Definition at line 128 of file ndp_router_adv.c.

◆ ndpRouterAdvStart()

error_t ndpRouterAdvStart ( NdpRouterAdvContext context)

Start RA service.

[in]contextPointer to the RA service context
Error code

Definition at line 174 of file ndp_router_adv.c.

◆ ndpRouterAdvStop()

error_t ndpRouterAdvStop ( NdpRouterAdvContext context)

Stop RA service.

[in]contextPointer to the RA service context
Error code

Definition at line 252 of file ndp_router_adv.c.

Variable Documentation

◆ ndpRouterAdvTickCounter

systime_t ndpRouterAdvTickCounter

Definition at line 51 of file ndp_router_adv_misc.c.