EI_API_ADP_setPortLogAnnounceInterval()

uint32_t EI_API_ADP_setPortLogAnnounceInterval	(	T *	pAdp_p,
		uint16_t	portLogAnnounceInterval_p
	)

Set the PortLogAnnounceInterval of the Time Sync object of the adapter (Instance Attribute ID: 14).

Function that sets the member in the PortLogAnnounceIntervalCfg attribute of the adapter selected by parameter pAdp_p. PortLogAnnounceInterval specifies the PTP announce interval between successive Announce messages issued by a master clock on each PTP port of the device. The units of the PortLogAnnounceInterval member are log base 2 seconds. The data type of the PortLogAnnounceInterval is uint16_t. The permitted value range is between 0 and 4.

Parameters

[in]	pAdp_p	Pointer to the adapter.
[in]	portLogAnnounceInterval_p	uint16_t Value of PTP Announce frame interval.

Returns

EI_API_ADP_EError_t as uint32_t value.

Return values

EI_API_ADP_eERR_OK	Success.
EI_API_ADP_eERR_GENERAL	General error.

Example

#include <api/EI_API.h>
 
 
EI_API_ADP_T* pEI_API_ADP = NULL;
uint32_t errCode;
 
uint8_t numInterfaces = 1;
 
pEI_API_ADP = EI_API_ADP_new(numInterfaces);
 
// Set portLogAnnounceInterval in Time Sync object
uint16_t portLogAnnounceInterval = 1;
errCode = EI_API_ADP_setPortLogAnnounceInterval(pEI_API_ADP, portLogAnnounceInterval);

See also

EI_API_ADP_getPortLogAnnounceInterval EI_API_ADP_EError_t