swirl
Guide to OmniMark 8   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesLegacy LibrariesErrors
 
  Related Syntax     Other Library Functions  
function  

tcp.set-buffering

 
 

Library: 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.


Purpose

Use tcp.set-buffering to

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:

    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
 
 

Top [ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACY LIBRARIES ] [ ERRORS ]

OmniMark 8.2.0 Documentation Generated: March 13, 2008 at 3:27:39 pm
If you have any comments about this section of the documentation, please use this form.

Copyright © Stilo International plc, 1988-2008.