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


icon

Inputs/Outputs

  • cgenclassrntag.png session in

    session in is the session to apply the wait.

  • cdbl.png timeout (10)

    timeout (sec) specifies the maximum amount of time in seconds to wait for the measurement or generation to complete. This VI returns an error if the time elapses. The default is 10. If you set timeout (sec) to -1, the VI waits indefinitely.

  • cerrcodeclst.png error in (no error)

    The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

  • igenclassrntag.png session out

    session out is the same as session in, provided for use with subsequent VIs.

  • ierrcodeclst.png error out

    The error out cluster passes error or warning information out of a VI to be used by other VIs. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

  • 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.