swirl
Guide to OmniMark 9   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesLegacy LibrariesErrors
 
  Related Topics   Other Library Functions  
function  

tcp.wait-for-input

 
 

Library: TCP/IP client and server support (OMTCP)
Import: omtcp.xmd
Return type: Switch

Returns:


Declaration

define external switch 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.


Purpose

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).

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 Topics
 
Other Library Functions
 
 

Top [ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACY LIBRARIES ] [ ERRORS ]

OmniMark 9.1.0 Documentation Generated: September 2, 2010 at 1:38:10 pm
If you have any comments about this section of the documentation, please use this form.

Copyright © Stilo International plc, 1988-2010.