Broadband Forum

    DATA MODEL DEFINITION


STBService:1.3 Service Object definition
tr-135-1-3-0.xml (changes)

License

Copyright (c) 2009-2017, Broadband Forum

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The above license is used as a license under copyright only. Please reference the Forum IPR Policy for patent licensing terms <https://www.broadband-forum.org/ipr-policy>.

Any moral rights which are necessary to exercise under the above license grant are also deemed granted under this license.

Summary

STBService:1.3 Service Object.

Adds loss event histograms in statistics.

Table of Contents

Data Types

The Parameters defined in this specification make use of a limited subset of the default SOAP data types [SOAP1.1]. These data types and the named data types used by this specification are described below.

Note: A Parameter that is defined to be one of the named data types is reported as such at the beginning of the Parameter's description via a reference back to the associated data type definition (e.g. [MacAddress]). However, such parameters still indicate their SOAP data type.

Data Type Base Type Description
base64 -

Base64 encoded binary (no line-length limitation).

A minimum and maximum allowed length can be indicated using the form base64(Min:Max), where Min and Max are the minimum and maximum length in characters before Base64 encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in base64(Max). Multiple comma-separated ranges can be specified, in which case the length MUST be in one of the ranges.

boolean - Boolean, where the allowed values are 0 or 1 (or equivalently, true or false).
dateTime - The subset of the ISO 8601 date-time format defined by the SOAP dateTime type.
hexBinary -

Hex encoded binary.

A minimum and maximum allowed length can be indicated using the form hexBinary(Min:Max), where Min and Max are the minimum and maximum length in characters before Hex Binary encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in hexBinary(Max). Multiple comma-separated ranges can be specified, in which case the length MUST be in one of the ranges.

int -

Integer in the range -2147483648 to +2147483647, inclusive.

For some int types, a value range is given using the form int[Min:Max] or int[Min:Max step Step] where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

long -

Long integer in the range -9223372036854775808 to 9223372036854775807, inclusive.

