blob: ba4fd8bf51a47b2af78e5efe5e5c016173cbd021 [file] [log] [blame]
Chip Boling6e27b352020-02-14 09:10:01 -06001/*
2 * Copyright (c) 2018 - present. Boling Consulting Solutions (bcsw.net)
Andrea Campanella7167ebb2020-02-24 09:56:38 +01003 * Copyright 2020-present Open Networking Foundation
4
Chip Boling6e27b352020-02-14 09:10:01 -06005 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
Andrea Campanella7167ebb2020-02-24 09:56:38 +01008
Chip Boling6e27b352020-02-14 09:10:01 -06009 * http://www.apache.org/licenses/LICENSE-2.0
Andrea Campanella7167ebb2020-02-24 09:56:38 +010010
Chip Boling6e27b352020-02-14 09:10:01 -060011 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
Chip Boling34ebcb62021-02-02 12:13:58 -060017/*
Chip Boling6e27b352020-02-14 09:10:01 -060018 * NOTE: This file was generated, manual edits will be overwritten!
19 *
20 * Generated by 'goCodeGenerator.py':
21 * https://github.com/cboling/OMCI-parser/README.md
22 */
23
24package generated
25
26import "github.com/deckarep/golang-set"
27
28// RtpPerformanceMonitoringHistoryDataClassID is the 16-bit ID for the OMCI
29// Managed entity RTP performance monitoring history data
30const RtpPerformanceMonitoringHistoryDataClassID ClassID = ClassID(144)
31
32var rtpperformancemonitoringhistorydataBME *ManagedEntityDefinition
33
34// RtpPerformanceMonitoringHistoryData (class ID #144)
35// This ME collects PM data related to an RTP session. Instances of this ME are created and deleted
36// by the OLT.
37//
38// For a complete discussion of generic PM architecture, refer to clause I.4.
39//
40// Relationships
41// An instance of this ME is associated with an instance of the PPTP POTS UNI ME.
42//
43// Attributes
44// Managed Entity Id
45// Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
46// identical ID, this ME is implicitly linked to an instance of the PPTP POTS UNI ME. (R,
47// setbycreate) (mandatory) (2-bytes)
48//
49// Interval End Time
50// Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
51// (mandatory) (1-byte)
52//
53// Threshold Data 1_2 Id
54// Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
55// contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
56// data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)
57//
58// Rtp Errors
59// RTP errors: This attribute counts RTP packet errors. (R) (mandatory) (4-bytes)
60//
61// Packet Loss
62// Packet loss: This attribute represents the fraction of packets lost. This attribute is
63// calculated at the end of the 15-min interval, and is undefined under the get current data
64// action. The value 0 indicates no packet loss, scaling linearly to 0xFFFF FFFF to indicate 100%
65// packet loss (zero divided by zero is defined to be zero). (R) (mandatory) (4-bytes)
66//
67// Maximum Jitter
68// Maximum jitter: This attribute is a high water-mark that represents the maximum jitter
69// identified during the measured interval, expressed in RTP timestamp units. (R) (mandatory)
70// (4-bytes)
71//
72// Maximum Time Between Real_Time Transport Control Protocol Rtcp Packets
73// Maximum time between real-time transport control protocol (RTCP) packets: This attribute is a
74// high water-mark that represents the maximum time between RTCP packets during the measured
75// interval, in milliseconds. (R) (mandatory) (4-bytes)
76//
77// Buffer Underflows
78// Buffer underflows: This attribute counts the number of times the reassembly buffer underflows.
79// In the case of continuous underflow caused by a loss of IP packets, a single buffer underflow
80// should be counted. If the IW function is implemented with multiple buffers, such as a packet
81// level buffer and a bit level buffer, then the underflow of either buffer increments this
82// counter. (R) (mandatory) (4-bytes)
83//
84// Buffer Overflows
85// Buffer overflows: This attribute counts the number of times the reassembly buffer overflows. If
86// the IW function is implemented with multiple buffers, such as a packet level buffer and a bit
87// level buffer, then the overflow of either buffer increments this counter. (R) (mandatory)
88// (4-bytes)
89//
90type RtpPerformanceMonitoringHistoryData struct {
91 ManagedEntityDefinition
92 Attributes AttributeValueMap
93}
94
95func init() {
96 rtpperformancemonitoringhistorydataBME = &ManagedEntityDefinition{
97 Name: "RtpPerformanceMonitoringHistoryData",
98 ClassID: 144,
99 MessageTypes: mapset.NewSetWith(
100 Create,
101 Delete,
102 Get,
103 Set,
Chip Boling2d51f052021-02-09 09:04:15 -0600104 GetCurrentData,
Chip Boling6e27b352020-02-14 09:10:01 -0600105 ),
106 AllowedAttributeMask: 0xff00,
107 AttributeDefinitions: AttributeDefinitionMap{
108 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
109 1: ByteField("IntervalEndTime", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
110 2: Uint16Field("ThresholdData12Id", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
111 3: Uint32Field("RtpErrors", CounterAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3),
112 4: Uint32Field("PacketLoss", CounterAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4),
113 5: Uint32Field("MaximumJitter", CounterAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, false, false, 5),
114 6: Uint32Field("MaximumTimeBetweenRealTimeTransportControlProtocolRtcpPackets", CounterAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, false, false, 6),
115 7: Uint32Field("BufferUnderflows", CounterAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, false, false, 7),
116 8: Uint32Field("BufferOverflows", CounterAttributeType, 0x0100, 0, mapset.NewSetWith(Read), false, false, false, 8),
117 },
118 Access: CreatedByOlt,
119 Support: UnknownSupport,
Chip Boling34ebcb62021-02-02 12:13:58 -0600120 Alarms: AlarmMap{
121 0: "RTP errors",
122 1: "Packet loss(Note 1)",
123 2: "Maximum jitter",
124 3: "Max time between RTCP packets",
125 4: "Buffer underflows",
126 5: "Buffer overflows",
127 },
Chip Boling6e27b352020-02-14 09:10:01 -0600128 }
129}
130
131// NewRtpPerformanceMonitoringHistoryData (class ID 144) creates the basic
132// Managed Entity definition that is used to validate an ME of this type that
133// is received from or transmitted to the OMCC.
134func NewRtpPerformanceMonitoringHistoryData(params ...ParamData) (*ManagedEntity, OmciErrors) {
135 return NewManagedEntity(*rtpperformancemonitoringhistorydataBME, params...)
136}