Internet Control Message Protocol


CLASS aprICMP

 

The Internet Control Message Protocol library sends ICMP echo datagrams to a remote host to determine if that host is reachable over the network. Primarily used through PING and TraceRt applications

 

 

Variables

 

Cancelled

Indicates whether or not the last operation was cancelled.

 

cErr

Holds a description for the Last error code

 

Debug

Enable/Disable extended Debug notifications.

 

DebugTrace

Enable/Disable Callstack List to be included in Error Messages (:Debug)

 

LastAddress

Last IP Address Searched For

 

LastName

Last HostName Searched For

 

nErr

Holds the last error code

 

Session

Holds the Initial Session ID value (used as the Default Session ID)

 

Methods

 

New

Creates a new instance of the aprICMP Class

 

Destroy

Terminate use of the library by the calling process

 

 

Cancel

Cancel the current blocking operation

 

Close

Close the current client session

 

GetHostAddress

Return the current host IP address

 

GetHostName

Return the current host name

 

GetRecvCount

Return the number of packets received

 

GetSendCount

Return the number of packets sent

 

GetSocket

Return the client socket handle

 

GetTripTime

Return the current trip time statistics

 

IsBlocking

Determine if the client is blocked, waiting for information

 

Open

Open a new client session

 

OpenEx

Open a new client session

 

PacketSize

Get/Set the ICMP datagram packet size

 

RecvEcho

Read an ICMP datagram returned by the remote host

 

Reset

Reset the current client state

 

SendEcho

Send an ICMP datagram to the specified host

 

SequenceID

Get/Set the sequence identifier for the next datagram

 

SetHostAddress

Set the IP address of the host to receive the next datagram

 

SetHostName

Set the name of the host to receive the next datagram

 

SetLastError

Set the last error code

 

TimeOut

Get/Set the number of milliseconds until an operation times out

 

TimeToLive

Get/Set the time-to-live for the next datagram

 

Trace

Enable/Disable logging of socket-level calls to a file

 

TTL

Get/Set the time-to-live for the next datagram (Pass through to TimeToLive)