C interface to configuration class. More...

#include "name.h"

Include dependency graph for cfg.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	ptpmgmt_cfg_t

struct	ptpmgmt_spp_t

struct	ptpmgmt_safile_t

Typedefs
typedef struct ptpmgmt_cfg_t *	ptpmgmt_cfg

typedef const struct ptpmgmt_cfg_t *	const_ptpmgmt_cfg

typedef struct ptpmgmt_spp_t *	ptpmgmt_spp

typedef const struct ptpmgmt_spp_t *	const_ptpmgmt_spp

typedef struct ptpmgmt_safile_t *	ptpmgmt_safile

typedef const struct ptpmgmt_safile_t *	const_ptpmgmt_safile

Enumerations
enum	PTPMGMT_HMAC_t { PTPMGMT_HMAC_SHA256 , PTPMGMT_HMAC_AES128 , PTPMGMT_HMAC_AES256 }
	Authentication key type. More...

Functions
ptpmgmt_cfg	ptpmgmt_cfg_alloc ()

ptpmgmt_spp	ptpmgmt_spp_alloc (uint8_t id)

ptpmgmt_spp	ptpmgmt_spp_alloc_cp (const_ptpmgmt_spp spp)

ptpmgmt_safile	ptpmgmt_safile_alloc ()

Detailed Description

C interface to configuration class.

Author: Erez Geva <ErezGeva2@gmail.com>

Copyright: © 2023 Erez Geva

Typedef Documentation

◆ const_ptpmgmt_cfg

typedef const struct ptpmgmt_cfg_t* const_ptpmgmt_cfg

pointer to constant ptpmgmt configuration structure

◆ const_ptpmgmt_safile

typedef const struct ptpmgmt_safile_t* const_ptpmgmt_safile

pointer to constant ptpmgmt SA file structure

◆ const_ptpmgmt_spp

typedef const struct ptpmgmt_spp_t* const_ptpmgmt_spp

pointer to constant ptpmgmt SPP structure

◆ ptpmgmt_cfg

typedef struct ptpmgmt_cfg_t* ptpmgmt_cfg

pointer to ptpmgmt configuration structure

◆ ptpmgmt_safile

typedef struct ptpmgmt_safile_t* ptpmgmt_safile

pointer to ptpmgmt SA file structure

◆ ptpmgmt_spp

typedef struct ptpmgmt_spp_t* ptpmgmt_spp

pointer to ptpmgmt SPP structure

Enumeration Type Documentation

◆ PTPMGMT_HMAC_t

enum PTPMGMT_HMAC_t

Authentication key type.

For Hashed Message Authentication Mode (HMAC) digests.

Enumerator
PTPMGMT_HMAC_SHA256	Using Secure Hash Algorithm 2 with 256 bits
PTPMGMT_HMAC_AES128	Using NIST Advanced Encryption Standard with 128 bits key
PTPMGMT_HMAC_AES256	Using NIST Advanced Encryption Standard with 256 bits key

Function Documentation

◆ ptpmgmt_cfg_alloc()

ptpmgmt_cfg ptpmgmt_cfg_alloc ( )

Allocate new configuration structure

Returns: new configuration structure or null on error

◆ ptpmgmt_safile_alloc()

ptpmgmt_safile ptpmgmt_safile_alloc ( )

Allocate new SA file structure

Returns: new SA file structure or null on error

◆ ptpmgmt_spp_alloc()

ptpmgmt_spp ptpmgmt_spp_alloc ( uint8_t id )

Allocate new spp structure

Returns: new spp structure or null on error

◆ ptpmgmt_spp_alloc_cp()

ptpmgmt_spp ptpmgmt_spp_alloc_cp ( const_ptpmgmt_spp spp )

Copy spp structure to a new spp

Returns: new spp structure or null on error

Note: This function can be used to a const spp object

Classes

Typedefs

Enumerations

Functions