dhcpv6_relay.h File Reference

DHCPv6 relay agent (Dynamic Host Configuration Protocol for IPv6) More...

#include "dhcpv6/dhcpv6_common.h"
#include "core/socket.h"

Go to the source code of this file.

Data Structures
struct	Dhcpv6RelaySettings
	DHCPv6 relay agent settings. More...
struct	Dhcpv6RelayContext
	DHCPv6 relay agent context. More...

Macros
#define	DHCPV6_RELAY_SUPPORT   DISABLED
#define	DHCPV6_RELAY_STACK_SIZE   500
#define	DHCPV6_RELAY_PRIORITY   OS_TASK_PRIORITY_NORMAL
#define	DHCPV6_RELAY_MAX_CLIENT_INTERFACES   8
#define	DHCPV6_RELAY_FORWARDING_OVERHEAD

Functions
void	dhcpv6RelayGetDefaultSettings (Dhcpv6RelaySettings *settings)
	Initialize settings with default values. More...
error_t	dhcpv6RelayInit (Dhcpv6RelayContext *context, const Dhcpv6RelaySettings *settings)
	DHCPv6 relay agent initialization. More...
error_t	dhcpv6RelayStart (Dhcpv6RelayContext *context)
	Start DHCPv6 relay agent. More...
error_t	dhcpv6RelayStop (Dhcpv6RelayContext *context)
	Stop DHCPv6 relay agent. More...
void	dhcpv6RelayTask (Dhcpv6RelayContext *context)
	DHCPv6 relay agent task. More...
void	dhcpv6RelayDeinit (Dhcpv6RelayContext *context)
	Release DHCP relay agent context. More...

Detailed Description

DHCPv6 relay agent (Dynamic Host Configuration Protocol for IPv6)

License

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

Copyright (C) 2010-2026 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.6.0

Definition in file dhcpv6_relay.h.

Macro Definition Documentation

DHCPV6_RELAY_FORWARDING_OVERHEAD

#define DHCPV6_RELAY_FORWARDING_OVERHEAD

Value:

   (sizeof(Dhcpv6RelayMessage) + \
   2 * sizeof(Dhcpv6Option) + sizeof(uint32_t))

Definition at line 65 of file dhcpv6_relay.h.

DHCPV6_RELAY_MAX_CLIENT_INTERFACES

#define DHCPV6_RELAY_MAX_CLIENT_INTERFACES   8

Definition at line 59 of file dhcpv6_relay.h.

DHCPV6_RELAY_PRIORITY

#define DHCPV6_RELAY_PRIORITY   OS_TASK_PRIORITY_NORMAL

Definition at line 54 of file dhcpv6_relay.h.

DHCPV6_RELAY_STACK_SIZE

#define DHCPV6_RELAY_STACK_SIZE   500

Definition at line 47 of file dhcpv6_relay.h.

DHCPV6_RELAY_SUPPORT

#define DHCPV6_RELAY_SUPPORT   DISABLED

Definition at line 40 of file dhcpv6_relay.h.

Function Documentation

dhcpv6RelayDeinit()

void dhcpv6RelayDeinit

(

Dhcpv6RelayContext *

context

)

Release DHCP relay agent context.

Parameters

[in]

context

Pointer to the DHCP relay agent context

Definition at line 377 of file dhcpv6_relay.c.

dhcpv6RelayGetDefaultSettings()

void dhcpv6RelayGetDefaultSettings

(

Dhcpv6RelaySettings *

settings

)

Initialize settings with default values.

Parameters

[out]

settings

Structure that contains DHCPv6 relay agent settings

Definition at line 55 of file dhcpv6_relay.c.

dhcpv6RelayInit()

error_t dhcpv6RelayInit	(	Dhcpv6RelayContext *	context,
		const Dhcpv6RelaySettings *	settings
	)

DHCPv6 relay agent initialization.

Parameters

[in]	context	Pointer to the DHCPv6 client context
[in]	settings	DHCPv6 relay agent specific settings

Returns

Error code

Definition at line 90 of file dhcpv6_relay.c.

dhcpv6RelayStart()

error_t dhcpv6RelayStart

(

Dhcpv6RelayContext *

context

)

Start DHCPv6 relay agent.

Parameters

[in]

context

Pointer to the DHCPv6 relay agent context

Returns

Error code

Definition at line 175 of file dhcpv6_relay.c.

dhcpv6RelayStop()

error_t dhcpv6RelayStop

(

Dhcpv6RelayContext *

context

)

Stop DHCPv6 relay agent.

Parameters

[in]

context

Pointer to the DHCPv6 relay agent context

Returns

Error code

Definition at line 258 of file dhcpv6_relay.c.

dhcpv6RelayTask()

void dhcpv6RelayTask

(

Dhcpv6RelayContext *

context

)

DHCPv6 relay agent task.

Parameters

[in]

context

Pointer to the DHCPv6 relay agent context

Definition at line 307 of file dhcpv6_relay.c.