For some long types, a value range is given using the form long[Min:Max] or long[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

object - A container for parameters and/or other objects. The full Path Name of a parameter is given by the parameter name appended to the full Path Name of the object it is contained within.
string - For strings, a minimum and maximum allowed length can be indicated using the form string(Min:Max), where Min and Max are the minimum and maximum string length in characters. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in string(Max). Multiple comma-separated ranges can be specified, in which case the string length will be in one of the ranges.
unsignedInt -

Unsigned integer in the range 0 to 4294967295, inclusive.

For some unsignedInt types, a value range is given using the form unsignedInt[Min:Max] or unsigned[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

unsignedLong -

Unsigned long integer in the range 0 to 18446744073709551615, inclusive.

For some unsignedLong types, a value range is given using the form unsignedLong[Min:Max] or unsignedLong[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

References

[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.

STBService:1.3 Data Model (changes)

For a given implementation of this data model, the Agent MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the Agent supports only a single parameter that was introduced in version 1.3, then it will indicate support for version 1.3. The version number associated with each object and parameter is shown in the Version column.

Name Type Write Description Object Default Version
STBService.{i}. object -

The top-level object for an STB CPE.

At most one entry in this table can exist with a given value for Alias.

- 1.0
STBService.{i}.ServiceMonitoring. object -

Contains statistics relating to the QoS / QoE of Main AV streams. These statistics are broken down into categories, e.g. de-jittering and RTP, and for each category there are two types of statistics:

  • Total statistics, which count the number of occurrences of something.
  • Sample statistics, which are measured over a sample interval, and are made available to the ACS as a list of the most recent n samples.

Total statistics are always collected (collection cannot be disabled, but the values can be reset).

For Sample statistics, an STB uses a single sample interval and number of samples (n) for all MainStream instances. The sample interval can be aligned with absolute time.

When Sample statistics collection is enabled, statistics collection MUST proceed regardless of whether there are any active Main AV streams. For example, even when the STB is not receiving any data, sample intervals will continue to be timed as normal.

Refer to [I.3/TR-135] for non-normative explanation of the operation of the ServiceMonitoring object.

- 1.0
STBService.{i}.ServiceMonitoring.MainStream.{i}. object -

List of Main AV stream objects. Each instance is associated with a specified service type and will collect statistics only for the main stream that matches that service type.

Note that this means that streams that do not match an instance's service type MUST NOT contribute to the instance's Total and Sample statistics.

It is up to the STB to determine which AV stream should be regarded as the Main AV stream for a given service type at any given time. For example, if two active streams are associated with the same service type, the STB might prefer streams that are associated with an AV player, or if more than one stream is associated with an AV player, the STB might prefer a player that is outputting a DVI stream to a player that is outputting an RF stream.

Note that some parameters, e.g. Components.FrontEnd.{i}.IP.ServiceConnect.URI, include requirements that restrict the STB's freedom to determine which AV stream should be regarded as the Main AV stream for a given service.

At most one entry in this table can exist with a given value for ServiceType, or with a given value for Alias.

- 1.0
PacketsLostByEventHistogramIntervals string W

Comma-separated list of unsigned integers (value at least 1). Definition of the histogram intervals for counting loss events according to their size (in packets). Each value indicates the maximum value of the interval. For example, "1,2,4,8," defines the five intervals: 1 packet lost, 2 packets, 3 or 4 packets, 5 to 8 packets and 9 or more packets. (No value after the last comma means no upper bound.)

If this parameter is set to an empty string, no PacketsLostByEvent stats will be collected.

- 1.3
DelayBetweenLossEventsHistogramIntervals string W

Comma-separated list of unsigned integers (value at least 1). Definition of the histogram intervals for counting loss events according to their delay (in milliseconds) after the preceding loss event. Each value indicates the maximum value of the interval. For example, "10,20,50,100,1000,60000,3600000," defines the intervals up to 10 ms, to 20 ms, to 50 ms, to 100 ms, to 1 s, to 1 mn, to 1 h and more than 1 h. (No value after the last comma means no upper bound.)

If this parameter is set to an empty string, no DelayBetweenLossEvents stats will be collected.

- 1.3
DurationSevereLossEventsHistogramIntervals string W

Comma-separated list of unsigned integers (value at least 1). Definition of the histogram intervals for counting severe loss events according to their duration (in milliseconds). Each value indicates the maximum value of the interval. For example, "50,100,500,1000,2000,5000,10000,120000," defines the intervals up to 50 ms, to 100 ms, to 500 ms, to 1 s, to 2 s etc. (No value after the last comma means no upper bound.)

If this parameter is set to an empty string, no DurationSevereLossEvents stats will be collected.

- 1.3
STBService.{i}.ServiceMonitoring.MainStream.{i}.Total. object - Total statistics since this ServiceMonitoring main stream instance was last enabled or Total statistics were last reset. - 1.0
STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.RTPStats. object -

Total RTP statistics for this ServiceMonitoring main stream instance.

If no EC is applied the BeforeEC statistics provide the same values as the corresponding statistics, e.g. when there is no EC, PacketsReceivedBeforeEC = PacketsReceived.

- 1.0
PacketsLostByEventHistogram string -

Comma-separated list of unsigned integers. Total number of loss events counted by their length in packets (1 packet, 2 packets, etc.) according to the intervals defined by PacketsLostByEventHistogramIntervals.

These statistics are collected when no EC is applied or after any EC if available.

- 1.3
PacketsLostByEventHistogramBeforeEC string -

Comma-separated list of unsigned integers. Total number of loss events counted by their length in packets (1 packet, 2 packets, etc.) according to the intervals defined by PacketsLostByEventHistogramIntervals.

These statistics are collected before any EC, if available, is applied.

- 1.3
DelayBetweenLossEventsHistogram string -

Comma-separated list of unsigned integers. Total number of times that the delay (in milliseconds) between two consecutive loss events belongs to each time interval defined by DelayBetweenLossEventsHistogramIntervals.

These statistics are collected when no EC is applied or after any EC if available.

- 1.3
DelayBetweenLossEventsHistogramBeforeEC string -

Comma-separated list of unsigned integers. Total number of times that the delay (in milliseconds) between two consecutive loss events belongs to each time interval defined by DelayBetweenLossEventsHistogramIntervals.

These statistics are collected before any EC, if available, is applied.

- 1.3
DurationSevereLossEventsHistogram string -

Comma-separated list of unsigned integers. Total number of severe loss events counted by their duration (in milliseconds) according to the intervals defined by DurationSevereLossEventsHistogramIntervals.

These statistics are collected when no EC is applied or after any EC if available.

- 1.3
DurationSevereLossEventsHistogramBeforeEC string -

Comma-separated list of unsigned integers. Total number of severe loss events counted by their duration (in milliseconds) according to the intervals defined by DurationSevereLossEventsHistogramIntervals.

These statistics are collected before any EC, if available, is applied.

- 1.3
STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample. object -

Sample statistics collected since collection was last enabled or reset.

Most of the parameters in this object are comma-separated lists of individual statistics values, each of which corresponds to a sample interval.

The statistics values in these comma-separated lists MUST be in time order, with the oldest one first and the most recent one last.

Each comma-separated list can contain up to ReportSamples statistics values. When the list is full, each new value causes the oldest one to be discarded.

Some comma-separated lists contain terms that are comma-separated lists themselves and are used to store measurements on an event basis. These sub-lists can contain up to Capabilities.ServiceMonitoring.MaxEventsPerSampleInterval values.

If no data was collected for a statistic during a sample interval then the value for that sample interval MUST be zero unless otherwise specified in the description of the individual statistics parameter.

- 1.0
STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.RTPStats. object -

RTP Sample statistics for this ServiceMonitoring main stream instance.

If no EC is applied the BeforeEC statistics provide the same values as the corresponding statistics, e.g. when there is no EC, PacketsReceivedBeforeEC = PacketsReceived.

- 1.0
PacketsLostByEventHistogram string -

Comma-separated list of strings. Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of loss events counted by their length in packets (1 packet, 2 packets, etc.) according to the intervals defined by PacketsLostByEventHistogramIntervals.

These statistics are collected when no EC is applied or after any EC if available.

- 1.3
PacketsLostByEventHistogramBeforeEC string -

Comma-separated list of strings. Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of loss events counted by their length in packets (1 packet, 2 packets, etc.) according to the intervals defined by PacketsLostByEventHistogramIntervals.

These statistics are collected before any EC, if available, is applied.

- 1.3
DelayBetweenLossEventsHistogram string -

Comma-separated list of strings. Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of the number of times that the delay (in milliseconds) between two consecutive loss events belongs to each time interval defined by DelayBetweenLossEventsHistogramIntervals.

These statistics are collected when no EC is applied or after any EC if available.

- 1.3
DelayBetweenLossEventsHistogramBeforeEC string -

Comma-separated list of strings. Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of the number of times that the delay (in milliseconds) between two consecutive loss events belongs to each time interval defined by DelayBetweenLossEventsHistogramIntervals.

These statistics are collected before any EC, if available, is applied.

- 1.3
DurationSevereLossEventsHistogram string -

Comma-separated list of strings. Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of the number of severe loss events counted by their duration (in milliseconds) according to the intervals defined by DurationSevereLossEventsHistogramIntervals.

These statistics are collected when no EC is applied or after any EC if available.

- 1.3
DurationSevereLossEventsHistogramBeforeEC string -

Comma-separated list of strings. Each list item is a comma-separated list of unsigned integers that represents, for a sample interval, a histogram of the number of severe loss events counted by their duration (in milliseconds) according to the intervals defined by DurationSevereLossEventsHistogramIntervals.

These statistics are collected before any EC, if available, is applied.

- 1.3

Inform and Notification Requirements

Forced Inform Parameters

Parameter

Forced Active Notification Parameters

Parameter

Default Active Notification Parameters

Parameter

Parameters for which Active Notification MAY be Denied

Parameter

Profile Definitions

Notation

The following abbreviations are used to specify profile requirements:

Abbreviation Description
R Read support is REQUIRED.
W Both Read and Write support is REQUIRED. This MUST NOT be specified for a parameter that is defined as read-only.
P The object is REQUIRED to be present.
C Creation and deletion of instances of the object is REQUIRED.
A Creation of instances of the object is REQUIRED, but deletion is not REQUIRED.
D Deletion of instances of the object is REQUIRED, but creation is not REQUIRED.

HistoECPerfMon:1 Profile

This table defines the HistoECPerfMon:1 profile for the STBService:1 data model. The minimum REQUIRED version for this profile is STBService:1.3.

Name Requirement
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Total.­RTPStats. P
SevereLossLengthCountBeforeEC R
PacketsLostByEventHistogramBeforeEC R
DelayBetweenLossEventsHistogramBeforeEC R
DurationSevereLossEventsHistogramBeforeEC R
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Sample.­RTPStats. P
SevereLossLengthCountBeforeEC R
PacketsLostByEventHistogramBeforeEC R
DelayBetweenLossEventsHistogramBeforeEC R
DurationSevereLossEventsHistogramBeforeEC R

HistoPerfMon:1 Profile

This table defines the HistoPerfMon:1 profile for the STBService:1 data model. The minimum REQUIRED version for this profile is STBService:1.3.

Name Requirement
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}. P
SevereLossMinLength W
PacketsLostByEventHistogramIntervals W
DelayBetweenLossEventsHistogramIntervals W
DurationSevereLossEventsHistogramIntervals W
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Total.­RTPStats. P
SevereLossLengthCount R
PacketsLostByEventHistogram R
DelayBetweenLossEventsHistogram R
DurationSevereLossEventsHistogram R
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Sample.­RTPStats. P
SevereLossLengthCount R
PacketsLostByEventHistogram R
DelayBetweenLossEventsHistogram R
DurationSevereLossEventsHistogram R

Baseline:2 Profile

The Baseline:2 profile for the STBService:1 data model is defined as the union of the Baseline:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is STBService:1.3.

Name Requirement
STBServiceNumberOfEntries R
STBService.­{i}. P
Enable W

DigitalOutput:3 Profile

The DigitalOutput:3 profile for the STBService:1 data model is defined as the union of the DigitalOutput:2 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is STBService:1.3.

Name Requirement
STBService.­{i}.­Components. P
HDMINumberOfEntries R
SPDIFNumberOfEntries R


Generated by Broadband Forum report.pl#422 (2018/03/28 version) on 2018/04/02 at 12:20:47.
report.pl --exitcode=fatals --cwmpindex=.. --nofontstyles --nowarnreport --quiet --lastonly --report=html --outfile=tr-135-1-3-0-diffs.html tr-135-1-3-0.xml