Difference between revisions of "Unit TCP"

From Ultibo.org
Jump to: navigation, search
 
Line 412: Line 412:
  
  
−
'''TCP protocol transport'''
+
'''TCP specific classes'''
  
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
<code>TTCPProtocolTransport = class(TProtocolTransport)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
−
|-
+
−
| <code>constructor Create;</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
| <code>destructor Destroy; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
 
|-
 
|-
−
| <code>Socket:TTCPSocket;</code>
+
| [[TTCPProtocolTransport|<code>TTCPProtocolTransport = class(TProtocolTransport)</code>]]
−
| Socket for responding to non matched segments
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
'''TCP protocol'''
+
−
 
+
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
−
 
+
−
<code>TTCPProtocol = class(TNetworkProtocol)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
| <code>constructor Create(AManager:TProtocolManager; const AName:String);</code>
+
| [[TTCPProtocol|<code>TTCPProtocol = class(TNetworkProtocol)</code>]]
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
| <code>destructor Destroy; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
| <code>FNextPort:Word;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FMinBacklog:Integer;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FMaxBacklog:Integer;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FReceiveBacklog:Integer;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function PacketHandler(AHandle:THandle; ASource,ADest,APacket:Pointer; ASize:Integer; ABroadcast:Boolean):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function SegmentHandler(ASocket:TTCPSocket; ASource,ADest,APacket:Pointer; ASize:Integer):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function ResetHandler(ASocket:TTCPSocket; ASource,ADest,APacket:Pointer; ASize:Integer):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function CloneSocket(ASocket:TTCPSocket; ALocalAddress,ARemoteAddress:Pointer; ALocalPort,ARemotePort:Word; ALock:Boolean; AState:LongWord):TTCPSocket;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function GetTCPOptionsSize(ASocket:TTCPSocket; AOptions:Pointer):Word;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function CreateTCPOptions(ASocket:TTCPSocket; AOptions:Pointer; AFlags:Byte):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function HandleTCPOptions(ASocket:TTCPSocket; AOptions:Pointer; AFlags:Byte):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function InsertTCPOption(ASocket:TTCPSocket; AOptions:Pointer; AOption:Byte):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function ExtractTCPOption(ASocket:TTCPSocket; AOptions:Pointer; AOption:Byte):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function SendReset(ASocket:TTCPSocket):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function SendAcknowledge(ASocket:TTCPSocket):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function SendSegment(ASocket:TTCPSocket; ASource,ADest:Pointer; ASourcePort,ADestPort:Word; ASequence,AAcknowledge:LongWord; AWindow,AUrgent:Word; AFlags:Byte; AOptions,AData:Pointer; ASize:Integer):Integer;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
+
−
|-
+
−
| <code>function OpenPort(ASocket:TProtocolSocket; APort:Word):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function ClosePort(ASocket:TProtocolSocket):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function FindPort(APort:Word; AWrite,ALock:Boolean):TProtocolPort; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function SelectCheck(ASource,ADest:PFDSet; ACode:Integer):Integer; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function SelectWait(ASocket:TProtocolSocket; ACode:Integer; ATimeout:LongWord):Integer; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>function Accept(ASocket:TProtocolSocket; ASockAddr:PSockAddr; AAddrLength:PInteger):TProtocolSocket; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function Bind(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; AAddrLength:Integer):Integer; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function CloseSocket(ASocket:TProtocolSocket):Integer; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function Connect(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; AAddrLength:Integer):Integer; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function IoctlSocket(ASocket:TProtocolSocket; ACmd:DWORD; var AArg:u_long):Integer; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetPeerName(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; var AAddrLength:Integer):Integer; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetSockName(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; var AAddrLength:Integer):Integer; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetSockOpt(ASocket:TProtocolSocket; ALevel,AOptName:Integer; AOptValue:PChar; var AOptLength:Integer):Integer; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function Listen(ASocket:TProtocolSocket; ABacklog:Integer):Integer; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function Recv(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer):Integer; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function RecvFrom(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer; var AFromAddr:TSockAddr; var AFromLength:Integer):Integer; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function Select(ANfds:Integer; AReadfds,AWritefds,AExceptfds:PFDSet; ATimeout:PTimeVal):LongInt; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function Send(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer):Integer; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function SendTo(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer; var AToAddr:TSockAddr; AToLength:Integer):Integer; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function SetSockOpt(ASocket:TProtocolSocket; ALevel,AOptName:Integer; AOptValue:PChar; AOptLength:Integer):Integer; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function Shutdown(ASocket:TProtocolSocket; AHow:Integer):Integer; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function Socket(AFamily,AStruct,AProtocol:Integer):TProtocolSocket; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function AddTransport(ATransport:TNetworkTransport):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function RemoveTransport(ATransport:TNetworkTransport):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function FindSocket(AFamily,AStruct,AProtocol:Word; ALocalAddress,ARemoteAddress:Pointer; ALocalPort,ARemotePort:Word; ABroadcast,AListen,ALock:Boolean; AState:LongWord):TProtocolSocket; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure FlushSockets(All:Boolean); override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function StartProtocol:Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function StopProtocol:Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function ProcessProtocol:Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function ProcessSockets:Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function ProcessSocket(ASocket:TProtocolSocket):Boolean; override;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
'''TCP socket'''
+
−
 
