TTCPSendBuffer - Revision history

Ultibo at 01:48, 30 May 2018

2018-05-30T01:48:46Z

Ultibo: Created page with "Return to Unit TCP TOC === Description === ---- ''To be documented'' === Class definitions === ----

2018-05-30T01:47:14Z

Created page with "Return to Unit TCP TOC === Description === ---- ''To be documented'' === Class definitions === ---- <div class="toccolours mw-collapsible mw-collapsed"..."

New page
Return to [[Unit_TCP|Unit TCP]]

TOC

=== Description ===
----

''To be documented''

=== Class definitions ===
----

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">

<code>TTCPSendBuffer = class(TSocketBuffer)</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>constructor Create(ASocket:TTransportSocket);</code>
| style="width: 50%;"| 
|-
| <code>destructor Destroy; override;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
|-
| <code>FFirst:PTCPSegment;</code>
| Pointer to First Segment
|-
| <code>FLast:PTCPSegment;</code>
| Pointer to Last Segment
|-
|colspan="2"| 
|-
| <code>function AddSegment(ASequence:LongWord; AFlags:Byte; ASize:Word):PTCPSegment;</code>
|  
|-
| <code>function RemoveSegment(ASegment:PTCPSegment):Boolean;</code>
|  
|-
| <code>procedure FlushSegments(All:Boolean);</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
|-
| <code>procedure SetSize(ASize:LongWord); override;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
|-
| <code>StartSequence:LongWord;</code>
| Initial Sequence number of Local (ISS)
|-
| <code>NextSequence:LongWord;</code>
| Next Sequence number to Send (SND.NXT
|-
| <code>LastSequence:LongWord;</code>
| Last Sequence number in Buffer
|-
| <code>LastAcknowledge:LongWord;</code>
| Last Acknowledged number from Remote (SND.UNA)
Note: LastAcknowledge is the NextSequence that Remote expects to Receive or the first Unacknowledged Sequence number. If LastAcknowledge equals NextSequence all segments have been Acknowledged LastSequence is the last sequence in our buffer to send. If NextSequence equals LastSequence there is no more data to send.
|-
|colspan="2"| 
|-
| <code>UrgentPointer:LongWord;</code>
| (SND.UP)
|-
|colspan="2"| 
|-
| <code>MaxSeg:Word;</code>
| Remote Max Segment Size (Learned from Remote)
|-
|colspan="2"| 
|-
| <code>WindowSize:LongWord;</code>
| Remote Window Size (SND.WND)
|-
| <code>WindowScale:Byte;</code>
| Remote Window Scale
|-
| <code>WindowTimeout:Int64;</code>
| Timeout for probing small/zero Window
|-
|colspan="2"| 
|-
| <code>CongestionWindow:Word;</code>
| Slow Start Window Size
|-
|colspan="2"| 
|-
| <code>SynSequence:LongWord;</code>
| Sequence number of our SYN
|-
| <code>FinSequence:LongWord;</code>
| Sequence number of our FIN
|-
|colspan="2"| 
|-
| <code>WindowSequence:LongWord;</code>
| Sequence number of last Window update (SND.WL1)
|-
| <code>WindowAcknowledge:LongWord;</code>
| Acknowledge number of last Window update (SND.WL2)
|-
|colspan="2"| 
|-
| <code>NoPush:Boolean;</code>
| Disable Push on final segment
|-
| <code>NoSack:Boolean;</code>
| Selective Ack not in use
|-
| <code>NoNagle:Boolean;</code>
| Nagle not in use
|-
|colspan="2"| 
|-
| <code>VjSa:LongWord;</code>
| VJ's alg, standard average
|-
| <code>VjSd:LongWord;</code>
| VJ's alg, standard deviation
|-
| <code>VjLast:LongWord;</code>
| VJ's alg, last transmit time
|-
|colspan="2"| 
|-
| <code>function CheckIdle:Boolean;</code>
|  
|-
|colspan="2"| 
|-
| <code>function SynAcknowledged:Boolean;</code>
|  
|-
| <code>function FinAcknowledged:Boolean;</code>
|  
|-
|colspan="2"| 
|-
| <code>function TestAcknowledge(AAcknowledge:LongWord):Boolean;</code>
|  
|-
| <code>function CheckAcknowledge(AAcknowledge:LongWord):Boolean;</code>
|  
|-
| <code>function ValidateAcknowledge(AAcknowledge:LongWord):Boolean;</code>
|  
|-
|colspan="2"| 
|-
| <code>function WriteData(var ABuffer; ASize,AFlags:Integer):Boolean;</code>
|  
|-
|colspan="2"| 
|-
| <code>function Finish:Boolean;</code>
|  
|-
| <code>function Synchronize:Boolean;</code>
|  
|-
|colspan="2"| 
|-
| <code>function ReadSegment(var ASequence:LongWord; var AUrgent:Word; var AFlags:Byte; var AData:Pointer; var ASize:Word; AForce:Boolean):Boolean;</code>
|  
|-
| <code>function AcknowledgeSegments(ASequence,AAcknowledge:LongWord; AWindow:Word):Boolean;</code>
|  
|-
|colspan="2"| 
|-
| <code>function TimestampSegment(AOptions:Pointer; var AOffset:Word):Boolean;</code>
|  
|-
| <code>function SelectiveAckSegments(AOptions:Pointer; var AOffset:Word; ASize:Byte):Boolean;</code>
|  
|-
|}
</div></div>
<br />

