class PICMPSocket

Create a socket channel that uses allows ICMP commands in the Internal Protocol

Inheritance:


Public Methods

[more] Construction
[more] Ping

Public Members

[more] Status & Information


Inherited from PIPDatagramSocket:

Public Methods

ovirtual BOOL ReadFrom( void* buf, PINDEX len, Address & addr, WORD & port )
ovirtual BOOL WriteTo( const void* buf, PINDEX len, const Address & addr, WORD port )


Inherited from PIPSocket:

Public Methods

ovirtual PString GetName() const
ovirtual BOOL Connect( const PString & address )
ovirtual BOOL Listen( unsigned queueSize = 5, WORD port = 0, Reusability reuse = AddressIsExclusive )
ostatic PString GetHostName()
ostatic BOOL GetHostAddress( Address & addr )
ostatic PStringArray GetHostAliases( const PString & hostname )
ostatic BOOL IsLocalHost( const PString & hostname )
ovirtual BOOL GetLocalAddress( Address & addr )
ovirtual BOOL GetPeerAddress( Address & addr )
oPString GetLocalHostName()
oPString GetPeerHostName()
ostatic void ClearNameCache()
ostatic BOOL GetGatewayAddress( Address & addr )
ostatic PString GetGatewayInterface()
ostatic BOOL GetRouteTable( RouteTable & table )
ostatic BOOL GetInterfaceTable( InterfaceTable & table )

Public Members

class Address: public PObject
A class describing an IP address
class RouteEntry: public PObject
Describes a route table entry
class InterfaceEntry: public PObject
Describes an interface table entry


Inherited from PSocket:

Public Methods

Socket establishment functions

Socket options functions

Port/Service database functions

Integer conversion functions

Public Members

Multiple socket selection functions

Protected Fields

oWORD port

Protected Methods

ovirtual const char* GetProtocolName() const


Inherited from PChannel:

Public Methods

Overrides from class PObject

Information functions

Reading functions

Writing functions

Miscellaneous functions

ostatic BOOL ConvertOSError( int libcReturnValue, Errors & lastError, int & osError )

Public Members

Error functions

Protected Fields

oint os_handle
oErrors lastErrorCode[NumErrorGroups+1]
oint lastErrorNumber[NumErrorGroups+1]
oPINDEX lastReadCount
oPINDEX lastWriteCount
oPTimeInterval readTimeout
oPTimeInterval writeTimeout

Protected Methods

ovirtual BOOL ConvertOSError( int libcReturnValue, ErrorGroup group = LastGeneralError )
oBOOL SetErrorValues( Errors errorCode, int osError, ErrorGroup group = LastGeneralError )
oint ReadCharWithTimeout( PTimeInterval & timeout )


Inherited from PObject:

Public Methods

Run Time Type functions

I/O functions

Public Members

Comparison functions


Documentation

Create a socket channel that uses allows ICMP commands in the Internal Protocol
o Construction

o PICMPSocket()
Create a TCP/IP protocol socket channel. If a remote machine address or a "listening" socket is specified then the channel is also opened.

o Status & Information

oenum PingStatus
Results of ICMP operation

oclass PingInfo
Information used by and obtained by the ping operation

o PingInfo(WORD id = (WORD)PProcess::Current().GetProcessID())
Create Ping information structure

o Supplied data

oWORD identifier
Arbitrary identifier for the ping

oWORD sequenceNum
Sequence number for ping packet

oBYTE ttl
Time To Live for packet

oconst BYTE* buffer
Send buffer (if NULL, defaults to 32 bytes)

oPINDEX bufferSize
Size of buffer (< 64k)

o Returned data

oPTimeInterval delay
Time for packet to make trip

oAddress remoteAddr
Source address of reply packet

oAddress localAddr
Destination address of reply packet

oPingStatus status
Status of the last ping operation

o Ping

oBOOL Ping( const PString & host )
Send an ECHO_REPLY message to the specified host and wait for a reply to be sent back.

Parameters:
host - Host to send ping.
Returns:
FALSE if host not found or no response.

oBOOL Ping( const PString & host, PingInfo & info )
Send an ECHO_REPLY message to the specified host and wait for a reply to be sent back.

Parameters:
host - Host to send ping.
info - Information on the ping and reply.
Returns:
FALSE if host not found or no response.


This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java



This page was generated with the help of DOC++.