Difference between revisions of "Unit ICMP"

From Ultibo.org
Jump to: navigation, search
Line 533: Line 533:
 
----
 
----
  
−
''To be documented''
+
 
 +
'''ICMP protocol transport'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TICMPProtocolTransport = 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;">'''public'''</div>
 +
|-
 +
| <code>Socket:TICMPSocket;</code>
 +
| Socket for sending replies
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''ICMP protocol'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TICMPProtocol = 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>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>destructor Destroy; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
 +
|-
 +
| <code>FNextICMPId:Word;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FNextICMPLock:TMutexHandle;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function PacketHandler(AHandle:THandle; ASource,ADest,APacket:Pointer; ASize:Integer; ABroadcast:Boolean):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function ControlHandler(AHandle:THandle; ASource,ADest:Pointer; AProtocol,ACommand,ACode:Word; AAddress,AData:Pointer; ASize:Integer):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetNextICMPId(AIncrement:Boolean):Word;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function SendICMPUnreach(ASocket:TICMPSocket; ASource,ADest:Pointer; ACode:Byte; AData:Pointer; ASize:Integer):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function SendICMPRedirect(ASocket:TICMPSocket; ASource,ADest:Pointer; ACode:Byte; AAddress,AData:Pointer; ASize:Integer):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function SendICMPTimeExceeded(ASocket:TICMPSocket; ASource,ADest:Pointer; ACode:Byte; AData:Pointer; ASize:Integer):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function SendICMPSourceQuench(ASocket:TICMPSocket; ASource,ADest:Pointer; AData:Pointer; ASize:Integer):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function SendICMPParamProblem(ASocket:TICMPSocket; ASource,ADest:Pointer; ACode,APointer:Byte; AData:Pointer; ASize:Integer):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function SendICMPEchoReply(ASocket:TICMPSocket; ASource,ADest,AData:Pointer; ASize:Integer):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function SendICMPInfoReply(ASocket:TICMPSocket; ASource,ADest,AData:Pointer; ASize:Integer):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function SendICMPMaskReply(ASocket:TICMPSocket; ASource,ADest,AData:Pointer; ASize:Integer):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function SendICMPTimestampReply(ASocket:TICMPSocket; ASource,ADest,AData:Pointer; ASize:Integer):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function SendICMPEchoRequest(ASocket:TICMPSocket ;ASource,ADest:Pointer; ASize:Integer):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function SendICMPInfoRequest(ASocket:TICMPSocket; ASource,ADest:Pointer):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function SendICMPMaskRequest(ASocket:TICMPSocket; ASource,ADest:Pointer):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function SendICMPTimestampRequest(ASocket:TICMPSocket; ASource,ADest:Pointer):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function SendICMPRouterAdvert(ASocket:TICMPSocket; ASource,ADest,AAddress:Pointer):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function SendICMPRouterSolicit(ASocket:TICMPSocket; ASource,ADest:Pointer):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
 +
|-
 +
| <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;</code>
 +
| &nbsp;
 +
|-
 +
| <code>AState:LongWord):TProtocolSocket; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure FlushSockets(All:Boolean); override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function SelectCheck(ASource,ADest:PFDSet; ACode:Integer):Integer; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function SendPacket(ASocket:TProtocolSocket; ASource,ADest:Pointer; ASourcePort,ADestPort:Word; APacket:PPacketFragment; ASize,AFlags:Integer):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 StartProtocol:Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function StopProtocol:Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function ProcessProtocol:Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''ICMP socket'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TICMPSocket = 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_RAW
 +
|-
 +
|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>FRecvData:TICMPBuffer;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>property RecvData:TICMPBuffer read FRecvData;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&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;
 +
|-
 +
|}
 +
</div></div> 
 +
 
 +
'''ICMP buffer'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TICMPBuffer = 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>FOffset:Word;</code>
 +
| Offset to RemoteAddress
 +
|-
 +
| <code>FLength:Word;</code>
 +
| Length of RemoteAddress
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>FRead:Pointer;</code>
 +
| Pointer to Next Read from Buffer
 +
|-
 +
| <code>FWrite:Pointer;</code>
 +
| Pointer to Next Write to Buffer
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>FCount:LongWord;</code>
 +
