dhcpv6_debug.h File Reference

Data logging functions for debugging purpose (DHCPv6) More...

#include "core/net.h"
#include "dhcpv6/dhcpv6_common.h"
#include "debug.h"

Go to the source code of this file.

Functions

error_t dhcpv6DumpMessage (const void *message, size_t length)
 Dump DHCPv6 message for debugging purpose. More...
 
error_t dhcpv6DumpOptions (const uint8_t *options, size_t length, uint_t level)
 Dump DHCPv6 options for debugging purpose. More...
 
error_t dhcpv6DumpGenericOption (const Dhcpv6Option *option, uint_t level)
 Dump generic DHCPv6 option. More...
 
error_t dhcpv6DumpClientIdOption (const Dhcpv6Option *option, uint_t level)
 Dump Client Identifier option. More...
 
error_t dhcpv6DumpServerIdOption (const Dhcpv6Option *option, uint_t level)
 Dump Server Identifier option. More...
 
error_t dhcpv6DumpIaNaOption (const Dhcpv6Option *option, uint_t level)
 Dump IA_NA option. More...
 
error_t dhcpv6DumpIaTaOption (const Dhcpv6Option *option, uint_t level)
 Dump IA_TA option. More...
 
error_t dhcpv6DumpIaAddrOption (const Dhcpv6Option *option, uint_t level)
 Dump IA Address option. More...
 
error_t dhcpv6DumpOroOption (const Dhcpv6Option *option, uint_t level)
 Dump Option Request option. More...
 
error_t dhcpv6DumpPreferenceOption (const Dhcpv6Option *option, uint_t level)
 Dump Preference option. More...
 
error_t dhcpv6DumpElapsedTimeOption (const Dhcpv6Option *option, uint_t level)
 Dump Elapsed Time option. More...
 
error_t dhcpv6DumpRelayMessageOption (const Dhcpv6Option *option, uint_t level)
 Dump Relay Message option. More...
 
error_t dhcpv6DumpAuthOption (const Dhcpv6Option *option, uint_t level)
 Dump Authentication option. More...
 
error_t dhcpv6DumpServerUnicastOption (const Dhcpv6Option *option, uint_t level)
 Dump Server Unicast option. More...
 
error_t dhcpv6DumpStatusCodeOption (const Dhcpv6Option *option, uint_t level)
 Dump Status Code option. More...
 
error_t dhcpv6DumpRapidCommitOption (const Dhcpv6Option *option, uint_t level)
 Dump Rapid Commit option. More...
 
error_t dhcpv6DumpUserClassOption (const Dhcpv6Option *option, uint_t level)
 Dump User Class option. More...
 
error_t dhcpv6DumpVendorClassOption (const Dhcpv6Option *option, uint_t level)
 Dump Vendor Class option. More...
 
error_t dhcpv6DumpVendorSpecificInfoOption (const Dhcpv6Option *option, uint_t level)
 Dump Vendor Specific Information option. More...
 
error_t dhcpv6DumpInterfaceIdOption (const Dhcpv6Option *option, uint_t level)
 Dump Interface ID option. More...
 
error_t dhcpv6DumpReconfMessageOption (const Dhcpv6Option *option, uint_t level)
 Dump Reconfigure Message option. More...
 
error_t dhcpv6DumpReconfAcceptOption (const Dhcpv6Option *option, uint_t level)
 Dump Reconfigure Accept option. More...
 
error_t dhcpv6DumpDnsServersOption (const Dhcpv6Option *option, uint_t level)
 Dump DNS Recursive Name Server option. More...
 
error_t dhcpv6DumpDomainListOption (const Dhcpv6Option *option, uint_t level)
 Dump Domain Search List option. More...
 

Detailed Description

Data logging functions for debugging purpose (DHCPv6)

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

Function Documentation

◆ dhcpv6DumpAuthOption()

error_t dhcpv6DumpAuthOption ( const Dhcpv6Option option,
uint_t  level 
)

Dump Authentication option.

Parameters
[in]optionPointer to the option to dump
[in]levelCurrent level of recursion
Returns
Error code

Definition at line 661 of file dhcpv6_debug.c.

◆ dhcpv6DumpClientIdOption()