+
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
−
 
+
−
<code>TTCPSocket = class(TProtocolSocket)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
|colspan="2"|Note: SOCK_STREAM
+
| [[TTCPSocket|<code>TTCPSocket = class(TProtocolSocket)</code>]]
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>constructor Create(AProtocol:TNetworkProtocol; ATransport:TNetworkTransport);</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
| <code>destructor Destroy; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
| <code>FBackLog:Integer;</code>
+
−
| Backlog size of Listen/Accept Queue
+
−
|-
+
−
| <code>FListener:TProtocolSocket;</code>
+
−
| The Listener socket for this socket (If applicable)
+
−
|-
+
−
| <code>FAcceptQueue:TSocketList;</code>
+
−
| Sockets waiting for connection Accept
+
−
|-
+
−
| <code>FReceiveQueue:TSocketList;</code>
+
−
| Sockets waiting for SYN/ACK handshake
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FSendData:TTCPSendBuffer;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FRecvData:TTCPRecvBuffer;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>procedure SetBackLog(ABackLog:Integer);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetListener(AListener:TProtocolSocket);</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>property BackLog:Integer read FBackLog write SetBackLog;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property Listener:TProtocolSocket read FListener write SetListener;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property AcceptQueue:TSocketList read FAcceptQueue;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property ReceiveQueue:TSocketList read FReceiveQueue;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>property SendData:TTCPSendBuffer read FSendData;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property RecvData:TTCPRecvBuffer read FRecvData;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function GetOption(ALevel,AOptName:Integer; AOptValue:PChar; var AOptLength:Integer):Integer; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function SetOption(ALevel,AOptName:Integer; AOptValue:PChar; AOptLength:Integer):Integer; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function IoCtl(ACommand:DWORD; var AArgument:u_long):Integer; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function IsConnected(ALocalAddress,ARemoteAddress:Pointer; ALocalPort,ARemotePort:Word; ABroadcast:Boolean):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function IsListening(ALocalAddress,ARemoteAddress:Pointer; ALocalPort,ARemotePort:Word; ABroadcast:Boolean):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function Listen:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function Connect:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function Reconnect:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function Disconnect:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function Accept(APeek,ALock:Boolean; AState:LongWord):TTCPSocket;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function RecvSegment(ASequence,AAcknowledge:LongWord; AWindow,AUrgent:Word; AFlags:Byte; AData:Pointer; ASize:Word):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function SendSegment(var ASequence,AAcknowledge:LongWord; var AWindow,AUrgent:Word; var AFlags:Byte; var AData:Pointer; var ASize:Word):Boolean;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
'''TCP state'''
+
−
 
+
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
−
 
