blob: 7f525c092f72dad958d396b4dbc67526f355ef69 [file] [log] [blame]
Chip Boling610117d2021-09-09 11:24:34 -05001/*
2 * Copyright (c) 2018 - present. Boling Consulting Solutions (bcsw.net)
3 * Copyright 2020-present Open Networking Foundation
4
5 * 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
8
9 * http://www.apache.org/licenses/LICENSE-2.0
10
11 * 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 */
17/*
18 * 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// SipConfigPortalClassID is the 16-bit ID for the OMCI
29// Managed entity SIP config portal
30const SipConfigPortalClassID = ClassID(149) // 0x0095
31
32var sipconfigportalBME *ManagedEntityDefinition
33
34// SipConfigPortal (Class ID: #149 / 0x0095)
35// The SIP config portal ME provides a way for the OLT to discover the configuration text delivered
36// to an ONU by a non-OMCI SIP VoIP configuration method ([BBF TR-069], sipping framework, etc.).
37// Text retrieved from this ME is not required to be understood by the OLT or EMS, but it may be
38// useful for human or vendor-specific analysis tools. See also the MGC config portal ME.
39//
40// An instance of this ME may be created by an ONU that supports non-OMCI SIP configuration. It is
41// not reported during an MIB upload.
42//
43// Relationships
44// One instance of this ME is associated with the ONU.
45//
46// Attributes
47// Managed Entity Id
48// This attribute uniquely identifies each instance of this ME. There is one instance, number 0.
49// (R) (mandatory) (2-bytes)
50//
51// Configuration Text Table
52// This attribute is used to pass a textual representation of the VoIP configuration back to the
53// OLT. The contents are vendor-specific. The get, get next sequence must be used with this
54// attribute since its size is unspecified. Upon ME instantiation, the ONU sets this attribute to
55// 0. (R) (mandatory) (x-bytes)
56//
57type SipConfigPortal struct {
58 ManagedEntityDefinition
59 Attributes AttributeValueMap
60}
61
62func init() {
63 sipconfigportalBME = &ManagedEntityDefinition{
64 Name: "SipConfigPortal",
65 ClassID: 149,
66 MessageTypes: mapset.NewSetWith(
67 Get,
68 GetNext,
69 ),
70 AllowedAttributeMask: 0x8000,
71 AttributeDefinitions: AttributeDefinitionMap{
72 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read), false, false, false, 0),
73 1: TableField("ConfigurationTextTable", TableAttributeType, 0x8000, TableInfo{nil, 25}, mapset.NewSetWith(Read), true, false, false, 1),
74 },
75 Access: CreatedByOnu,
76 Support: UnknownSupport,
77 }
78}
79
80// NewSipConfigPortal (class ID 149) creates the basic
81// Managed Entity definition that is used to validate an ME of this type that
82// is received from or transmitted to the OMCC.
83func NewSipConfigPortal(params ...ParamData) (*ManagedEntity, OmciErrors) {
84 return NewManagedEntity(*sipconfigportalBME, params...)
85}