Table Of Contents

Network Streams Properties (G Dataflow)

Version:
    Last Modified: March 15, 2017

    Reads and/or writes properties of a network stream reference.

    The Network Streams Properties Node is preconfigured to access network stream endpoint properties. The node operates in the same way as a standard property node.

    connector_pane_image
    datatype_icon

    network stream endpoint in

    The network stream you want to read or write properties to.

    datatype_icon

    error in

    Error conditions that occur before this node runs.

    The node responds to this input according to standard error behavior.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

    Default: No error

    datatype_icon

    network stream endpoint out

    The network stream you added read or write properties to.

    datatype_icon

    error out

    The node produces this output according to standard error behavior.

    This node can return the following error codes.

    -314002 You cannot call this property from the reader endpoint. You can call this property from the writer endpoint only.
    -314001 You cannot call this property from the writer endpoint. You can call this property from the reader endpoint only.
    spd-note-note
    Note  

    This is not a comprehensive list of errors this node can return.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.
    datatype_icon

    Name

    Name of the URL that you wire to URL. This name only consists of the last few sections of the full URL. An example of this is context_name/endpoint_name, when the full URL is ni.dex://host_name:context_name/endpoint_name.

    datatype_icon

    URL

    The full name of the URL that you wire. An is example of this is: ni.dex://host_name:context_name/endpoint_name.

    datatype_icon

    Readable

    A Boolean value that indicates whether the wire is a reader endpoint.

    True The wire is a reader endpoint.
    False The wire is not a reader endpoint.
    datatype_icon

    Writable

    A Boolean value that indicates whether the wire is a writer endpoint.

    True The wire is a writer endpoint.
    False The wire is not a writer endpoint.
    datatype_icon

    DataType

    Reference to the data type you wired into Create Network Stream Reader Endpoint or Create Network Stream Writer Endpoint.

    datatype_icon

    BufferSize

    The number of data type elements stored by the Create Network Stream Reader Endpoint node or the Create Network Stream Writer Endpoint node.

    datatype_icon

    AvailElmntsForWrite

    The number of available elements to write. The number of elements available is determined by subtracting the number of elements in the buffer of a writer by the buffer size. Using this property on a reader returns an error visible in error out.

    datatype_icon

    AvailElmntsForRead

    The number of available elements to read. The number of elements available is determined by the number of available elements to read in the buffer. Using this property on a writer returns an error visible in error out.

    datatype_icon

    Connected

    A Boolean value that indicates whether there is an active network stream connection.

    True There is an active network stream connection.
    False There is not an active network stream connection.
    datatype_icon

    NumDisconnects

    The number of times the application lost connection to the network stream since it was first connected. This property determines the number of disconnects by counting the amount of times Connected is False.

    datatype_icon

    RemoteEndptDestroyed

    A Boolean value that indicates whether an endpoint is closed.

    True The endpoint is closed.
    False The endpoint is not closed.
    datatype_icon

    TotalElmntsWritten

    The total number of elements the application writes over the lifetime of the network stream while using either the Write Multiple Elements to Stream node or Write Single Element to Stream node.

    datatype_icon

    TotalElmntsRead

    The total number of elements the application reads over the lifetime of the network stream while using either the Read Multiple Elements from Stream node or Read Single Element from Stream node.

    Where This Node Can Run:

    Desktop OS: Windows

    FPGA: This product does not support FPGA devices


    Recently Viewed Topics