Network info monitor result history. More...

Methods
	Clear
	Clear the history. More...

	Description.Get
	Returns a textual description of the object.

	Interval.Get
	Returns a list of available interval results. More...

	Interval.GetByIndex index
	Returns a single item of the interval list. More...

	Interval.GetByTime timestamp
	Returns a single item of the interval list using a timestamp in nanoseconds. More...

	Interval.Latest.Get
	Returns the latest closed item of the interval list. More...

	Interval.Length.Get
	Returns the size of the interval list. More...

	Parent.Get
	Returns the parent object.

	Refresh.Timestamp.Get
	Returns the timestamp on the server when the current history was refreshed. More...

	Refresh
	Updates the Interval results with the results available on the server. More...

	Sampling.Interval.Duration.Get
	Duration of one sampling interval in nanoseconds. More...

	Sampling.Interval.Duration.Set
	Sets the duration of one sampling interval. More...

Class overview

Network info monitor result history.

The history contains the network info in time since the object is created or refreshed.

Note: The information is not updated until Refresh is called

A WirelessEndoint.NetworkInfoMonitor history result object can be created via a WirelessEndpoint.NetworkInfoMonitor, using WirelessEndpoint.NetworkInfoMonitor::Result.History.Get

Since: 2.11.0

Example

 set monitor [ $deviceInfo Network.Info.Monitor.Add ]  
  set history [ $monitor Result.History.Get ]  
  $history Refresh

Definition at line 25025 of file api.tcl.

Method documentation

WirelessEndpoint.NetworkInfoMonitor.ResultHistory::Clear

Clear the history.

With each Refresh interval and cumulative counters are transferred from Server to the Client. To remove all counter-objects in this history, you can execute this method. Both Interval and Cumulative counter lists will be cleared.

Example

Clear the History.

1 $historyObject Clear

Definition at line 25037 of file api.tcl.

WirelessEndpoint.NetworkInfoMonitor.ResultHistory::Interval.Get

Returns a list of available interval results.

Each result object contains interval counters at a certain point in time. Snapshots are taken at fixed time intervals. The interval duration can be obtained using Sampling.Interval.Duration.Get.

Returns: List of WirelessEndpoint.NetworkInfoMonitor.ResultData containing the Interval counters

Example

This example gets the available interval results

1 $historyObject Interval.Get

Returns:

[ <WirelessEndpoint.NetworkInfoMonitor.ResultData object> ... ]

Definition at line 25056 of file api.tcl.

WirelessEndpoint.NetworkInfoMonitor.ResultHistory::Interval.GetByIndex			index

Returns a single item of the interval list.

Parameters

index

Returns: WirelessEndpoint.NetworkInfoMonitor.ResultData interval counter object at the specified index

Example

This example gets the available interval counters at index 1

1 $historyObject Interval.GetByIndex 1

Returns:

<WirelessEndpoint.NetworkInfoMonitor.ResultData object>

Definition at line 25070 of file api.tcl.

WirelessEndpoint.NetworkInfoMonitor.ResultHistory::Interval.GetByTime			timestamp

Returns a single item of the interval list using a timestamp in nanoseconds.

Parameters

timestamp in nanoseconds

Returns: WirelessEndpoint.NetworkInfoMonitor.ResultData

Since: API 2.11.0

Example

This example gets the Interval counters at timestamp 1432805398000000000 ns

1 $historyObject Cumulative.GetByTime 1432805398000000000

Returns:

<WirelessEndpoint.NetworkInfoMonitor.ResultData object>

Example

This example gets the cumulative counter at timestamp 1432805398 seconds

1 $historyObject Cumulative.GetByTime 1432805398s

Returns:

<WirelessEndpoint.NetworkInfoMonitor.ResultData object>

Definition at line 25090 of file api.tcl.

WirelessEndpoint.NetworkInfoMonitor.ResultHistory::Interval.Latest.Get

Returns the latest closed item of the interval list.

Returns: WirelessEndpoint.NetworkInfoMonitor.ResultData

Since: API 2.11.0

Example

This example gets the latest closed Interval counter object

1 $historyObject Interval.Latest.Get

Returns:

<WirelessEndpoint.NetworkInfoMonitor.ResultData object>

Definition at line 25104 of file api.tcl.

WirelessEndpoint.NetworkInfoMonitor.ResultHistory::Interval.Length.Get

Returns the size of the interval list.

Returns: The length of the interval list

Example

1 $historyObject Interval.Length.Get

Returns:

Definition at line 25116 of file api.tcl.

WirelessEndpoint.NetworkInfoMonitor.ResultHistory::Refresh

Updates the Interval results with the results available on the server.

Example

This example refreshes the history results with the results available on the server

1 $historyObject Refresh

Definition at line 25145 of file api.tcl.

WirelessEndpoint.NetworkInfoMonitor.ResultHistory::Refresh.Timestamp.Get

Returns the timestamp on the server when the current history was refreshed.

This is the timestamp on the server when the last Refresh was called.

Returns: Timestamp in nanoseconds since epoch

Example

This example gets the Refresh timestamp

1 $historyObject Refresh.Timestamp.Get

Returns:

1432805398000000000

Definition at line 25135 of file api.tcl.

WirelessEndpoint.NetworkInfoMonitor.ResultHistory::Sampling.Interval.Duration.Get

Duration of one sampling interval in nanoseconds.

Returns: Duration in nanoseconds

Example

1 $historyObject Sampling.Interval.Duration.Get

Returns:

1000000000

Definition at line 25157 of file api.tcl.

WirelessEndpoint.NetworkInfoMonitor.ResultHistory::Sampling.Interval.Duration.Set

Sets the duration of one sampling interval.

Note: WARNING: The previously collected history will be invalidated.

Since: 2.11.0

Example

1 $historyObject Sampling.Interval.Duration.Set 1000000000

Example

1 $historyObject Sampling.Interval.Duration.Set 1s

Definition at line 25173 of file api.tcl.

Methods

Class overview

Method documentation