blob: af2ea0d4c6b3011ca29e84c32e7340ded59bd8b2 [file] [log] [blame]
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -07001/*
2 * Copyright (c) 2018 - present. Boling Consulting Solutions (bcsw.net)
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 * http://www.apache.org/licenses/LICENSE-2.0
8 * Unless required by applicable law or agreed to in writing, software
9 * distributed under the License is distributed on an "AS IS" BASIS,
10 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 * See the License for the specific language governing permissions and
12 * limitations under the License.
13 */
14/*
15 * NOTE: This file was generated, manual edits will be overwritten!
16 *
17 * Generated by 'goCodeGenerator.py':
18 * https://github.com/cboling/OMCI-parser/README.md
19 */
20package generated
21
22import "github.com/deckarep/golang-set"
23
24const MulticastSubscriberConfigInfoClassId ClassID = ClassID(310)
25
26var multicastsubscriberconfiginfoBME *ManagedEntityDefinition
27
28// MulticastSubscriberConfigInfo (class ID #310)
29// This ME organizes data associated with multicast management at subscriber ports of IEEE 802.1
30// bridges, including IEEE 802.1p mappers when the provisioning model is mapper-based rather than
31// bridge-based. Instances of this ME are created and deleted by the OLT. Because of backward
32// compatibility considerations, a subscriber port without an associated multicast subscriber
33// config info ME would be expected to support unrestricted multicast access; this ME may therefore
34// be viewed as restrictive, rather than permissive.
35//
36// Through separate attributes, this ME supports either a single multicast operations profile in
37// its backward compatible form, or a list of multicast operations profiles instead (the list may
38// of course contain a single entry). The OLT can determine whether the ONU supports the multiple
39// profile capability by performing a get operation on the optional multicast service package table
40// attribute, which exists only on ONUs that are prepared to support the feature.
41//
42// Relationships
43// An instance of this ME is associated with one instance of the MAC bridge port configuration data
44// or the IEEE 802.1p mapper service profile.
45//
46// Attributes
47// Managed Entity Id
48// Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
49// identical ID, this ME is implicitly linked to an instance of the MAC bridge port configuration
50// data or IEEE 802.1p mapper ME. (R, setbycreate) (mandatory) (2 bytes)
51//
52// Me Type
53// (R, W, setbycreate) (mandatory) (1 byte)
54//
55// Multicast Operations Profile Pointer
56// Multicast operations profile pointer: This attribute points to an instance of the multicast
57// operations profile. This attribute is ignored by the ONU if a non-empty multicast service
58// package table attribute is present. (R,W, set-by-create) (mandatory) (2 bytes)
59//
60// Max Simultaneous Groups
61// Max simultaneous groups: This attribute specifies the maximum number of dynamic multicast groups
62// that may be replicated to the client port at any one time. The recommended default value 0
63// specifies that no administrative limit is to be imposed. (R, W, setbycreate) (optional)
64// (2 bytes)
65//
66// Max Multicast Bandwidth
67// Max multicast bandwidth: This attribute specifies the maximum imputed dynamic bandwidth, in
68// bytes per second, that may be delivered to the client port at any one time. The recommended
69// default value 0 specifies that no administrative limit is to be imposed. (R, W, setbycreate)
70// (optional) (4 bytes)
71//
72// Bandwidth Enforcement
73// Bandwidth enforcement: The recommended default value of this Boolean attribute is false, and
74// specifies that attempts to exceed the max multicast bandwidth be counted but honoured. The value
75// true specifies that such attempts be counted and denied. The imputed bandwidth value is taken
76// from the dynamic access control list table, both for a new join request and for pre-existing
77// groups. (R, W, setbycreate) (optional) (1 byte)
78//
79// Multicast Service Package Table
80// (R, W) (optional) (20N bytes, where N is the number of entries in the table)
81//
82type MulticastSubscriberConfigInfo struct {
83 ManagedEntityDefinition
84 Attributes AttributeValueMap
85}
86
87func init() {
88 multicastsubscriberconfiginfoBME = &ManagedEntityDefinition{
89 Name: "MulticastSubscriberConfigInfo",
90 ClassID: 310,
91 MessageTypes: mapset.NewSetWith(
92 Create,
93 Delete,
94 Get,
95 GetNext,
96 Set,
97 ),
98 AllowedAttributeMask: 0XFC00,
99 AttributeDefinitions: AttributeDefinitionMap{
100 0: Uint16Field("ManagedEntityId", 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, false, 0),
101 1: ByteField("MeType", 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, false, 1),
102 2: Uint16Field("MulticastOperationsProfilePointer", 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, false, 2),
103 3: Uint16Field("MaxSimultaneousGroups", 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, true, false, 3),
104 4: Uint32Field("MaxMulticastBandwidth", 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, true, false, 4),
105 5: ByteField("BandwidthEnforcement", 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, true, false, 5),
106 6: TableField("MulticastServicePackageTable", TableInfo{nil, 22}, mapset.NewSetWith(Read, Write), false, true, false, 6),
107 },
108 }
109}
110
111// NewMulticastSubscriberConfigInfo (class ID 310 creates the basic
112// Managed Entity definition that is used to validate an ME of this type that
113// is received from the wire, about to be sent on the wire.
114func NewMulticastSubscriberConfigInfo(params ...ParamData) (*ManagedEntity, OmciErrors) {
115 return NewManagedEntity(multicastsubscriberconfiginfoBME, params...)
116}