=== Function declarations ===
----

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">constructor TTCPSendBuffer.Create;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">destructor TTCPSendBuffer.Destroy;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTCPSendBuffer.AddSegment(ASequence:LongWord; AFlags:Byte; ASize:Word):PTCPSegment;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Adds a new Segment as the last segment in the list</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Sequence
| Sequence is the start sequence
|-
! Size
| Size can be zero
Size should not include the SYN and FIN sequence
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTCPSendBuffer.RemoveSegment(ASegment:PTCPSegment):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Removes the passed Segment from the list</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure TTCPSendBuffer.FlushSegments(All:Boolean);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Removes ACKed Segments from the buffer (or All)</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure TTCPSendBuffer.SetSize(ASize:LongWord);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Size
| Size cannot be set smaller than the default or existing
|-
! Note
| For TCP setting the size does not clear existing segments
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTCPSendBuffer.CheckIdle:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Check if all data in the send buffer has been sent and acknowledged</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTCPSendBuffer.SynAcknowledged:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Test if a SYN has been sent and if it has been ACKed</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTCPSendBuffer.FinAcknowledged:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Test if a FIN has been sent and if it has been ACKed</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTCPSendBuffer.TestAcknowledge(AAcknowledge:LongWord):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Tests an Acknowledge for invalidity</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| If SEG.ACK =< ISS, or SEG.ACK > SND.NXT then the ACK is unacceptable
Only ever used when Socket is in SYN_SENT state
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTCPSendBuffer.CheckAcknowledge(AAcknowledge:LongWord):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Checks an Acknowledge for validity</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| If SND.UNA =< SEG.ACK =< SND.NXT then the ACK is acceptable
Only ever used when Socket is in SYN_REC state
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTCPSendBuffer.ValidateAcknowledge(AAcknowledge:LongWord):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Checks an Acknowledge for validity</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| If the ACK acks something not yet sent (SEG.ACK > SND.NXT) then send an ACK
Used when Socket is in any of the Synchronized states
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTCPSendBuffer.WriteData(var ABuffer; ASize,AFlags:Integer):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Used by Send/SendTo to Write data into the buffer ready for Sending</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Flags
| Flags is for MSG_PEEK and MSG_OOB when applicable
|-
! Note
| Data that will not fit in the Buffer is simply discarded
Send coalescing is handled here by checking Last segment
<br />Push flag is set on the last written segment of user data
|-
! Socket Timing
| Whenever data is written to the buffer a notification is sent to the socket thread to check the socket immediately. This ensures that the segment is sent immediately if acceptable or otherwise will be sent when an acknowledge is received from the remote due to the Nagle algorithm.
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTCPSendBuffer.Finish:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Socket Timing
| When the FIN segment is written to the buffer a notification is sent to the socket thread to check the socket immediately. This ensures that the segment will be sent to the remote either immediately or after the Nagle delay.
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTCPSendBuffer.Synchronize:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Socket Timing
| When the SYN segment is written to the buffer a notification is sent to the socket thread to check the socket immediately. This ensures that the segment will be sent to the remote immediately.
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTCPSendBuffer.ReadSegment(var ASequence:LongWord; var AUrgent:Word; var AFlags:Byte; var AData:Pointer; var ASize:Word; AForce:Boolean):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Used by Socket to Read segments to be (re)sent from queue</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Nagle Algorithm and Retry Timeouts are handled here
|-
! Socket Timing
| For each sent segment a notification is scheduled for the socket thread to check the socket in TCP_RETRY_TIMEOUT[Segment.Count] milliseconds. This is to ensure that the segment is retried if not acknowledged by that time.
<br />
<br />For each sent segment that has a following segment a notification is sent to the socket thread to check the socket immediately. This ensures that all acceptable segments are sent immediately.
<br />
<br />For each retried segment a notification is also scheduled for the socket thread to check the socket in TCP_RETRY_TIMEOUT[Segment.Count] milliseconds which will be the next retry time if still not acknowledged.
<br />
<br />If the remote Window is not large enough to send the next segment then a notification is scheduled for the socket thread to check the socket in TCP_WINDOW_TIMEOUT milliseconds to ensure that a window probe is sent at the appropriate time.
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTCPSendBuffer.AcknowledgeSegments(ASequence,AAcknowledge:LongWord; AWindow:Word):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Used by Socket to Acknowledge segments that have been sent and update the Window</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Sequence, Acknowledge and Window are from the received Segment
|-
! Socket Timing
| For each acknowledged segment a notification is sent to the socket thread to check the socket immediately. This is to ensure that segments waiting to be sent due to the Nagle algorithm are sent on receipt of an acknowledge.
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTCPSendBuffer.TimestampSegment(AOptions:Pointer; var AOffset:Word):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Used by Socket to Timestamp (RTT) segments that have been sent</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Offset
| Offset points to the point to extract the timestamp option
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TTCPSendBuffer.SelectiveAckSegments(AOptions:Pointer; var AOffset:Word; ASize:Byte):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Used by Socket to Selective Ack segments that have been sent</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Offset
| Offset points to the point to start extracting SACKS
|-
! Size
| Size includes the Option and Size
|-
|}
</div></div>
<br />

Return to [[Unit_Reference|Unit Reference]]