blob: 59444a98575b1101bcc9b11ca89f14184950a753 [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// MulticastSubscriberConfigInfoClassID is the 16-bit ID for the OMCI
29// Managed entity Multicast subscriber config info
30const MulticastSubscriberConfigInfoClassID ClassID = ClassID(310)
31
32var multicastsubscriberconfiginfoBME *ManagedEntityDefinition
33
34// MulticastSubscriberConfigInfo (class ID #310)
35// This ME organizes data associated with multicast management at subscriber ports of IEEE-802.1
36// bridges, including IEEE-802.1p mappers when the provisioning model is mapper-based rather than
37// bridge-based. Instances of this ME are created and deleted by the OLT. Because of backward
38// compatibility considerations, a subscriber port without an associated multicast subscriber
39// config info ME would be expected to support unrestricted multicast access; this ME may therefore
40// be viewed as restrictive, rather than permissive.
41//
42// Through separate attributes, this ME supports either a single multicast operations profile in
43// its backward compatible form, or a list of multicast operations profiles instead (the list may
44// of course contain a single entry). The OLT can determine whether the ONU supports the multiple
45// profile capability by performing a get operation on the optional multicast service package table
46// attribute, which exists only on ONUs that are prepared to support the feature.
47//
48// Relationships
49// An instance of this ME is associated with one instance of the MAC bridge port configuration data
50// or the IEEE-802.1p mapper service profile.
51//
52// Attributes
53// Managed Entity Id
54// Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
55// identical ID, this ME is implicitly linked to an instance of the MAC bridge port configuration
56// data or IEEE-802.1p mapper ME. (R, setbycreate) (mandatory) (2-bytes)
57//
58// Me Type
59// (R,-W, setbycreate) (mandatory) (1-byte)
60//
61// Multicast Operations Profile Pointer
62// Multicast operations profile pointer: This attribute points to an instance of the multicast
63// operations profile. This attribute is ignored by the ONU if a non-empty multicast service
64// package table attribute is present. (R,W, set-by-create) (mandatory) (2 bytes)
65//
66// Max Simultaneous Groups
67// Max simultaneous groups: This attribute specifies the maximum number of dynamic multicast groups
68// that may be replicated to the client port at any one time. The recommended default value 0
69// specifies that no administrative limit is to be imposed. (R,-W, setbycreate) (optional)
70// (2-bytes)
71//
72// Max Multicast Bandwidth
73// Max multicast bandwidth: This attribute specifies the maximum imputed dynamic bandwidth, in
74// bytes per second, that may be delivered to the client port at any one time. The recommended
75// default value 0 specifies that no administrative limit is to be imposed. (R,-W, setbycreate)
76// (optional) (4-bytes)
77//
78// Bandwidth Enforcement
79// Bandwidth enforcement: The recommended default value of this Boolean attribute is false, and
80// specifies that attempts to exceed the max multicast bandwidth be counted but honoured. The value
81// true specifies that such attempts be counted and denied. The imputed bandwidth value is taken
82// from the dynamic access control list table, both for a new join request and for pre-existing
83// groups. (R,-W, setbycreate) (optional) (1-byte)
84//
85// Multicast Service Package Table
86// (R,-W) (optional) (20N bytes, where N is the number of entries in the table)
87//
88// Allowed Preview Groups Table
89// Each list entry begins with a table control field:
90//
91type MulticastSubscriberConfigInfo struct {
92 ManagedEntityDefinition
93 Attributes AttributeValueMap
94}
95
96func init() {
97 multicastsubscriberconfiginfoBME = &ManagedEntityDefinition{
98 Name: "MulticastSubscriberConfigInfo",
99 ClassID: 310,
100 MessageTypes: mapset.NewSetWith(
101 Create,
102 Delete,
103 Get,
104 GetNext,
105 Set,
106 ),
107 AllowedAttributeMask: 0xfe00,
108 AttributeDefinitions: AttributeDefinitionMap{
109 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
110 1: ByteField("MeType", EnumerationAttributeType, 0x8000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 1),
111 2: Uint16Field("MulticastOperationsProfilePointer", PointerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
112 3: Uint16Field("MaxSimultaneousGroups", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 3),
113 4: Uint32Field("MaxMulticastBandwidth", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 4),
114 5: ByteField("BandwidthEnforcement", EnumerationAttributeType, 0x0800, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 5),
115 6: TableField("MulticastServicePackageTable", TableAttributeType, 0x0400, TableInfo{nil, 20}, mapset.NewSetWith(Read, Write), false, true, false, 6),
116 7: TableField("AllowedPreviewGroupsTable", TableAttributeType, 0x0200, TableInfo{nil, 22}, mapset.NewSetWith(Read, Write), false, false, false, 7),
117 },
118 Access: CreatedByOlt,
119 Support: UnknownSupport,
120 }
121}
122
123// NewMulticastSubscriberConfigInfo (class ID 310) creates the basic
124// Managed Entity definition that is used to validate an ME of this type that
125// is received from or transmitted to the OMCC.
126func NewMulticastSubscriberConfigInfo(params ...ParamData) (*ManagedEntity, OmciErrors) {
127 return NewManagedEntity(*multicastsubscriberconfiginfoBME, params...)
128}