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

Declaration

  define external function TCPConnectionSetBuffering
        value TCPConnection this-TCPConnection
     enabled value switch IsBuffered optional initial {true}
     size value integer BufferSize optional
  as TCPConnectionSetBuffering 

This function is used to disable a TCP connection object's buffering, or to change the internal buffer size. 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. When writing to the TCP connection object using TCPConnectionPut, you must first disable buffering with TCPConnectionSetBuffering.

Arguments:

• "this-TCPConnection" is an OMX component of type TCPConnection.
• "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.

Examples:

• To enable buffering with the default buffer size: TCPConnectionSetBuffering this-TCPConnection enabled true
• To disable buffering: TCPConnectionSetBuffering this-TCPConnection enabled false
• To enable buffering with 1024 bytes of buffer size: TCPConnectionSetBuffering this-TCPConnection size 1024

Other Library Functions    TCPConnection    TCPConnectionClose    TCPConnectionGetCharacters    TCPConnectionGetLine    TCPConnectionGetOutput    TCPConnectionGetPeerIP    TCPConnectionGetPeerName    TCPConnectionGetSource    TCPConnectionGetStatusReport    TCPConnectionHasCharactersToRead    TCPConnectionIsConnected    TCPConnectionIsInError    TCPConnectionOpen    TCPConnectionPut    TCPConnectionSetBuffering    TCPConnectionSignalSourceEnd    TCPIsVersionCompatible    TCPLibraryVersion    TCPService    TCPServiceAcceptConnection    TCPServiceClose    TCPServiceGetPort    TCPServiceGetStatusReport    TCPServiceIsInError    TCPServiceIsOpen    TCPServiceOpen    TCPTraceConnectionOpen

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