ndp_router_adv_misc.h File Reference

Helper functions for router advertisement service. More...

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

Go to the source code of this file.

Functions

void ndpRouterAdvTick (NdpRouterAdvContext *context)
 RA service timer handler. More...
 
void ndpRouterAdvLinkChangeEvent (NdpRouterAdvContext *context)
 Callback function for link change event. More...
 
void ndpProcessRouterSol (NetInterface *interface, Ipv6PseudoHeader *pseudoHeader, const NetBuffer *buffer, size_t offset, uint8_t hopLimit)
 Router Solicitation message processing. More...
 
error_t ndpSendRouterAdv (NdpRouterAdvContext *context, uint16_t routerLifetime)
 Send a Router Advertisement message. More...
 

Variables

systime_t ndpRouterAdvTickCounter
 

Detailed Description

Helper functions for router advertisement service.

License

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

Copyright (C) 2010-2022 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.2.0

Definition in file ndp_router_adv_misc.h.

Function Documentation

◆ ndpProcessRouterSol()

void ndpProcessRouterSol ( NetInterface interface,
Ipv6PseudoHeader pseudoHeader,
const NetBuffer buffer,
size_t  offset,
uint8_t  hopLimit 
)

Router Solicitation message processing.

Parameters
[in]interfaceUnderlying network interface
[in]pseudoHeaderIPv6 pseudo header
[in]bufferMulti-part buffer containing the Router Advertisement message
[in]offsetOffset to the first byte of the message
[in]hopLimitHop Limit field from IPv6 header

Definition at line 166 of file ndp_router_adv_misc.c.

◆ ndpRouterAdvLinkChangeEvent()

void ndpRouterAdvLinkChangeEvent ( NdpRouterAdvContext context)

Callback function for link change event.

Parameters
[in]contextPointer to the RA service context

Definition at line 121 of file ndp_router_adv_misc.c.

◆ ndpRouterAdvTick()

void ndpRouterAdvTick ( NdpRouterAdvContext context)

RA service timer handler.

Parameters
[in]contextPointer to the RA service context

Definition at line 59 of file ndp_router_adv_misc.c.

◆ ndpSendRouterAdv()

error_t ndpSendRouterAdv ( NdpRouterAdvContext context,
uint16_t  routerLifetime 
)

Send a Router Advertisement message.

Parameters
[in]contextPointer to the RA service context
[in]routerLifetimeRouter Lifetime field
Returns
Error code

Definition at line 349 of file ndp_router_adv_misc.c.

Variable Documentation

◆ ndpRouterAdvTickCounter

systime_t ndpRouterAdvTickCounter
extern

Definition at line 51 of file ndp_router_adv_misc.c.