blob: 1ed14a8de054b1a1e10243462d900dfc10b854e1 [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// SipAgentConfigData2ClassID is the 16-bit ID for the OMCI
29// Managed entity SIP agent config data 2
30const SipAgentConfigData2ClassID = ClassID(407) // 0x0197
31
32var sipagentconfigdata2BME *ManagedEntityDefinition
33
34// SipAgentConfigData2 (Class ID: #407 / 0x0197)
35// This ME supplements SIP agent config data ME. Instances of this ME are created and deleted by
36// the OLT.
37//
38// Relationships
39// An instance of this ME is associated with a SIP agent config data.
40//
41// Attributes
42// Managed Entity Id
43// This attribute uniquely identifies each instance of this ME. Through an identical ID, this ME is
44// implicitly linked to an instance of the corresponding SIP agent config data. Note that this
45// entity is associated with the primary SIP agent config data (if SIP agent is involved in
46// protection). (R, set-by-create) (mandatory) (2-bytes)
47//
48// In_Use_Options_Timer
49// In-Use-Options-Timer: This attribute defines the frequency that a SIP options packet is sent to
50// the SIP proxy in-use. When a SIP options packet is not responded to by the SIP proxy, it is
51// marked as unavailable. Otherwise, it is marked as available. Units are seconds. The default
52// value 0 specifies vendor-specific implementation. (R, W, set-by-create) (mandatory) (2-byte)
53//
54// Alternate_Options_Timer
55// Alternate-Options-Timer: This attribute defines the frequency that a SIP options packet is sent
56// to the standby SIP proxy. When a SIP options packet is not responded to by the standby SIP
57// proxy, it is marked as unavailable. Otherwise, it is marked as available. Units are seconds. The
58// default value 0 specifies vendor-specific implementation. (R, W, set-by-create) (mandatory)
59// (2-byte)
60//
61// Revertive
62// This Boolean attribute specifies whether the SIP UA is involved in revertive (true) or non-
63// revertive (false) switching. The default value is recommended to be false. (R, W, set-by-create)
64// (mandatory) (1 byte)
65//
66// Current Proxy Server Resolved Address
67// This attribute contains the resolved IP address of the in-use SIP proxy. If the value is
68// 0.0.x.y, where x and y are not both 0, then x.y is to be interpreted as a pointer to a large
69// string ME that represents an IPv6 address. Otherwise, the address is an IPv4 address (R)
70// (optional) (4-bytes)
71//
72// Current Proxy Server Resolved Name
73// This attribute contains a pointer to the large string ME that contains the resolved name of the
74// SIP proxy in-use. (R) (optional) (2-bytes)
75//
76// Alternate Proxy Server Resolved Address
77// This attribute contains the resolved IP address of the alternate SIP proxy. If the value is
78// 0.0.x.y, where x and y are not both 0, then x.y is to be interpreted as a pointer to a large
79// string ME that represents an IPv6 address. Otherwise, the address is an IPv4 address (R)
80// (optional) (4-bytes)
81//
82// Alternate Proxy Server Resolved Name
83// This attribute contains a pointer to the large string ME that contains the resolved name of the
84// alternate SIP proxy. (R) (optional) (2-bytes)
85//
86type SipAgentConfigData2 struct {
87 ManagedEntityDefinition
88 Attributes AttributeValueMap
89}
90
91func init() {
92 sipagentconfigdata2BME = &ManagedEntityDefinition{
93 Name: "SipAgentConfigData2",
94 ClassID: 407,
95 MessageTypes: mapset.NewSetWith(
96 Create,
97 Delete,
98 Get,
99 Set,
100 GetCurrentData,
101 ),
102 AllowedAttributeMask: 0xfe00,
103 AttributeDefinitions: AttributeDefinitionMap{
104 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
105 1: Uint16Field("InUseOptionsTimer", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 1),
106 2: Uint16Field("AlternateOptionsTimer", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
107 3: ByteField("Revertive", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 3),
108 4: Uint32Field("CurrentProxyServerResolvedAddress", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, true, false, 4),
109 5: Uint16Field("CurrentProxyServerResolvedName", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, true, false, 5),
110 6: Uint32Field("AlternateProxyServerResolvedAddress", UnsignedIntegerAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, true, false, 6),
111 7: Uint16Field("AlternateProxyServerResolvedName", UnsignedIntegerAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, true, false, 7),
112 },
113 Access: CreatedByOlt,
114 Support: UnknownSupport,
115 }
116}
117
118// NewSipAgentConfigData2 (class ID 407) creates the basic
119// Managed Entity definition that is used to validate an ME of this type that
120// is received from or transmitted to the OMCC.
121func NewSipAgentConfigData2(params ...ParamData) (*ManagedEntity, OmciErrors) {
122 return NewManagedEntity(*sipagentconfigdata2BME, params...)
123}