dhcp_common.c File Reference

Definitions common to DHCP client and server. More...

#include "core/net.h"
#include "dhcp/dhcp_client.h"
#include "dhcp/dhcp_server.h"
#include "dhcp/dhcp_common.h"
#include "debug.h"

Go to the source code of this file.

Macros

#define TRACE_LEVEL   DHCP_TRACE_LEVEL
 

Functions

error_t dhcpAddOption (DhcpMessage *message, size_t *messageLen, uint8_t optionCode, const void *optionValue, size_t optionLen)
 Append an option to a DHCP message. More...
 
DhcpOptiondhcpGetOption (const DhcpMessage *message, size_t length, uint8_t optionCode)
 Search a DHCP message for a given option. More...
 

Detailed Description

Definitions common to DHCP client and server.

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

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   DHCP_TRACE_LEVEL

Definition at line 32 of file dhcp_common.c.

Function Documentation

◆ dhcpAddOption()

error_t dhcpAddOption ( DhcpMessage message,
size_t *  messageLen,
uint8_t  optionCode,
const void *  optionValue,
size_t  optionLen 
)

Append an option to a DHCP message.

Parameters
[in]messagePointer to the DHCP message
[in,out]messageLenActual length of the DHCP message
[in]optionCodeOption code
[in]optionValueOption value
[in]optionLenLength of the option value
Returns
Error code

Definition at line 56 of file dhcp_common.c.

◆ dhcpGetOption()

DhcpOption* dhcpGetOption ( const DhcpMessage message,
size_t  length,
uint8_t  optionCode 
)

Search a DHCP message for a given option.

Parameters
[in]messagePointer to the DHCP message
[in]lengthLength of the message
[in]optionCodeCode of the option to find
Returns
If the specified option is found, a pointer to the corresponding option is returned. Otherwise NULL pointer is returned

Definition at line 118 of file dhcp_common.c.