Writes data to a session as an array of Ethernet frames. The session must use an Ethernet interface and a mode of Frame Output Stream.


icon

Inputs/Outputs

  • cgenclassrntag.png session in —

    session in is the session to write. This session is selected from the LabVIEW project or returned from the XNET Create Session VI. The session mode must be Frame Output Stream.

  • c1dcclst.png data —

    data provides an array of LabVIEW clusters.

    Each array element corresponds to a frame value to transmit. The elements of each cluster are specific to the Ethernet protocol.

    The data you write is queued up for transmit on the network. Using the default queue configuration for this mode, you can safely write 64 frames if you have a sufficiently long timeout. To write more data, refer to the XNET Session Number of Values Unused property to determine the actual amount of queue space available for write.

  • catrn.png local timestamp —

    local timestamp is a timestamp using XNET local time. The timestamp uses the LabVIEW absolute timestamp type.

  • catrn.png network timestamp —

    network timestamp is a timestamp using network time (clock of the network's time synchronization protocol, such as IEEE Std 802.1AS). The timestamp uses the LabVIEW absolute timestamp type.

  • c1du8.png frame data —

    data provides an array of LabVIEW clusters.

    Each array element corresponds to a frame value to transmit. The elements of each cluster are specific to the Ethernet protocol.

    The data you write is queued up for transmit on the network. Using the default queue configuration for this mode, you can safely write 64 frames if you have a sufficiently long timeout. To write more data, refer to the XNET Session Number of Values Unused property to determine the actual amount of queue space available for write.

  • cu32.png fcs —

    fcs is not used for XNET Write (Frame Ethernet). Refer to XNET Read (Frame Ethernet).

  • cu16.png type —

    type is the type of Ethernet frame. It is a ring (enumerated list) with the following values:

  • cbool.png network synced? —

    network synced? is not used for XNET Write (Frame Ethernet). Refer to XNET Read (Frame Ethernet).

  • cbool.png receive? —

    receive? is not used for XNET Write (Frame Ethernet). Refer to XNET Read (Frame Ethernet).

  • cbool.png transmit? —

    transmit? is not used for XNET Write (Frame Ethernet). Refer to XNET Read (Frame Ethernet).

  • cbool.png error? —

    error? is not used for XNET Write (Frame Ethernet). Refer to XNET Read (Frame Ethernet).

  • cdbl.png timeout (10) —

    timeout is the time to wait for the Ethernet frame data to be queued up for transmit.

    The timeout is a LabVIEW relative time, represented as 64-bit floating-point in units of seconds.

    If timeout is positive, the XNET Write (Frame Ethernet) VI waits up to that timeout for space to become available in queues. If the space is not available prior to the timeout, a timeout error is returned.

    If timeout is negative, the XNET Write (Frame Ethernet) VI waits indefinitely for space to become available in queues.

    If timeout is 0, the XNET Write (Frame Ethernet) VI does not wait and immediately returns with a timeout error if all data cannot be queued. Regardless of the timeout used, if a timeout error occurs, none of the data is queued, so you can attempt to call the XNET Write (Frame Ethernet) VI again at a later time with the same data.

    This input is optional. The default value is 10.0 (10 seconds).

  • 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

    The data represents an array of Ethernet frames. Each Ethernet frame uses a LabVIEW cluster with Ethernet-specific elements.

    Note When the Frame Output Stream session is in in Replay Exclusive or Replay Inclusive mode (see Interface:Output Stream Timing), hardware will evaluate the timestamp for each frame and output the frame at the right time, in accordance with the policy described in Handling Timestamps. The Interface:Ethernet:Output Stream Timescale property configures which timestamp parameter is used.