XNET Wait (Ethernet Synced).vi

XNET Wait (Ethernet Synced).vi

Purpose

Waits for the Ethernet interface to synchronize time on the network.

Format

Inputs

	session in is the session to apply the wait.
	timeout specifies the maximum amount of time in seconds to wait.
	error in is the error cluster input (refer to Error Handling).

Outputs

	session out is the same as session in, provided for use with subsequent VIs.
	error out is the error cluster output (refer to Error Handling).

Description

Waits for the clock of the Ethernet interface to successfully synchronize to other clocks in the network. This wait returns when the time synchronization protocol's Synced property becomes true.

Note  Time synchronization occurs independently from start of the interface. For example, you can read and write Ethernet frames when time synchronization protocol is not enabled, or when the time sync protocol is not synced.

The timeout parameter provides the maximum number of seconds to wait. The default value is 10 seconds.