libptpmgmt  1.4
libptpmgmt library that provides the functionality of linuxptp pmc
Public Attributes | List of all members
ptpmgmt_init_t Struct Reference

#include <init.h>

Collaboration diagram for ptpmgmt_init_t:
Collaboration graph
[legend]

Public Attributes

void(* free )(ptpmgmt_init i)
 
void(* close )(ptpmgmt_init i)
 
int(* process )(ptpmgmt_init i, const_ptpmgmt_opt opt)
 
ptpmgmt_cfg(* cfg )(ptpmgmt_init i)
 
ptpmgmt_safile(* sa )(ptpmgmt_init i)
 
ptpmgmt_msg(* msg )(ptpmgmt_init i)
 
ptpmgmt_sk(* sk )(ptpmgmt_init i)
 
char(* getNetSelect )(const_ptpmgmt_init i)
 
bool(* use_uds )(ptpmgmt_init i)
 
uint8_t(* allow_unauth )(const_ptpmgmt_init i)
 

Detailed Description

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

Member Data Documentation

◆ allow_unauth

uint8_t(* ptpmgmt_init_t::allow_unauth) (const_ptpmgmt_init i)

Allow unauthnticated parameter

Parameters
[in]iinit object
Returns
Allow unauthnticated value

◆ cfg

ptpmgmt_cfg(* ptpmgmt_init_t::cfg) (ptpmgmt_init i)

Get configuration file object

Parameters
[in,out]iinit object
Returns
configuration object

◆ close

void(* ptpmgmt_init_t::close) (ptpmgmt_init i)

close the socket in the init object

Parameters
[in,out]iinit object

◆ free

void(* ptpmgmt_init_t::free) (ptpmgmt_init i)

< Free init object

Parameters
[in,out]iinit object

◆ getNetSelect

char(* ptpmgmt_init_t::getNetSelect) (const_ptpmgmt_init i)

Get network selection character

Parameters
[in]iinit object
Returns
'u' for unix socket using a SockUnix object, '4' for a PTP IPv4 socket using a SockIp4 object, '6' for a PTP IPv6 socket using a SockIp6 object, '2' for a PTP layer 2 socket using a SockRaw object, 0 on error.

◆ msg

ptpmgmt_msg(* ptpmgmt_init_t::msg) (ptpmgmt_init i)

Get Message object

Parameters
[in,out]iinit object
Returns
object

◆ process

int(* ptpmgmt_init_t::process) (ptpmgmt_init i, const_ptpmgmt_opt opt)

Process PMC options

Parameters
[in,out]iinit object
[in]optPMC options
Returns
0 on scuccess
Note
function return proper value to return from main()

◆ sa

ptpmgmt_safile(* ptpmgmt_init_t::sa) (ptpmgmt_init i)

Get authentication security association file object

Parameters
[in,out]iinit object
Returns
object

◆ sk

ptpmgmt_sk(* ptpmgmt_init_t::sk) (ptpmgmt_init i)

Get Socket object

Parameters
[in,out]iinit object
Returns
object or null if not exist
Note
User should not try to free this socket object

◆ use_uds

bool(* ptpmgmt_init_t::use_uds) (ptpmgmt_init i)

Is the socket provide by this object, a Unix socket?

Parameters
[in,out]iinit object
Returns
true if the socket is a UDS socket

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