TcpReadCommand

Namespace inet

TcpReadCommand

class

C++ definition

Control info that represents a READ request. ~Tcp only accepts READ requests from the user when the connection was opened with autoRead=false.

~Tcp will respond to the reception of a READ request with data; either from previously received and buffered data, or data received from the network. Only one READ request may be outstanding, ~Tcp will not accept another READ until the previous one has been satisfied.

The maxByteCount field specifies the maximum number of bytes to be read. Note that ~Tcp will respond as soon as any data becomes available, so the response is often smaller than maxByteCount.

<b>See also:</b> ~TcpOpenCommand

Extends

Name Type Description
TcpCommand (unknown -- not in documented files)

Fields

Name Type Description
maxByteCount int32_t

size limit for the data response

Source code

//
// Control info that represents a READ request. ~Tcp only accepts READ requests
// from the user when the connection was opened with autoRead=false.
//
// ~Tcp will respond to the reception of a READ request with data; either
// from previously received and buffered data, or data received from the network.
// Only one READ request may be outstanding, ~Tcp will not accept another READ
// until the previous one has been satisfied.
//
// The maxByteCount field specifies the maximum number of bytes to be read.
// Note that ~Tcp will respond as soon as any data becomes available,
// so the response is often smaller than maxByteCount.
//
// @see ~TcpOpenCommand
//
class TcpReadCommand extends TcpCommand
{
    int32_t maxByteCount; // size limit for the data response
}

File: src/inet/transportlayer/contract/tcp/TcpCommand.msg