error_t dhcpv6DumpClientIdOption ( const Dhcpv6Option option,
uint_t  level 
)

Dump Client Identifier option.

Parameters
[in]optionPointer to the option to dump
[in]levelCurrent level of recursion
Returns
Error code

Definition at line 369 of file dhcpv6_debug.c.

◆ dhcpv6DumpDnsServersOption()

error_t dhcpv6DumpDnsServersOption ( const Dhcpv6Option option,
uint_t  level 
)

Dump DNS Recursive Name Server option.

Parameters
[in]optionPointer to the option to dump
[in]levelCurrent level of recursion
Returns
Error code

Definition at line 899 of file dhcpv6_debug.c.

◆ dhcpv6DumpDomainListOption()

error_t dhcpv6DumpDomainListOption ( const Dhcpv6Option option,
uint_t  level 
)

Dump Domain Search List option.

Parameters
[in]optionPointer to the option to dump
[in]levelCurrent level of recursion
Returns
Error code

Definition at line 936 of file dhcpv6_debug.c.

◆ dhcpv6DumpElapsedTimeOption()

error_t dhcpv6DumpElapsedTimeOption ( const Dhcpv6Option option,
uint_t  level 
)

Dump Elapsed Time option.

Parameters
[in]optionPointer to the option to dump
[in]levelCurrent level of recursion
Returns
Error code

Definition at line 569 of file dhcpv6_debug.c.

◆ dhcpv6DumpGenericOption()

error_t dhcpv6DumpGenericOption ( const Dhcpv6Option option,
uint_t  level 
)

Dump generic DHCPv6 option.

Parameters
[in]optionPointer to the option to dump
[in]levelCurrent level of recursion
Returns
Error code

Definition at line 351 of file dhcpv6_debug.c.

◆ dhcpv6DumpIaAddrOption()

error_t dhcpv6DumpIaAddrOption ( const Dhcpv6Option option,
uint_t  level 
)

Dump IA Address option.

Parameters
[in]optionPointer to the option to dump
[in]levelCurrent level of recursion
Returns
Error code

Definition at line 467 of file dhcpv6_debug.c.

◆ dhcpv6DumpIaNaOption()

error_t dhcpv6DumpIaNaOption ( const Dhcpv6Option option,
uint_t  level 
)

Dump IA_NA option.

Parameters
[in]optionPointer to the option to dump
[in]levelCurrent level of recursion
Returns
Error code

Definition at line 405 of file dhcpv6_debug.c.

◆ dhcpv6DumpIaTaOption()

error_t dhcpv6DumpIaTaOption ( const Dhcpv6Option option,
uint_t  level 
)

Dump IA_TA option.

Parameters
[in]optionPointer to the option to dump
[in]levelCurrent level of recursion
Returns
Error code

Definition at line 437 of file dhcpv6_debug.c.

◆ dhcpv6DumpInterfaceIdOption()

error_t dhcpv6DumpInterfaceIdOption ( const Dhcpv6Option option,
uint_t  level 
)

Dump Interface ID option.

Parameters
[in]optionPointer to the option to dump
[in]levelCurrent level of recursion
Returns
Error code

Definition at line 833 of file dhcpv6_debug.c.

◆ dhcpv6DumpMessage()

error_t dhcpv6DumpMessage ( const void *  message,
size_t  length 
)

Dump DHCPv6 message for debugging purpose.

Parameters
[in]messagePointer to the DHCPv6 message to dump
[in]lengthLength of the message
Returns
Error code

Definition at line 123 of file dhcpv6_debug.c.

◆ dhcpv6DumpOptions()

error_t dhcpv6DumpOptions ( const uint8_t *  options,
size_t  length,
uint_t  level 
)

Dump DHCPv6 options for debugging purpose.

Parameters
[in]optionsPointer to the DHCPv6 options to dump
[in]lengthLength of the options
[in]levelCurrent level of recursion
Returns
Error code

Definition at line 208 of file dhcpv6_debug.c.

◆ dhcpv6DumpOroOption()

error_t dhcpv6DumpOroOption ( const Dhcpv6Option option,
uint_t  level 
)

Dump Option Request option.

