inet::tcp::TcpLwipByteStreamSendQueue Class Reference

Send queue that manages "data stream", that is, actual bytes. More...

#include <TcpLwipByteStreamQueues.h>

Inheritance diagram for inet::tcp::TcpLwipByteStreamSendQueue:

Public Member Functions
	TcpLwipByteStreamSendQueue ()
	Ctor. More...
virtual	~TcpLwipByteStreamSendQueue ()
	Virtual dtor. More...
virtual void	setConnection (TcpLwipConnection *connP) override
	set connection queue, and initialise queue variables. More...
virtual void	enqueueAppData (cPacket *msgP) override
	Called on SEND app command, it inserts in the queue the data the user wants to send. More...
virtual unsigned int	getBytesForTcpLayer (void *bufferP, unsigned int bufferLengthP) const override
	Copy data to the buffer for send to LWIP. More...
virtual void	dequeueTcpLayerMsg (unsigned int msgLengthP) override
	This function should remove msgLengthP bytes from TCP layer queue. More...
unsigned long	getBytesAvailable () const override
	Utility function: returns how many bytes are available in the queue. More...
virtual TCPSegment *	createSegmentWithBytes (const void *tcpDataP, unsigned int tcpLengthP) override
	Called when the TCP wants to send or retransmit data, it constructs a TCP segment which contains the data from the requested sequence number range. More...
virtual void	discardAckedBytes (unsigned long bytesP)
Public Member Functions inherited from inet::tcp::TcpLwipSendQueue
	TcpLwipSendQueue ()
	Ctor. More...
virtual	~TcpLwipSendQueue ()
	Virtual dtor. More...

Protected Attributes
ByteArrayBuffer	byteArrayBufferM
Protected Attributes inherited from inet::tcp::TcpLwipSendQueue
TcpLwipConnection *	connM

Detailed Description

Send queue that manages "data stream", that is, actual bytes.

Constructor & Destructor Documentation

inet::tcp::TcpLwipByteStreamSendQueue::TcpLwipByteStreamSendQueue

(

)

Ctor.

{
}

inet::tcp::TcpLwipByteStreamSendQueue::~TcpLwipByteStreamSendQueue ( )

virtual

Virtual dtor.

{
}

Member Function Documentation

TCPSegment * inet::tcp::TcpLwipByteStreamSendQueue::createSegmentWithBytes ( const void *  tcpDataP, unsigned int  tcpLengthP  )

overridevirtual

Called when the TCP wants to send or retransmit data, it constructs a TCP segment which contains the data from the requested sequence number range.

The actually returned segment may contain less then maxNumBytes bytes if the subclass wants to reproduce the original segment boundaries when retransmitting.

called from inside of send_callback() called before called the send() to IP layer

Implements inet::tcp::TcpLwipSendQueue.

{
    ASSERT(tcpDataP);

    TCPSegment *tcpseg = serializer::TCPSerializer().deserialize((const unsigned char *)tcpDataP, tcpLengthP, true);
    uint32 numBytes = tcpseg->getPayloadLength();

    char msgname[80];

    sprintf(msgname, "%.10s%s%s%s(l=%lu,%u bytes)",
            "tcpseg",
            tcpseg->getSynBit() ? " SYN" : "",
            tcpseg->getFinBit() ? " FIN" : "",
            (tcpseg->getAckBit() && 0 == numBytes) ? " ACK" : "",
            (unsigned long)numBytes,
            tcpseg->getByteArray().getDataArraySize());
    tcpseg->setName(msgname);

    return tcpseg;
}

void inet::tcp::TcpLwipByteStreamSendQueue::dequeueTcpLayerMsg ( unsigned int  msgLengthP )

overridevirtual

This function should remove msgLengthP bytes from TCP layer queue.

Implements inet::tcp::TcpLwipSendQueue.

{
    byteArrayBufferM.drop(msgLengthP);
}

void inet::tcp::TcpLwipByteStreamSendQueue::discardAckedBytes ( unsigned long  bytesP )

virtual

{
    // nothing to do here
}

void inet::tcp::TcpLwipByteStreamSendQueue::enqueueAppData ( cPacket *  msgP )

overridevirtual

Called on SEND app command, it inserts in the queue the data the user wants to send.

Implementations of this abstract class will decide what this means: copying actual bytes, just increasing the "last byte queued" variable, or storing cMessage object(s). The msg object should not be referenced after this point (sendQueue may delete it.)

Implements inet::tcp::TcpLwipSendQueue.

{
    ASSERT(msgP);

    RawPacket *msg = check_and_cast<RawPacket *>(msgP);
    int64 bytes = msg->getByteLength();

    ASSERT(bytes == msg->getByteArray().getDataArraySize());

    byteArrayBufferM.push(msg->getByteArray());
    delete msgP;
}

unsigned long inet::tcp::TcpLwipByteStreamSendQueue::getBytesAvailable ( ) const

overridevirtual

Utility function: returns how many bytes are available in the queue.

Implements inet::tcp::TcpLwipSendQueue.

{
    return byteArrayBufferM.getLength();
}

unsigned int inet::tcp::TcpLwipByteStreamSendQueue::getBytesForTcpLayer ( void *  bufferP, unsigned int  bufferLengthP  ) const

overridevirtual

Copy data to the buffer for send to LWIP.

returns lengh of copied data. create msg for socket->send_data()

called before called socket->send_data()

Implements inet::tcp::TcpLwipSendQueue.

{
    ASSERT(bufferP);

    return byteArrayBufferM.getBytesToBuffer(bufferP, bufferLengthP);
}

void inet::tcp::TcpLwipByteStreamSendQueue::setConnection ( TcpLwipConnection *  connP )

overridevirtual

set connection queue, and initialise queue variables.

Reimplemented from inet::tcp::TcpLwipSendQueue.

{
    byteArrayBufferM.clear();
    TcpLwipSendQueue::setConnection(connP);
}

Member Data Documentation

ByteArrayBuffer inet::tcp::TcpLwipByteStreamSendQueue::byteArrayBufferM

protected

Referenced by dequeueTcpLayerMsg(), enqueueAppData(), inet::tcp::TcpLwipByteStreamReceiveQueue::enqueueTcpLayerData(), inet::tcp::TcpLwipByteStreamReceiveQueue::extractBytesUpTo(), inet::tcp::TcpLwipByteStreamReceiveQueue::getAmountOfBufferedBytes(), getBytesAvailable(), getBytesForTcpLayer(), inet::tcp::TcpLwipByteStreamReceiveQueue::getExtractableBytesUpTo(), inet::tcp::TcpLwipByteStreamReceiveQueue::getQueueLength(), setConnection(), and inet::tcp::TcpLwipByteStreamReceiveQueue::setConnection().

---

The documentation for this class was generated from the following files:

• TcpLwipByteStreamQueues.h
• TcpLwipByteStreamQueues.cc