Library: Net, TCP/IP client and server support (OMTCP) Import: omtcp.xmd

Return type: Switch Returns:

Declaration

  define external stream function tcp.wait-for-input
    from    value	tcp.connection	Connection
    timeout value	integer		ms            optional

Argument definitions

Connection

is an existing tcp connection.

ms

is how long the function will wait for at least one character, expressed in milliseconds.

Use tcp.wait-for-input to test if there are characters available from a source on the TCP connection object.

Requirements

Connection must exist (else external exception TCP05).

Usage Notes

None

Example

  import "omtcp.xmd" prefixed by tcp.
  process
     local tcp.connection Connection-1

     set Connection-1 to tcp.connect to "localhost" on 5300

     repeat
        exit unless tcp.wait-for-input from Connection-1 timeout 2000
        output tcp.get-string from Connection-1
     again

Related Syntax    tcp.disconnect    tcp.writer    tcp.get-string    tcp.peer-ip    tcp.peer-name    tcp.reader    tcp.wait-for-input    tcp.is-connected    tcp.put-string    tcp.connect    tcp.set-buffering    tcp.terminate-reader

Other Library Functions    tcp.accept-connection    tcp.connect    tcp.connection    tcp.create-service    tcp.destroy-service    tcp.disconnect    tcp.end-delimited    tcp.get-string    tcp.is-connected    tcp.multi-packet    tcp.omtcp-version    tcp.peer-ip    tcp.peer-name    tcp.port    tcp.put-string    tcp.reader    tcp.service    tcp.set-buffering    tcp.single-packet    tcp.terminate-reader    tcp.wait-for-input    tcp.writer

[ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACYLIBRARIES ] [ ERRORS ]