Full text search
function	TCPConnectionGetSource

Library: TCP/IP Include: omioprot.xin, omtcp.xin

Returns: Opaque Returns an external source object.

Declaration

  define external source function TCPConnectionGetSource
        value TCPConnection this-TCPConnection
        timeout value counter timeout-in-milliseconds optional
        protocol value IOProtocol this-IOProtocol optional
  as TCPConnectionGetSource

This function returns an external source object from which data will be read.

If the passed TCP connection object is closed or was never connected, then this function returns a dummy external source object that immediately returns "end of input". At the same time, it sets the TCP connection object to be in error.

The timeout value applies primarily to data read from the returned external source.

TCPConnectionGetSource can be called more than once for a connection. All such derived sources read from the same source attachment, but such sources are subject to read-ahead, and it is generally the case that a read from a source will actually capture more data than is needed for immediate use. This means that if there are two or more sources derived from a connection, it is usually the case that data read from one such source is not that which immediately follows that read from another such source. As a consequence, only ONE external source can be derived from a connection at a time. That is, sources must be derived serially.