swirl
Guide to OmniMark 8   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesLegacy LibrariesErrors
 
      Other Library Functions  
function  

tcp-is-connected

 
 

Library: TCP/IP client and server support (OMTCP) legacy
Include: omtcp.xin
Return type: Switch

Returns:


Declaration

define external switch function tcp-is-connected
      value tcp-connection Connection

Argument definitions

Connection
is variable of type tcp-connection.


Purpose

Use tcp-is-connected to determine if the TCP connection is currently connected, independently of whether it's just been declared, is open, or is in error.

Requirements

You must include the following line at the beginning of your OmniMark program:

  include "omtcp.xin"

It is always valid to call this function.

Usage Notes

None.

Example


  local tcp-connection Client
  
  set Client to tcp-connect on "osarus" at 5902
  repeat
     exit unless tcp-is-connected Client
  
     ;process
  again

        Other Library Functions
   tcp-accept-connection
   tcp-connect
   tcp-connection
   tcp-create-service
   tcp-destroy-service
   tcp-disconnect
   tcp-get
   tcp-has-characters
   tcp-is-connected
   tcp-is-version-compatible
   tcp-library-version
   tcp-peer-ip
   tcp-peer-name
   tcp-port
   tcp-put
   tcp-service
   tcp-set-buffering
   tcp-signal-source-end
   tcp-sink
   tcp-source
 
 

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

OmniMark 8.2.0 Documentation Generated: March 13, 2008 at 3:27:39 pm
If you have any comments about this section of the documentation, please use this form.

Copyright © Stilo International plc, 1988-2008.