Table Of Contents

TCP Listen (G Dataflow)

Version:
    Last Modified: March 15, 2017

    Creates a listener and waits for an accepted TCP network connection at the specified port.

    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 for a connection. If the node cannot establish a connection in the specified time, the node returns an error.

    Default: -1 — Causes this node to wait indefinitely for a connection.

    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

    resolve remote address

    Boolean that indicates whether to call the IP Address to String node on the remote address. Refer to IP Address to String for more information.

    True The node calls the IP Address to String node on the remote address.
    False The node does not call the IP Address to String node on the remote address.

    Default: True

    datatype_icon

    listener ID

    A network connection refnum that uniquely identifies the listener.

    datatype_icon

    connection ID

    A network connection refnum that uniquely identifies the connection. Use this value to refer to this connection in subsequent node calls.

    datatype_icon

    remote address

    The address of the remote machine associated with the TCP connection.

    datatype_icon

    remote port

    The port the remote system uses for the connection.

    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