HS-Esslingen/esp-firewall
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Write doxygen comments for Utils

Browse source
This commit is contained in:
Florian Hoss 2022-07-30 11:14:45 +02:00
parent e9d51f14f5
commit c9c269f8eb
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
src/Utils.hpp
View file

@ -33,6 +33,11 @@ namespace fw
} auth_t;
static const uint8_t IPV4ADDRESS_LENGTH = 16;
/**
* @brief the typedef to describe a Firewall rule
*
*/
typedef struct firewall_rules
{
uint8_t key;
@ -44,6 +49,10 @@ namespace fw
struct firewall_rules *next;
} firewall_rule_t;
/**
* @brief the typedef to describe a network packet
*
*/
typedef struct my_packet
{
char ip[IPV4ADDRESS_LENGTH];
@ -64,12 +73,21 @@ namespace fw
} firewall_fields_t;
static const uint8_t CREDENTIALS_LENGTH = 32;
/**
* @brief the typedef to describe credentials of the API
*
*/
typedef struct credentials
{
char password[CREDENTIALS_LENGTH];
char username[CREDENTIALS_LENGTH];
} credential_t;
/**
* @brief the typedef to describe an API endpoint
*
*/
typedef struct api_endpoints
{
char uri[60];