Library: TCP/IP client and server support (OMTCP) original Include: omtcp.xin

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

Declaration

  define external stream function TCPConnectionHasCharacters
      value TCPConnection this-TCPConnection
      timeout value integer timeout-in-milliseconds optional
  as TCPConnectionHasCharacters

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

Other Library Functions    TCPConnection    TCPConnectionClose    TCPConnectionGetCharacters    TCPConnectionGetLine    TCPConnectionGetOutput    TCPConnectionGetPeerIP    TCPConnectionGetPeerName    TCPConnectionGetSource    TCPConnectionGetStatusReport    TCPConnectionHasCharactersToRead    TCPConnectionIsConnected    TCPConnectionIsInError    TCPConnectionOpen    TCPConnectionPut    TCPConnectionSetBuffering    TCPConnectionSignalSourceEnd    TCPIsVersionCompatible    TCPLibraryVersion    TCPService    TCPServiceAcceptConnection    TCPServiceClose    TCPServiceGetPort    TCPServiceGetStatusReport    TCPServiceIsInError    TCPServiceIsOpen    TCPServiceOpen    TCPTraceConnectionOpen

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