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

Declaration

  define external function tcp-set-buffering
           value tcp-connection Connection
   enabled value switch         IsBuffered optional initial {true}
      size value integer        BufferSize optional

Argument definitions

Connection

is an existing tcp-connection object.

IsBuffered

is an optional switch value with a default setting of "true".

BufferSize

is an optional integer value indicating the maximum size for the buffer.

Use tcp-set-buffering to

• disable a TCP connection object's buffering, or
• change the internal buffer size.

Requirements

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

  include "omtcp.xin"

Usage Notes

By default, a TCP connection object buffers its output when writing to it through a derived external output object (sink). Buffering is the property of the TCP connection object and not the external output objects (sinks) derived from it.

Buffering is done only when writing to the TCP connection object through an external output object. The TCP connection buffer is flushed when any derived external output object is closed.

Examples

To:

• enable buffering with the default buffer size:
  

    local tcp-connection Connection-1
  
       tcp-set-buffering Connection-1 enabled true
  

• enable buffering with 1024 bytes of buffer size:
  

       tcp-set-buffering Connection-1 size 1024
  

• disable buffering:
  

       tcp-set-buffering Connection-1 enabled false
  

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 ]