TCPConnectionHasCharactersToRead

function

Library: TCP/IP client and server support (OMTCP legacy, OmniMark versions 4 - 6.0.1)
Include: omtcp.xin

Returns: True if there are characters to read; false if there are none.

Declaration

define external stream function TCPConnectionHasCharactersToRead
    value TCPConnection this-TCPConnection
    timeout value integer timeout-in-milliseconds optional
elsewhere

Purpose

You can use this function to determine whether there are characters available from a source on the TCP connection object.

Arguments:

"this-TCPConnection" is an OMX component of type TCPConnection.
"timeout-in-milliseconds" is the length of time the function will run for before terminating automatically.

Example

  
   local TCPConnection TCP-Conn
  
  set TCP-Conn to TCPConnectionOpen on "localhost" at 5300
  
  repeat
      exit unless TCPConnectionHasCharactersToRead TCP-Conn timeout 2000
      output TCPConnectionGetCharacters TCP-Conn
   again