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

Declaration

  define external function tcp-disconnect
   value tcp-connection Connection

Argument definitions

Connection

is a tcp-connection object.

Use tcp-disconnect to explicitly close a connection.

Requirements

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

  include "omtcp.xin"

Usage Notes

You can use tcp-disconnect to destroy a connection that has never been created or has already been destroyed.

Once a connection is closed then any read or write operation on an external source or output derived from it is in error.

Allowing the tcp-connection variable to go out of scope has the same effect as using tcp-disconnect.

It is good programming practice to have the scope of external sources and outputs derived from a TCP connection match that of the TCP connection itself. If this is done, then the programmer doesn't have to worry about the effect of the derived sources and outputs on the lifetime of the connection.

Example

  local tcp-connection Client

  	set Client to tcp-connect on "123.123.123.45" at 5600
  		. . .
  	tcp-disconnect Client

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

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