TCPServiceGetStatusReport

function

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

Declaration

define external function TCPServiceGetStatusReport
      value TCPService this-TCPService
   into modifiable stream report
as TCPServiceGetStatusReport

Purpose

TCPServiceGetStatusReport is used to identify errors in the TCP service. Errors in initiating or using a TCP service are recorded in the TCP service itself, or in the TCP connection objects derived from it.

If the TCP service is in error, the into shelf is populated with one or more strings, each with an appropriate error message. Any previous shelf contents are lost. In most cases, there will be only one string placed on the shelf. If the TCP service is not in error, the shelf will be cleared.

Each error entry in the shelf consists of a symbolic (string) error code, followed by a single space, followed by text that describes or explains the error in more detail. A list of symbolic constants along with their meanings is shown below:

ENETDOWN: "Network subsystem failed"
EMFILE: "No file handles available"
ENOBUFS: "No buffer space available"
ENOSOCK: "Handle is not a socket"
EADDRINUSE: "Address already in use"
ENOTCONN:" Not connected"
EADDRNOTAVAIL: "Address not available"
EBIND: "Failed to create service (listen) port"
EACCEPT: "Failed to accept new connection"
EINTERNAL: "Internal error"

Arguments:

"this-TCPService" is an OMX component of type TCPService.
"report" is the stream shelf in which the error messages are stored. It must be variable to allow TCPServiceGetStatusReport to determine how many messages are returned.

Example:

  local stream errorReport variable
  
  TCPServiceGetStatusReport omdemo-service into errorReport
  output "TCPService Error:%n" when number of errorReport < 0
  repeat over errorReport
     output errorReport || "%n"
  again