ptpmgmt_cfg_t Struct Reference

#include <cfg.h>

Public Attributes
void(*	free )(ptpmgmt_cfg cfg)
bool(*	read_cfg )(ptpmgmt_cfg cfg, const char *file)
uint8_t(*	transportSpecific )(const_ptpmgmt_cfg cfg, const char *section)
uint8_t(*	domainNumber )(const_ptpmgmt_cfg cfg, const char *section)
uint8_t(*	udp6_scope )(const_ptpmgmt_cfg cfg, const char *section)
uint8_t(*	udp_ttl )(const_ptpmgmt_cfg cfg, const char *section)
uint8_t(*	socket_priority )(const_ptpmgmt_cfg cfg, const char *section)
uint8_t(*	network_transport )(const_ptpmgmt_cfg cfg, const char *section)
uint16_t(*	active_key_id )(const_ptpmgmt_cfg cfg, const char *section)
uint8_t(*	spp )(const_ptpmgmt_cfg cfg, const char *section)
uint8_t(*	allow_unauth )(const_ptpmgmt_cfg cfg, const char *section)
bool(*	haveSpp )(const_ptpmgmt_cfg cfg, const char *section)
const char *(*	uds_address )(const_ptpmgmt_cfg cfg, const char *section)
const char *(*	sa_file )(const_ptpmgmt_cfg cfg, const char *section)
const void *(*	ptp_dst_mac )(const_ptpmgmt_cfg cfg, size_t *len, const char *section)
const void *(*	p2p_dst_mac )(const_ptpmgmt_cfg cfg, size_t *len, const char *section)

Detailed Description

The ptpmgmt configuration structure hold the configuration object and call backs to call C++ methods

Member Data Documentation

active_key_id

uint16_t(* ptpmgmt_cfg_t::active_key_id) (const_ptpmgmt_cfg cfg, const char *section)

Get the authentication key ID value

Parameters

[in]	cfg	configuration object
[in]	section	(optional)

Returns

value

Note

calling without section will fetch value from "global" section

allow_unauth

uint8_t(* ptpmgmt_cfg_t::allow_unauth) (const_ptpmgmt_cfg cfg, const char *section)

Get accept unauthenticated response messages value

Parameters

[in]	cfg	configuration object
[in]	section	(optional)

Returns

the allow unauthenticated messages value

Note

calling without section will fetch value from "global" section

domainNumber

uint8_t(* ptpmgmt_cfg_t::domainNumber) (const_ptpmgmt_cfg cfg, const char *section)

Get the domainNumber value

Parameters

[in]	cfg	configuration object
[in]	section	(optional)

Returns

value

Note

calling with null section will fetch value from "global" section

free

void(* ptpmgmt_cfg_t::free) (ptpmgmt_cfg cfg)

< Free this configuration object

Parameters

[in,out]

cfg

configuration object to free

haveSpp

bool(* ptpmgmt_cfg_t::haveSpp) (const_ptpmgmt_cfg cfg, const char *section)

Query whether the authentication security parameter pointer is set

Parameters

[in]	cfg	configuration object
[in]	section	(optional)

Returns

true if value is set

Note

calling without section will Query the "global" section

network_transport

uint8_t(* ptpmgmt_cfg_t::network_transport) (const_ptpmgmt_cfg cfg, const char *section)

Get the network_transport value

Parameters

[in]	cfg	configuration object
[in]	section	(optional)

Returns

value

Note

calling with null section will fetch value from "global" section

p2p_dst_mac

const void *(* ptpmgmt_cfg_t::p2p_dst_mac) (const_ptpmgmt_cfg cfg, size_t *len, const char *section)

Get the p2p_dst_mac value

Parameters

[in]	cfg	configuration object
[out]	len	Mac address length
[in]	section	(optional)

Returns

pointer to binary mac address or null

Note

calling with null section will fetch value from "global" section

ptp_dst_mac

const void *(* ptpmgmt_cfg_t::ptp_dst_mac) (const_ptpmgmt_cfg cfg, size_t *len, const char *section)

Get the ptp_dst_mac value

Parameters

[in]	cfg	configuration object
[out]	len	Mac address length
[in]	section	(optional)

Returns

pointer to binary mac address or null

Note

calling with null section will fetch value from "global" section

read_cfg

bool(* ptpmgmt_cfg_t::read_cfg) (ptpmgmt_cfg cfg, const char *file)

Read a configuration file and parse it

Parameters

[in,out]	cfg	configuration object
[in]	file	name with path

Returns

true if parse success

sa_file

const char *(* ptpmgmt_cfg_t::sa_file) (const_ptpmgmt_cfg cfg, const char *section)

Get the authentication security association file value

Parameters

[in]	cfg	configuration object
[in]	section	(optional)

Returns

null terminated string witg UDS address

Note

calling with null section will fetch value from "global" section

socket_priority

uint8_t(* ptpmgmt_cfg_t::socket_priority) (const_ptpmgmt_cfg cfg, const char *section)

Get the socket_priority value

Parameters

[in]	cfg	configuration object
[in]	section	(optional)

Returns

value

Note

calling with null section will fetch value from "global" section

spp

uint8_t(* ptpmgmt_cfg_t::spp) (const_ptpmgmt_cfg cfg, const char *section)

Get the authentication security parameter pointer value

Parameters

[in]	cfg	configuration object
[in]	section	(optional)

Returns

value

Note

calling without section will fetch value from "global" section

transportSpecific

uint8_t(* ptpmgmt_cfg_t::transportSpecific) (const_ptpmgmt_cfg cfg, const char *section)

Get the transportSpecific value

Parameters

[in]	cfg	configuration object
[in]	section	(optional)

Returns

value

Note

calling with null section will fetch value from "global" section

udp6_scope

uint8_t(* ptpmgmt_cfg_t::udp6_scope) (const_ptpmgmt_cfg cfg, const char *section)

Get the udp6_scope value

Parameters

[in]	cfg	configuration object
[in]	section	(optional)

Returns

value

Note

calling with null section will fetch value from "global" section

udp_ttl

uint8_t(* ptpmgmt_cfg_t::udp_ttl) (const_ptpmgmt_cfg cfg, const char *section)

Get the udp_ttl value

Parameters

[in]	cfg	configuration object
[in]	section	(optional)

Returns

value

Note

calling with null section will fetch value from "global" section

uds_address

const char *(* ptpmgmt_cfg_t::uds_address) (const_ptpmgmt_cfg cfg, const char *section)

Get the uds_address value

Parameters

[in]	cfg	configuration object
[in]	section	(optional)

Returns

null terminated string witg UDS address

Note

calling with null section will fetch value from "global" section

---

The documentation for this struct was generated from the following file:

• pub/c/cfg.h