blob: b9731441ff8a35e6b1123213f27d2df985482986 [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 */
Andrea Campanella7167ebb2020-02-24 09:56:38 +010017 /*
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// MulticastSubscriberMonitorClassID is the 16-bit ID for the OMCI
29// Managed entity Multicast subscriber monitor
30const MulticastSubscriberMonitorClassID ClassID = ClassID(311)
31
32var multicastsubscribermonitorBME *ManagedEntityDefinition
33
34// MulticastSubscriberMonitor (class ID #311)
35// This ME provides the current status of each port with respect to its multicast subscriptions. It
36// may be useful for status monitoring or debugging purposes. The status table includes all dynamic
37// groups currently subscribed by the port.
38//
39// Relationships
40// Instances of this ME are created and deleted at the request of the OLT. One instance may exist
41// for each IEEE-802.1 UNI configured to support multicast subscription.
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 MAC bridge port configuration
47// data or IEEE-802.1p mapper ME. (R,-setbycreate) (mandatory) (2-bytes)
48//
49// Me Type
50// (R,-W, setbycreate) (mandatory) (1-byte)
51//
52// Current Multicast Bandwidth
53// Current multicast bandwidth: This attribute is the ONU's (BE) estimate of the actual bandwidth
54// currently being delivered to this particular MAC bridge port over all dynamic multicast groups.
55// (R) (optional) (4-bytes)
56//
57// Join Messages Counter
58// Join messages counter: This attribute counts the number of times the corresponding subscriber
59// sent a join message that was accepted. When full, the counter rolls over to 0. (R) (optional)
60// (4-bytes)
61//
62// Bandwidth Exceeded Counter
63// Bandwidth exceeded counter: This attribute counts the number of join messages that did exceed,
64// or would have exceeded, the max multicast bandwidth, whether accepted or denied. When full, the
65// counter rolls over to 0. (R) (optional) (4-bytes)
66//
67// Ipv4 Active Group List Table
68// (R) (mandatory) (24N bytes)
69//
70// Ipv6 Active Group List Table
71// (R) (optional) (58N bytes)
72//
73type MulticastSubscriberMonitor struct {
74 ManagedEntityDefinition
75 Attributes AttributeValueMap
76}
77
78func init() {
79 multicastsubscribermonitorBME = &ManagedEntityDefinition{
80 Name: "MulticastSubscriberMonitor",
81 ClassID: 311,
82 MessageTypes: mapset.NewSetWith(
83 Create,
84 Delete,
85 Get,
86 GetNext,
87 Set,
88 ),
89 AllowedAttributeMask: 0xfc00,
90 AttributeDefinitions: AttributeDefinitionMap{
91 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
92 1: ByteField("MeType", EnumerationAttributeType, 0x8000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 1),
93 2: Uint32Field("CurrentMulticastBandwidth", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read), false, true, false, 2),
94 3: Uint32Field("JoinMessagesCounter", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, true, false, 3),
95 4: Uint32Field("BandwidthExceededCounter", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, true, false, 4),
96 5: TableField("Ipv4ActiveGroupListTable", TableAttributeType, 0x0800, TableInfo{nil, 24}, mapset.NewSetWith(Read), false, false, false, 5),
97 6: TableField("Ipv6ActiveGroupListTable", TableAttributeType, 0x0400, TableInfo{nil, 58}, mapset.NewSetWith(Read), false, true, false, 6),
98 },
99 Access: CreatedByOlt,
100 Support: UnknownSupport,
101 }
102}
103
104// NewMulticastSubscriberMonitor (class ID 311) creates the basic
105// Managed Entity definition that is used to validate an ME of this type that
106// is received from or transmitted to the OMCC.
107func NewMulticastSubscriberMonitor(params ...ParamData) (*ManagedEntity, OmciErrors) {
108 return NewManagedEntity(*multicastsubscribermonitorBME, params...)
109}