Parameters
[in]optionPointer to the option to dump
[in]levelCurrent level of recursion
Returns
Error code

Definition at line 499 of file dhcpv6_debug.c.

◆ dhcpv6DumpPreferenceOption()

error_t dhcpv6DumpPreferenceOption ( const Dhcpv6Option option,
uint_t  level 
)

Dump Preference option.

Parameters
[in]optionPointer to the option to dump
[in]levelCurrent level of recursion
Returns
Error code

Definition at line 542 of file dhcpv6_debug.c.

◆ dhcpv6DumpRapidCommitOption()

error_t dhcpv6DumpRapidCommitOption ( const Dhcpv6Option option,
uint_t  level 
)

Dump Rapid Commit option.

Parameters
[in]optionPointer to the option to dump
[in]levelCurrent level of recursion
Returns
Error code

Definition at line 758 of file dhcpv6_debug.c.

◆ dhcpv6DumpReconfAcceptOption()

error_t dhcpv6DumpReconfAcceptOption ( const Dhcpv6Option option,
uint_t  level 
)

Dump Reconfigure Accept option.

Parameters
[in]optionPointer to the option to dump
[in]levelCurrent level of recursion
Returns
Error code

Definition at line 878 of file dhcpv6_debug.c.

◆ dhcpv6DumpReconfMessageOption()

error_t dhcpv6DumpReconfMessageOption ( const Dhcpv6Option option,
uint_t  level 
)

Dump Reconfigure Message option.

Parameters
[in]optionPointer to the option to dump
[in]levelCurrent level of recursion
Returns
Error code

Definition at line 851 of file dhcpv6_debug.c.

◆ dhcpv6DumpRelayMessageOption()

error_t dhcpv6DumpRelayMessageOption ( const Dhcpv6Option option,
uint_t  level 
)

Dump Relay Message option.

Parameters
[in]optionPointer to the option to dump
[in]levelCurrent level of recursion
Returns
Error code

Definition at line 599 of file dhcpv6_debug.c.

◆ dhcpv6DumpServerIdOption()

error_t dhcpv6DumpServerIdOption ( const Dhcpv6Option option,
uint_t  level 
)

Dump Server Identifier option.

Parameters
[in]optionPointer to the option to dump
[in]levelCurrent level of recursion
Returns
Error code

Definition at line 387 of file dhcpv6_debug.c.

◆ dhcpv6DumpServerUnicastOption()

error_t dhcpv6DumpServerUnicastOption ( const Dhcpv6Option option,
uint_t  level 
)

Dump Server Unicast option.

Parameters
[in]optionPointer to the option to dump
[in]levelCurrent level of recursion
Returns
Error code

Definition at line 697 of file dhcpv6_debug.c.

◆ dhcpv6DumpStatusCodeOption()

error_t dhcpv6DumpStatusCodeOption ( const Dhcpv6Option option,
uint_t  level 
)

Dump Status Code option.

Parameters
[in]optionPointer to the option to dump
[in]levelCurrent level of recursion
Returns
Error code

Definition at line 724 of file dhcpv6_debug.c.

◆ dhcpv6DumpUserClassOption()

error_t dhcpv6DumpUserClassOption ( const Dhcpv6Option option,
uint_t  level 
)

Dump User Class option.

Parameters
[in]optionPointer to the option to dump
[in]levelCurrent level of recursion
Returns
Error code

Definition at line 779 of file dhcpv6_debug.c.

◆ dhcpv6DumpVendorClassOption()

error_t dhcpv6DumpVendorClassOption ( const Dhcpv6Option option,
uint_t  level 
)

Dump Vendor Class option.

Parameters
[in]optionPointer to the option to dump
[in]levelCurrent level of recursion
Returns
Error code

Definition at line 797 of file dhcpv6_debug.c.

◆ dhcpv6DumpVendorSpecificInfoOption()

error_t dhcpv6DumpVendorSpecificInfoOption ( const Dhcpv6Option option,
uint_t  level 
)

Dump Vendor Specific Information option.

Parameters
[in]optionPointer to the option to dump
[in]levelCurrent level of recursion
Returns
Error code

Definition at line 815 of file dhcpv6_debug.c.