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

Declaration

  define external function tcp.set-buffering
     of      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.

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:
  

    import "omtcp.xmd" prefixed by tcp.
    process
       local tcp.connection Connection-1
  
       ....
       tcp.set-buffering of Connection-1 enabled true
  

• enable buffering with 1024 bytes of buffer size:
  

       tcp.set-buffering of Connection-1 size 1024
  

• disable buffering:
  

       tcp.set-buffering of Connection-1 enabled false
  

Related Syntax    tcp.connection    tcp.disconnect    tcp.writer    tcp.get-string    tcp.peer-ip    tcp.peer-name    tcp.reader    tcp.wait-for-input    tcp.is-connected    tcp.put-string    tcp.connect    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 ]