Table Of Contents

TCP Create Listener (G Dataflow)

Version:
    Last Modified: March 15, 2017

    Creates a listener for a TCP network connection. Use the TCP Open Connection node to query the NI Service Locator for the port number registered with the service name.

    Programming Patterns
    connector_pane_image
    datatype_icon

    net address

    Network address to listen on. Specifying an address is useful if you have more than one network card, such as two Ethernet cards, and want to listen only on the card with the specified address. If you do not specify a network address, this node listens on all network addresses. Use the String to IP Address node to obtain the IP network address of the current computer.

    This input supports scalar strings and unsigned 32-bit integers.

    Default: 0

    datatype_icon

    service name

    Name you want to assign to the service. The node creates a known reference for the port number. If you specify a service name, this node registers the service name and the port number with the NI Service Locator.

    datatype_icon

    port

    Port number on which you want to listen for a connection. Wire 0 to port to dynamically choose an available TCP port that the operating system determines is valid for use.

    datatype_icon

    timeout ms

    Time, in milliseconds, that the node waits to complete before reporting a timeout error. A value of -1 indicates to wait indefinitely.

    Default: 25,000 ms

    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

    listener ID

    A network connection refnum that uniquely identifies the listener.

    datatype_icon

    actual port

    The port number the node used. If you wire 0 to the port input, this node dynamically chooses an available TCP port that the operating system determines is valid for use. If you wire a value other than zero to the input port, the output port number equals the input port number. As defined by the Internet Assigned Numbers Authority (IANA), valid port numbers are between the range of 49152 through 65535. Well-known ports range from 0 to 1023 and registered ports range from 1024 to 49151. However, not all operating systems follow the IANA standard. For example, Windows returns dynamic ports in the range from 1024 to 5000.

    datatype_icon

    error out

    Error information.

    The node produces this output 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.

    Where This Node Can Run:

    Desktop OS: Windows

    FPGA: This product does not support FPGA devices


    Recently Viewed Topics