Create Network Stream Reader Endpoint Function

LabVIEW 2018 Help


Edition Date: March 2018
Part Number: 371361R-01
View Product Info

DOWNLOAD (Windows Only)


LabVIEW 2016 Help
LabVIEW 2017 Help
LabVIEW 2018 Help
LabVIEW 2019 Help
LabVIEW 2020 Help

Owning Palette: Network Streams Functions

Requires: Base Development System (Windows)

Creates the reader endpoint of a network stream. This function will not run unless you also create a writer endpoint with the Create Network Stream Writer Endpoint function. You must wire either the writer url input of this function or the reader url input of the Create Network Stream Writer Endpoint function. If you do not wire either of these inputs, your endpoints will not create a network stream. Refer to the Streaming Data and Sending Commands between Applications topic for more information about using this function.

timeout in ms specifies the time, in milliseconds, that this endpoint waits to connect to the other endpoint. The default value is –1, which means this endpoint waits indefinitely. If the timeout expires before the endpoints connect, this function returns an error.
reader buffer size is the size of the reader buffer in number of elements. The minimum size is one element.
reader name specifies the name of the endpoint. You can organize multiple endpoints by adding segments to this name. If you specify a name that already belongs to another endpoint on the same computer, LabVIEW creates the first endpoint that runs and returns an error on the second. If this endpoint resides on a computer that runs multiple applications that use network streams, you must assign an endpoint URL to this endpoint instead of a name.
writer url is where you specify the URL of the endpoint you want to connect to. If you do not wire this input, this endpoint will not attempt to connect with the writer endpoint. Instead, it will wait for a connection from the writer endpoint. Therefore, you either must wire this input or the reader url input on the Create Network Stream Writer Endpoint function to create a valid network stream. Refer to the Connecting Network Stream Endpoints Together topic for more information about these options.
data type specifies the data type of the stream. Wire a constant or control to this input of the same data type as the data type input on the Create Network Stream Writer Endpoint function.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
element allocation mode specifies whether buffer memory is allocated when the endpoint is created. The default mode is allocate as needed. Specifying an allocation mode only affects the transfer of non-scalar data types.
allocate as needed specifies that the memory required to store each data element is allocated as elements enter the buffer.
pre-allocate specifies that buffer memory allocation occurs when the endpoint is created. The element wired to the data type input determines the amount of memory allocated for each element. If a larger element is added to the buffer during run-time, additional memory is allocated dynamically.
reader endpoint returns the reference to the reader endpoint.
error out contains error information. This output provides standard error out functionality.

WAS THIS ARTICLE HELPFUL?

Not Helpful