| Number of Packets in Buffer
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>FFirst:PICMPPacket;</code>
 +
| Pointer to First Packet
 +
|-
 +
| <code>FLast:PICMPPacket;</code>
 +
| Pointer to Last Packet
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function AddPacket(ASize:Integer):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemovePacket:Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure FlushPackets;</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>function GetNext:Integer;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetCount:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function ReadBuffer(var ABuffer; var ASize:Integer; ARemoteAddress:Pointer; AFlags:Integer):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function WriteBuffer(var ABuffer; ASize:Integer; ARemoteAddress:Pointer):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div> 
 +
<br />
  
 
=== Public variables ===
 
=== Public variables ===

Revision as of 00:26, 15 March 2017

Return to Unit Reference


Description

Ultibo ICMP (Internet Control Message Protocol) unit

To be documented

Constants


[Expand]
ICMP specific constants ICMP_PROTOCOL_*


[Expand]
ICMP constants ICMP_*


Type definitions


ICMP unused header

[Expand]

PICMPUnusedHeader = ^TICMPUnusedHeader;

TICMPUnusedHeader = packed record {Unreachable, TimeExceeded, SourceQuench etc}

ICMP unreach header

[Expand]

PICMPUnreachHeader = ^TICMPUnreachHeader;

TICMPUnreachHeader = TICMPUnusedHeader;

ICMP expire header

[Expand]

PICMPExpireHeader = ^TICMPExpireHeader;

TICMPExpireHeader = TICMPUnusedHeader;

ICMP quench header

[Expand]

PICMPQuenchHeader = ^TICMPQuenchHeader;

TICMPQuenchHeader = TICMPUnusedHeader;

ICMP pointer header

[Expand]

PICMPPointerHeader = ^TICMPPointerHeader;

TICMPPointerHeader = packed record

ICMP param header

[Expand]

PICMPParamHeader = ^TICMPParamHeader;

TICMPParamHeader = TICMPPointerHeader;

ICMP Ip header

[Expand]

PICMPIpHeader = ^TICMPIpHeader;

TICMPIpHeader = packed record

ICMP redirect header

[Expand]

PICMPRedirectHeader = ^TICMPRedirectHeader;

TICMPRedirectHeader = TICMPIpHeader

ICMP echo header

[Expand]

PICMPEchoHeader = ^TICMPEchoHeader;

TICMPEchoHeader = packed record

ICMP time stamp header

[Expand]

PICMPTimestampHeader = ^TICMPTimestampHeader;

TICMPTimestampHeader = packed record

ICMP info header

[Expand]

PICMPInfoHeader = ^TICMPInfoHeader;

TICMPInfoHeader = packed record

ICMP mask header

[Expand]

PICMPMaskHeader = ^TICMPMaskHeader;

TICMPMaskHeader = packed record

ICMP router address

[Expand]

PICMPRouterAddress = ^TICMPRouterAddress;

TICMPRouterAddress = packed record

ICMP advert header

[Expand]

PICMPAdvertHeader = ^TICMPAdvertHeader;

TICMPAdvertHeader = packed record

ICMP solicit header

[Expand]

PICMPSolicitHeader = ^TICMPSolicitHeader;

TICMPSolicitHeader = packed record

ICMP header

[Expand]

PICMPHeader = ^TICMPHeader;

TICMPHeader = packed record

ICMP packet

[Expand]

PICMPPacket = ^TICMPPacket;

TICMPPacket = record


Class definitions


ICMP protocol transport

[Expand]

TICMPProtocolTransport = class(TProtocolTransport)

ICMP protocol

[Expand]

TICMPProtocol = class(TNetworkProtocol)

ICMP socket

[Expand]

TICMPSocket = class(TProtocolSocket)

ICMP buffer

[Expand]

TICMPBuffer = class(TSocketBuffer)


Public variables

None defined

Function declarations


Initialization functions

[Expand] 
procedure ICMPInit;
Description: To be documented


ICMP functions

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


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


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


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


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


[Expand] 
function ChecksumICMP(AFamily:Word; ABuffer:Pointer; AOffset,ALength:Word):Word;
Description: Checksum the ICMP Header on Send / Validate the Checksum on Receive


Return to Unit Reference

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