+
−
<code>TTCPState = class(TProtocolState)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
−
|-
+
−
| <code>constructor Create;</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
| <code>destructor Destroy; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
| <code>FState:LongWord;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>procedure SetState(AState:LongWord);</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function GetListening:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetListening(AValue:Boolean);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetEstablished:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetEstablished(AValue:Boolean);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetClosed:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetClosed(AValue:Boolean);</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function GetSynchronized:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>property State:LongWord read FState write SetState;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>property Listening:Boolean read GetListening write SetListening;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property Established:Boolean read GetEstablished write SetEstablished;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property Closed:Boolean read GetClosed write SetClosed;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
 
|-
 
|-
−
| <code>property Synchronized:Boolean read GetSynchronized;</code>
+
| [[TTCPState|<code>TTCPState = class(TProtocolState)</code>]]
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
'''TCP options'''
+
−
 
+
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
−
 
+
−
<code>TTCPOptions = class(TProtocolOptions)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
|colspan="2"|Note: For Get/Set Options Level = TCP_PROTO Option = TCP_NODELAY, TCP_MAXSEG etc
+
| [[TTCPOptions|<code>TTCPOptions = class(TProtocolOptions)</code>]]
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>constructor Create;</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
| <code>destructor Destroy; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
| <code>FMemory:TMemoryStream;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FOptions:LongWord;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FMaxSeg:Word;</code>
+
−
| MSS Option in TCP Header (MSS we send to Remote)
+
−
|-
+
−
| <code>FWindowScale:Byte;</code>
+
−
| Window Scale Option in TCP Header (Window Scale we send to Remote)
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>procedure SetMaxSeg(AMaxSeg:Word);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetWindowScale(AWindowScale:Byte);</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function GetOptions:Pointer;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetNoDelay:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetNoDelay(ANoDelay:Boolean);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetNoPush:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetNoPush(ANoPush:Boolean);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetNoOpt:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetNoOpt(ANoOpt:Boolean);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetBsdUrgent:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetBsdUrgent(ABsdUrgent:Boolean);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetNoSack:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetNoSack(ANoSack:Boolean);</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>property MaxSeg:Word read FMaxSeg write SetMaxSeg;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property WindowScale:Byte read FWindowScale write SetWindowScale;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>property Options:Pointer read GetOptions;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property NoDelay:Boolean read GetNoDelay write SetNoDelay;</code>
+
−
| Determines if we Delay small segments until previous sends are ACKed
+
−
|-
+
−
| <code>property NoPush:Boolean read GetNoPush write SetNoPush;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property NoOpt:Boolean read GetNoOpt write SetNoOpt;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property BsdUrgent:Boolean read GetBsdUrgent write SetBsdUrgent;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property NoSack:Boolean read GetNoSack write SetNoSack;</code>
+
−
| Determines if we send SACKOK to Remote
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
'''TCP send buffer'''
+
−
 
+
−
<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>
+
| [[TTCPSendBuffer|<code>TTCPSendBuffer = class(TSocketBuffer)</code>]]
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
| <code>destructor Destroy; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|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"|&nbsp;
+
−
|-
+
−
| <code>function AddSegment(ASequence:LongWord; AFlags:Byte; ASize:Word):PTCPSegment;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function RemoveSegment(ASegment:PTCPSegment):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure FlushSegments(All:Boolean);</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
+
−
|-
+
−
| <code>procedure SetSize(ASize:LongWord); override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|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"|&nbsp;
+
−
|-
+
−
| <code>UrgentPointer:LongWord;</code>
+
−
| (SND.UP)
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>MaxSeg:Word;</code>
+
−
| Remote Max Segment Size (Learned from Remote)
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <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"|&nbsp;
+
−
|-
+
−
| <code>CongestionWindow:Word;</code>
+
−
| Slow Start Window Size
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>SynSequence:LongWord;</code>
+
−
| Sequence number of our SYN
+
−
|-
+
−
| <code>FinSequence:LongWord;</code>
+
−
| Sequence number of our FIN
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <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"|&nbsp;
+
−
|-
+
−
| <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"|&nbsp;
+
−
|-
+
−
| <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"|&nbsp;
+
−
|-
+
−
| <code>function CheckIdle:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function SynAcknowledged:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function FinAcknowledged:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function TestAcknowledge(AAcknowledge:LongWord):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function CheckAcknowledge(AAcknowledge:LongWord):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function ValidateAcknowledge(AAcknowledge:LongWord):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function WriteData(var ABuffer; ASize,AFlags:Integer):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function Finish:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function Synchronize:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function ReadSegment(var ASequence:LongWord; var AUrgent:Word; var AFlags:Byte; var AData:Pointer; var ASize:Word; AForce:Boolean):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function AcknowledgeSegments(ASequence,AAcknowledge:LongWord; AWindow:Word):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function TimestampSegment(AOptions:Pointer; var AOffset:Word):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function SelectiveAckSegments(AOptions:Pointer; var AOffset:Word; ASize:Byte):Boolean;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
'''TCP receive buffer'''
+
−
 
