Layer5.Dhcpv6.SessionInfo Class Reference

Class containing the info about the DHCPSession. More...

Methods
	Advertise.Timestamp.Last.Get
	Returns the timestamp when the last DHCP Advertise message is received. More...
	Description.Get
	Returns a textual description of the object.
	Parent.Get
	Returns the parent object.
	Refresh.Timestamp.Get
	Returns the timestamp when the results are last retrieved from the server. More...
	Refresh
	Refresh the info. More...
	Reply.Timestamp.Last.Get
	Returns the timestamp when the last DHCP Reply message is received. More...
	Request.Timestamp.Last.Get
	Returns the timestamp when the last DHCP Request message is sent. More...
	Rx.Get
	Returns the number of DHCPMessages recieved. More...
	Solicit.Timestamp.Last.Get
	Returns the timestamp when the last DHCP Solicit message is sent. More...
	Tx.Get
	Returns the number of DHCPMessages transmitted. More...

Class overview

Class containing the info about the DHCPSession.

This class represents the session info gathered from a DHCPv6Session. It will contain counters of the amount of DHCPMesseage transmitted and received.

Definition at line 11169 of file api.tcl.

Method documentation

Layer5.Dhcpv6.SessionInfo::Advertise.Timestamp.Last.Get

Returns the timestamp when the last DHCP Advertise message is received.

Returns

Timestamp in nanoseconds since epoch

Example

set DHCPSessionInfo [ $DHCPSession Session.Info.Get ]

Returns:

<Layer5::Dhcpv6::SessionInfo object> 

Get the timestamp when the last ADVERTISE message is received.

$DHCPSessionInfo Advertise.Timestamp.Last.Get

Returns:

1576744318605049012 

Definition at line 11181 of file api.tcl.

Layer5.Dhcpv6.SessionInfo::Refresh

Refresh the info.

Only when executing this method the counters are updated

Example

set DHCPSessionInfo [ $DHCPSession Session.Info.Get ]

Returns:

<Layer5::Dhcpv6::SessionInfo object> 

Get the number of DHCPMessage received

$DHCPSessionInfo Refresh

Definition at line 11215 of file api.tcl.

Layer5.Dhcpv6.SessionInfo::Refresh.Timestamp.Get

Returns the timestamp when the results are last retrieved from the server.

Returns

Timestamp in nanoseconds since epoch

Example

set DHCPSessionInfo [ $DHCPSession Session.Info.Get ]

Returns:

<Layer5::Dhcpv6::SessionInfo object> 

$DHCPSessionInfo Refresh.Timestamp.Get

Returns:

1576744318605049012 

Definition at line 11203 of file api.tcl.

Layer5.Dhcpv6.SessionInfo::Reply.Timestamp.Last.Get

Returns the timestamp when the last DHCP Reply message is received.

Returns

Timestamp in nanoseconds since epoch

Example

set DHCPSessionInfo [ $DHCPSession Session.Info.Get ]

Returns:

<Layer5::Dhcpv6::SessionInfo object> 

Get the timestamp when the last REPLY message is received.

$DHCPSessionInfo Reply.Timestamp.Last.Get

Returns:

1576744318605049012 

Definition at line 11227 of file api.tcl.

Layer5.Dhcpv6.SessionInfo::Request.Timestamp.Last.Get

Returns the timestamp when the last DHCP Request message is sent.

Returns

Timestamp in nanoseconds since epoch

Example

set DHCPSessionInfo [ $DHCPSession Session.Info.Get ]

Returns:

<Layer5::Dhcpv6::SessionInfo object> 

Get the timestamp when the last REQUEST message is sent.

$DHCPSessionInfo Request.Timestamp.Last.Get

Returns:

1576744318605049012 

Definition at line 11239 of file api.tcl.

Layer5.Dhcpv6.SessionInfo::Rx.Get

Returns the number of DHCPMessages recieved.

Returns

Number of DHCPMessages received

Example

set DHCPSessionInfo [ $DHCPSession Session.Info.Get ]

Returns:

<Layer5::Dhcpv6::SessionInfo object> 

Get the number of DHCPMessage received

$DHCPSessionInfo Rx.Get

Returns:

2 

Definition at line 11251 of file api.tcl.

Layer5.Dhcpv6.SessionInfo::Solicit.Timestamp.Last.Get

Returns the timestamp when the last DHCP Solicit message is sent.

Returns

Timestamp in nanoseconds since epoch

Example

set DHCPSessionInfo [ $DHCPSession Session.Info.Get ]

Returns:

<Layer5::Dhcpv6::SessionInfo object> 

Get the timestamp when the last SOLICIT message is sent.

$DHCPSessionInfo Solicit.Timestamp.Last.Get

Returns:

1576744318605049012 

Definition at line 11263 of file api.tcl.

Layer5.Dhcpv6.SessionInfo::Tx.Get

Returns the number of DHCPMessages transmitted.

Returns

Number of DHCPMessages transmitted

Example

set DHCPSessionInfo [ $DHCPSession Session.Info.Get ]

Returns:

<Layer5::Dhcpv6::SessionInfo object> 

Get the number of DHCPMessage received

$DHCPSessionInfo Tx.Get

Returns:

2 

Definition at line 11275 of file api.tcl.