XNET Wait (Transmit Complete).vi

XNET Wait (Transmit Complete).vi

Purpose

Waits for previously written data to be transmitted on the cluster.

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

In queued sessions, this function waits for all data provided to the XNET Write VI before this XNET Wait VI call is transmitted on the CAN, FlexRay, LIN, or Ethernet network. This wait applies only to the current XNET session and not to other sessions used for the same interface.

After using the XNET Write VI to provide data for this session, you can use this VI to wait for that data to transmit to remote ECUs. You can use this VI to guarantee that all frames have been transmitted before stopping this session. Depending on the bus or the configuration properties such as Interface:CAN:Single Shot Transmit?, the data may or may not have been successfully transmitted; however, if this wait returns successfully, it indicates that the session is making no more attempts to transmit the data again.

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

This VI works with the queued session but not with the single-point sessions. Queued sessions are used to guarantee that no frames are lost during transmission. Single-point sessions transmit only the most recent value for an event, typically using cyclic timing.