All Classes Namespaces Files Functions Pages
Layer3.IcmpProtocol Class Reference

The ICMP protocol is attached to the IPv4 protocol and allows the host to start ICMP sessions, through which it can communicate with the Layer3 IP network. More...

Methods

 Description.Get
 Returns a textual description of the object.
 
 Destructor
 
 Parent.Get
 Returns the parent object.
 
 Session.Add applicationId
 Creates an ICMP Echo Session, through which this host can query the Layer3 IP network. More...
 
 Session.Get
 Returns the active list of ICMP Echo Sessions. More...
 

Class overview

The ICMP protocol is attached to the IPv4 protocol and allows the host to start ICMP sessions, through which it can communicate with the Layer3 IP network.

Definition at line 7043 of file api.tcl.

Method documentation

Layer3.IcmpProtocol::Destructor
Warning
This object cannot be destroyed. An exception will be thrown when this method is called.

Definition at line 7054 of file api.tcl.

Layer3.IcmpProtocol::Session.Add   applicationId  

Creates an ICMP Echo Session, through which this host can query the Layer3 IP network.

See Layer3.IcmpEchoSession for more information.

When an external tool connects to the ByteBlowerPort with an ICMP session (e.g. ping), that session will not be listed in Session.Get. If you want such sessions to be listed there, you will need to call Session.Add given the applicationId that is used by the external tool.

Parameters
applicationIdProvide an application id for this session. This should be unique across the host. If none is given, a random value is generated.
Default: Random generate number
Returns
The created echo session is immediately returned. This is a Layer3.IcmpEchoSession object.
Example

This example creates an Echo session with a random application ID and returns this new object.

1 $icmp Session.Add

Returns:

<Layer3.IcmpEchoSession object> 

This example creates an Echo session with a specific application ID and returns this new object. E.g. when ping uses application Id 7

1 $icmp Session.Add 7

Returns:

<Layer3.IcmpEchoSession object> 

Definition at line 7077 of file api.tcl.

Layer3.IcmpProtocol::Session.Get

Returns the active list of ICMP Echo Sessions.

Note
The ICMP Protocol may have more active sessions at server-side than listed here. This list only returns the Layer3.IcmpEchoSession objects for which a handle has been created at client-side. See below for more information.

When an external tool connects to the ByteBlowerPort with an ICMP session (e.g. ping), that session will not be listed here. If you want such sessions to be listed here, you will need to call Session.Add given the applicationId that is used by the external tool.

Returns
A list of created Layer3.IcmpEchoSession objects is returned. An empty list (i.e. empty string) is returned if no such sessions were added.
Example
1 $icmp Session.Get

Returns:

[ <Layer3.IcmpEchoSession object> ... ] 

Definition at line 7093 of file api.tcl.