Library: Net, TCP/IP client and server support (OMTCP) Import: omtcp.xmd

Return type: Boolean Returns:

Declaration

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

Argument definitions

Connection

is variable of type tcp.connection.

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

It is always valid to call this function.

Usage Notes

None.

Example

  import "omtcp.xmd" prefixed by tcp.

  process
     local tcp.connection Client

     set Client to tcp.connect to "osarus" on 5902
     repeat
        exit unless tcp.is-connected Client

        ;process
     again

Related Syntax    tcp.connection    tcp.disconnect    tcp.writer    tcp.get-string    tcp.peer-ip    tcp.peer-name    tcp.reader    tcp.wait-for-input    tcp.put-string    tcp.connect    tcp.set-buffering    tcp.terminate-reader

Other Library Functions    tcp.accept-connection    tcp.connect    tcp.connection    tcp.create-service    tcp.destroy-service    tcp.disconnect    tcp.end-delimited    tcp.get-string    tcp.is-connected    tcp.multi-packet    tcp.omtcp-version    tcp.peer-ip    tcp.peer-name    tcp.port    tcp.put-string    tcp.reader    tcp.service    tcp.set-buffering    tcp.single-packet    tcp.terminate-reader    tcp.wait-for-input    tcp.writer

[ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACYLIBRARIES ] [ ERRORS ]