TCPConnectionIsConnected

function

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

Returns: True if the TCP connection is currently connected to a peer; false otherwise.

Declaration

define external switch function TCPConnectionIsConnected
      value TCPConnection this-TCPConnection
as "TCPConnectionIsConnected"

Purpose

This function determines if the TCP connection is currently connected, independently of whether it's just been declared, is open, or is in error. It is always valid to call this function.

Argument:

"this-TCPConnection" is an OMX component of type TCPConnection.

Example:

  local TCPConnection client
  
  set client to TCPConnectionOpen on "osarus" at 5902
  repeat
     exit unless TCPConnectionIsConnected client
     
     ;process
  again