+
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
−
 
+
−
<code>TTCPRecvBuffer = 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%;"|&nbsp;
+
−
|-
+
−
| <code>destructor Destroy; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
| <code>FUrgent:LongWord;</code>
+
−
| Number of OOB bytes readable from Buffer
+
−
|-
+
−
| <code>FAvailable:LongWord;</code>
+
−
| Number of bytes readable from Buffer
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FFirst:PTCPSegment;</code>
+
−
| Pointer to First Segment
+
−
|-
+
−
| <code>FLast:PTCPSegment;</code>
+
−
| Pointer to Last Segment
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function DelayOverride(ASegment:PTCPSegment):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function GetSegment(ASequence:LongWord; ALength:Word):PTCPSegment;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetPrevious(ASequence:LongWord; ALength:Word):PTCPSegment;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetOverlapped(ASequence:LongWord; ALength:Word):PTCPSegment;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function AddSegment(APrev:PTCPSegment; ASequence:LongWord; AFlags:Byte; ASize:Word):PTCPSegment;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function RemoveSegment(ASegment:PTCPSegment):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure FlushSegments(All:Boolean);</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
+
−
|-
+
−
| <code>procedure SetSize(ASize:LongWord); override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>StartSequence:LongWord;</code>
+
−
| Initial Sequence number of Remote (IRS)
+
−
|-
+
−
| <code>NextSequence:LongWord;</code>
+
−
| Next Sequence number to Receive (RCV.NXT)
+
−
|-
+
−
| <code>LastSequence:LongWord;</code>
+
−
| Last Sequence number in Buffer (Including Unacknowledged data)
+
−
|-
+
−
| <code>LastAcknowledge:LongWord;</code>
+
−
| Last Acknowledged number to Remote
+
−
Note: NextSequence is the next byte we expect to Receive from Remote. LastAcknowledge will be the first Unacknowledged Seqeunce number of the Remote. LastSequence is the last sequence we have received from the Remote. If NextSequence equals LastSequence and LastAcknowledge equals NextSequence all segments have been Acknowledged.
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>UrgentPointer:LongWord;</code>
+
−
| (RCV.UP)
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>MaxSeg:Word;</code>
+
−
| Local Max Segment Size
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>WindowSize:LongWord;</code>
+
−
| Local Window Size (RCV.WND)
+
−
|-
+
−
| <code>WindowScale:Byte;</code>
+
−
| Local Window Scale
+
−
|-
+
−
| <code>LastWindow:LongWord;</code>
+
−
| Last Window value sent to Remote
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>SynSequence:LongWord;</code>
+
−
| Sequence number of remote SYN
+
−
|-
+
−
| <code>FinSequence:LongWord;</code>
+
−
| Sequence number of remote FIN
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>NoSack:Boolean;</code>
+
−
| Selective Ack not in use
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function CheckIdle:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function GetUrgent:LongWord;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetAvailable:LongWord;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function SynReceived:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function FinReceived:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function CheckSequence(ASequence:LongWord; ASize:Word):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function ReadData(var ABuffer; var ASize:Integer; AFlags:Integer):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function WriteSegment(ASequence:LongWord; AUrgent:Word; AFlags:Byte; AData:Pointer; ASize:Word):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function AcknowledgeSegments(var AAcknowledge:LongWord; var AWindow:Word; AForce:Boolean):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function TimestampSegment(AOptions:Pointer; var AOffset:Word):Boolean;</code>
+
−
| &nbsp;
+
 
