All Classes Namespaces Files Functions Pages
Layer3.Icmpv6Protocol Class Reference

ICMPv6 Protocol. More...

Methods

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

Class overview

ICMPv6 Protocol.

Every Layer3.IPv6 has a Layer3.Icmpv6Protocol attached. With this class you can create a Layer3.Icmpv6EchoSession to send Echo Requests

Definition at line 7580 of file api.tcl.

Method documentation

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

Definition at line 7591 of file api.tcl.

Layer3.Icmpv6Protocol::Session.Add   applicationId  

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

See Layer3.Icmpv6EchoSession for more information.

When an external tool connects to the ByteBlowerPort with an ICMPv6 session (e.g. ping6), 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 ICMPv6 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.Icmpv6EchoSession object.
Example

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

1 $icmpv6 Session.Add

Returns:

<Layer3.Icmpv6EchoSession object> 

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

1 $icmpv6 Session.Add 7

Returns:

<Layer3.Icmpv6EchoSession object> 

Definition at line 7614 of file api.tcl.

Layer3.Icmpv6Protocol::Session.Get

Returns the active list of ICMPv6 Echo Sessions.

Note
The ICMPv6 Protocol may have more active sessions at server-side than listed here. This list only returns the Layer3.Icmpv6EchoSession 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 ICMPv6 session (e.g. ping6), 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.Icmpv6EchoSession objects is returned. An empty list (i.e. empty string) is returned if no such sessions were added.
Example
1 $icmpv6 Session.Get

Returns:

[ <Layer3.Icmpv6EchoSession object> ... ] 

Definition at line 7630 of file api.tcl.