ptpmgmt_ifInfo_t Struct Reference

#include <ptp.h>

Public Attributes
void(*	free )(ptpmgmt_ifInfo i)
bool(*	initUsingName )(ptpmgmt_ifInfo i, const char *ifName)
bool(*	initUsingIndex )(ptpmgmt_ifInfo i, int ifIndex)
bool(*	isInit )(const_ptpmgmt_ifInfo i)
int(*	ifIndex )(const_ptpmgmt_ifInfo i)
const char *(*	ifName )(const_ptpmgmt_ifInfo i)
const uint8_t *(*	mac )(const_ptpmgmt_ifInfo i)
size_t(*	mac_size )(const_ptpmgmt_ifInfo i)
int(*	ptpIndex )(const_ptpmgmt_ifInfo i)

Detailed Description

the ptpmgmt network interface structure hold the network interface object and call backs to call c++ methods

Member Data Documentation

free

void(* ptpmgmt_ifInfo_t::free) (ptpmgmt_ifInfo i)

< Free this network interface object

Parameters

[in,out]

i

network interface object

ifIndex

int(* ptpmgmt_ifInfo_t::ifIndex) (const_ptpmgmt_ifInfo i)

Get interface index

Parameters

[in]

i

network interface object

Returns

interface index or NO_SUCH_IF if object is not initialized

ifName

const char *(* ptpmgmt_ifInfo_t::ifName) (const_ptpmgmt_ifInfo i)

Get interface name

Parameters

[in]

i

network interface object

Returns

interface name or empty string if object is not initialized

initUsingIndex

bool(* ptpmgmt_ifInfo_t::initUsingIndex) (ptpmgmt_ifInfo i, int ifIndex)

Find network interface information based on its index

Parameters

[in,out]	i	network interface object
[in]	ifIndex	network interface index

Returns

true if network interface exists

initUsingName

bool(* ptpmgmt_ifInfo_t::initUsingName) (ptpmgmt_ifInfo i, const char *ifName)

Find network interface information based on its name

Parameters

[in,out]	i	network interface object
[in]	ifName	network interface name

Returns

true if network interface exists

isInit

bool(* ptpmgmt_ifInfo_t::isInit) (const_ptpmgmt_ifInfo i)

Is object initialized

Parameters

[in]

i

network interface object

Returns

true if network interface was successfully initialized

mac

const uint8_t *(* ptpmgmt_ifInfo_t::mac) (const_ptpmgmt_ifInfo i)

Get interface MAC address

Parameters

[in]

i

network interface object

Returns

binary from address or empty string if object is not initialized

mac_size

size_t(* ptpmgmt_ifInfo_t::mac_size) (const_ptpmgmt_ifInfo i)

Get interface MAC address length

Parameters

[in]

i

network interface object

Returns

binary from address length or 0 if object is not initialized

ptpIndex

int(* ptpmgmt_ifInfo_t::ptpIndex) (const_ptpmgmt_ifInfo i)

Get interface PTP index

Parameters

[in]

i

network interface object

Returns

ptp index or -1 if object is not initialized or interface does not support PTP

Note

An interface may have multiple PHCs, this function return the index report by the get_ts_info

---

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

• pub/c/ptp.h