Sergey Pastor / 1

Webserver+3d print

Dependents:   Nucleo

Embed: (wiki syntax)

« Back to documentation index

dhcp_common.h File Reference
Enumerations | Functions

dhcp_common.h File Reference

Functions common to DHCP client, server and BOOTP relay agent. More...

Go to the source code of this file.

Enumerations

enum  DhcpOpcode
 

DHCP opcodes.

More...
enum  DhcpFlags
 

DHCP flags.

More...
enum  DhcpMessageType
 

DHCP message types.

More...
enum  DhcpOptionCode
 

DHCP option codes.

More...

Functions

void dhcpAddOption (DhcpMessage *message, uint8_t optionCode, const void *optionValue, size_t optionLength)
 Append an option to a DHCP message.
DhcpOption * dhcpGetOption (const DhcpMessage *message, size_t length, uint8_t optionCode)
 Find the specified option in a DHCP message.

Detailed Description

Functions common to DHCP client, server and BOOTP relay agent.

License

Copyright (C) 2010-2017 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:
1.7.6

Definition in file dhcp_common.h.

Enumeration Type Documentation

enum DhcpFlags

DHCP flags.

Definition at line 69 of file dhcp_common.h.

enum DhcpMessageType

DHCP message types.

Definition at line 80 of file dhcp_common.h.

enum DhcpOpcode

DHCP opcodes.

Definition at line 58 of file dhcp_common.h.

enum DhcpOptionCode

DHCP option codes.

Definition at line 97 of file dhcp_common.h.

Function Documentation

void dhcpAddOption ( DhcpMessage *  message,
uint8_t  optionCode,
const void *  optionValue,
size_t  optionLength 
)

Append an option to a DHCP message.

Parameters:
[in]messagePointer to the DHCP message
[in]optionCodeOption code
[in]optionValueOption value
[in]optionLengthLength of the option value

Definition at line 57 of file dhcp_common.c.

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

Find the specified option in a DHCP message.

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 114 of file dhcp_common.c.

Generated on Tue Jul 12 2022 17:10:19 by  doxygen 1.7.2