RtNalSetTransmitTimeStampType

RtNalSetTransmitTimeStampType enables the timestamp for the last transmit packet.

Syntax

BOOL RtNalSetTransmitTimeStamp(
	RTNAL_QUEUE_HANDLE queueHandle,
	RTNAL_PTP_MESSAGE_TYPE timeStampType
);

Parameters

queueHandle

The receive queue handle returned by RtNalAcquireQueue.

timeStampType

An RTNAL_PTP_MESSAGE_TYPE value indicating the type of PTP message to time-stamp.

Return Value

Returns TRUE if the function succeeds. Otherwise it returns FALSE. Call GetLastError to obtain an error code. The possible error codes are listed below:

Error Code	Meaning
ERROR_DEVICE_FEATURE_NOT_SUPPORTED	The NIC driver does not support transmit timestamps.
ERROR_INVALID_HANDLE	The argument queueHandle is invalid.
ERROR_INVALID_PARAMETER	queueHandle is a NULL pointer or timeStampType contains an invalid value.
ERROR_NOT_READY	RtNalInit has not completed successfully.

Remarks

For a list of supported functions for specific drivers, see Matrix of Supported Real-Time NAL Functions by NIC Driver.

When timestamping is enabled, the NIC captures the packet's transmission time in the timestamp registers. The stored values can be read by calling RtNalGetTransmitTimeStamp.

The RtNalE1000 and RtNalIPCH drivers do not support transmit timestamps.

Requirements

Minimum Supported Version	RTX64 4.0
Header	rtnapi.h, RtNalApi.h
Library	RtNal.lib