#include <cfg.h>
Collaboration diagram for ptpmgmt_safile_t:
Public Attributes | |
| void(* | free )(ptpmgmt_safile sf) |
| bool(* | read_sa )(ptpmgmt_safile sf, const char *file) |
| bool(* | read_sa_cfg )(ptpmgmt_safile sf, const_ptpmgmt_cfg cfg, const char *section) |
| bool(* | have )(const_ptpmgmt_safile sf, uint8_t spp) |
| bool(* | have_key )(const_ptpmgmt_safile sf, uint8_t spp, uint32_t key) |
| const_ptpmgmt_spp(* | spp )(ptpmgmt_safile sf, uint8_t spp) |
Detailed Description
The ptpmgmt SA file structure hold an authentication security association file object and call backs to call C++ methods
Member Data Documentation
◆ free
| void(* ptpmgmt_safile_t::free) (ptpmgmt_safile sf) |
< Free an an authentication security association file object
- Parameters
-
[in,out] sf authentication security association file object
◆ have
| bool(* ptpmgmt_safile_t::have) (const_ptpmgmt_safile sf, uint8_t spp) |
Verify SPP is in the SA_file and have at least one key
- Parameters
-
[in] sf authentication security association file object [in] spp ID
- Returns
- true if SPP exist with at least one key
◆ have_key
| bool(* ptpmgmt_safile_t::have_key) (const_ptpmgmt_safile sf, uint8_t spp, uint32_t key) |
Verify key exist in an SPP
- Parameters
-
[in] sf authentication security association file object [in] spp ID [in] key ID
- Returns
- true if key exist
◆ read_sa
| bool(* ptpmgmt_safile_t::read_sa) (ptpmgmt_safile sf, const char *file) |
Read a SA file and parse it
- Parameters
-
[in,out] sf authentication security association file object [in] file name with path
- Returns
- true if parse success
◆ read_sa_cfg
| bool(* ptpmgmt_safile_t::read_sa_cfg) (ptpmgmt_safile sf, const_ptpmgmt_cfg cfg, const char *section) |
Read a SA file and parse it. Get file name from the configuration file.
- Parameters
-
[in,out] sf authentication security association file object [in] cfg reference to configuration file object [in] section (optional)
- Returns
- true if parse success, false if fail or file does not exist or configuration file have an empty sa_file.
◆ spp
| const_ptpmgmt_spp(* ptpmgmt_safile_t::spp) (ptpmgmt_safile sf, uint8_t spp) |
Get SPP by spp ID
- Parameters
-
[in,out] sf authentication security association file object [in] spp ID
- Returns
- SPP if exist or empty SPP
The documentation for this struct was generated from the following file:
- pub/c/cfg.h
