TCPConnectionIsInError

function

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

Returns: True if there are errors detected; false otherwise.

Declaration

define external switch function TCPConnectionIsInError
      value TCPConnection this-TCPConnection
as TCPConnectionIsInError

Purpose

This function detects errors in initiating or using a TCP connection.

Errors in initiating or using a TCP connection are recorded in the TCPconnection OMX component itself.

Argument:

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

Example:

  local TCPConnection client
  
  set client to TCPConnectionOpen on "123.123.123.45" at 5600
  do when TCPConnectionIsInError client
     local stream errorReport variable
  
     TCPConnectionGetStatusReport client into errorReport
     output "TCPConnection Error:%n"
     repeat over errorReport
        output errorReport || "%n"
     again
  done