|-
 
|-
−
| <code>function SelectiveAckSegments(AOptions:Pointer; var AOffset:Word):Boolean;</code>
+
| [[TTCPRecvBuffer|<code>TTCPRecvBuffer = class(TSocketBuffer)</code>]]
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div> 
 
 
<br />
 
<br />
  

Latest revision as of 01:38, 30 May 2018

Return to Unit Reference


Description

Ultibo TCP (Transmission Control Protocol) unit

Notes:

Segment handling:

Send adds new segments to the end of the list only accepts ACKs for whole segments.

Recv adds/inserts segments in correct SEQ order accepts overlapping segments only sends ACKs for whole segments.

Send will coalesce small data writes into larger segments if options allow this.

Recv will store the segments exactly as received.


TCP Send and Recv do not use a block buffer as per UDP etc. Instead the data for each Segment is stored in memory (TCP_MAX_MSS) allocated with the Segment. The Free and Used values still track the amount of data in the buffer but this method allows OOB data to be handled correctly.

TCP Sequence numbers are compared using modulo 2^32 arithmetic. The following calculations provide the necessary handling of wraparound etc.

LT = (A - B) < 0

LEQ = (A - B) <= 0

GT = (A - B) > 0

GEQ = (A - B) >= 0


See GlobalSock.pas for actual functions that implement this.

Constants


[Expand]
TCP specific constants TCP_*


[Expand]
TCP socket state TCP_STATE_*


[Expand]
TCP header option TCPOPT_*


[Expand]
TCP header flag TCP_FLAG_*


[Expand]
TCP port TCP_PORT_*


Type definitions


TCP header

[Expand]

PTCPHeader = ^TTCPHeader;

TTCPHeader = packed record

TCP segment

[Expand]

PTCPSegment = ^TTCPSegment;

TTCPSegment = record


Class definitions


TCP specific classes

TTCPProtocolTransport = class(TProtocolTransport)
TTCPProtocol = class(TNetworkProtocol)
TTCPSocket = class(TProtocolSocket)
TTCPState = class(TProtocolState)
TTCPOptions = class(TProtocolOptions)
TTCPSendBuffer = class(TSocketBuffer)
TTCPRecvBuffer = class(TSocketBuffer)


Public variables

None defined

Function declarations


Initialization functions

[Expand] 
procedure TCPInit;
Description: To be documented


TCP functions

[Expand] 
function CheckTCP(AFamily:Word; ABuffer:Pointer):Boolean;
Description: Verify that the packet is a valid TCP packet


[Expand] 
function GetTCPHeaderOffset(AFamily:Word; ABuffer:Pointer):Word;
Description: To be documented


[Expand] 
function GetTCPHeaderLength(AFamily:Word; ABuffer:Pointer):Word;
Description: To be documented


[Expand] 
function GetTCPOptionsLength(AFamily:Word; ABuffer:Pointer):Word;
Description: To be documented


[Expand] 
function GetTCPDataOffset(AFamily:Word; ABuffer:Pointer):Word;
Description: To be documented


[Expand] 
function GetTCPDataLength(AFamily:Word; ABuffer:Pointer):Word;
Description: To be documented


[Expand] 
function ChecksumTCPRecv(AFamily:Word; APseudo:PIPPseudo; ABuffer:Pointer; AOffset,ALength:Word):Word;
Description: Validate the Checksum of TCP Pseudo, Header and Data on Receive


[Expand] 
function ChecksumTCPSend(AFamily:Word; APseudo:PIPPseudo; AHeader:PTCPHeader; AOptions,AData:Pointer; AOptionsLength,ADataLength:Word):Word;
Description: Checksum the TCP Pseudo, Header, Options and Data on Send


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=Unit_TCP&oldid=4333"