-
Notifications
You must be signed in to change notification settings - Fork 389
/
Driver.go
148 lines (132 loc) · 5.35 KB
/
Driver.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package cbus
import (
"context"
"github.com/apache/plc4x/plc4go/spi/transactions"
"github.com/rs/zerolog"
"net/url"
"strconv"
"github.com/apache/plc4x/plc4go/pkg/api"
apiModel "github.com/apache/plc4x/plc4go/pkg/api/model"
readWriteModel "github.com/apache/plc4x/plc4go/protocols/cbus/readwrite/model"
_default "github.com/apache/plc4x/plc4go/spi/default"
"github.com/apache/plc4x/plc4go/spi/options"
"github.com/apache/plc4x/plc4go/spi/transports"
"github.com/pkg/errors"
)
type Driver struct {
_default.DefaultDriver
tm transactions.RequestTransactionManager
awaitSetupComplete bool
awaitDisconnectComplete bool
log zerolog.Logger
_options []options.WithOption // Used to pass them downstream
}
func NewDriver(_options ...options.WithOption) plc4go.PlcDriver {
customLogger := options.ExtractCustomLoggerOrDefaultToGlobal(_options...)
driver := &Driver{
tm: transactions.NewRequestTransactionManager(1, _options...),
awaitSetupComplete: true,
awaitDisconnectComplete: true,
log: customLogger,
_options: _options,
}
driver.DefaultDriver = _default.NewDefaultDriver(driver, "c-bus", "Clipsal Bus", "tcp", NewTagHandler())
return driver
}
func (m *Driver) GetConnectionWithContext(ctx context.Context, transportUrl url.URL, transports map[string]transports.Transport, driverOptions map[string][]string) <-chan plc4go.PlcConnectionConnectResult {
m.log.Debug().
Stringer("transportUrl", &transportUrl).
Int("nTransports", len(transports)).
Int("nDriverOptions", len(driverOptions)).
Msg("Get connection for transport url with nTransports transport(s) and nDriverOptions option(s)")
// Get the transport specified in the url
transport, ok := transports[transportUrl.Scheme]
if !ok {
m.log.Error().
Stringer("transportUrl", &transportUrl).
Str("scheme", transportUrl.Scheme).
Msg("We couldn't find a transport for scheme")
return m.reportError(errors.Errorf("couldn't find transport for given transport url %v", transportUrl))
}
// Provide a default-port to the transport, which is used, if the user doesn't provide on in the connection string.
driverOptions["defaultTcpPort"] = []string{strconv.FormatUint(uint64(readWriteModel.CBusConstants_CBUSTCPDEFAULTPORT), 10)}
// Have the transport create a new transport-instance.
transportInstance, err := transport.CreateTransportInstance(
transportUrl,
driverOptions,
append(m._options, options.WithCustomLogger(m.log))...,
)
if err != nil {
m.log.Error().
Stringer("transportUrl", &transportUrl).
Strs("defaultTcpPort", driverOptions["defaultTcpPort"]).
Msg("We couldn't create a transport instance for port")
return m.reportError(errors.Wrapf(err, "couldn't initialize transport configuration for given transport url %s", transportUrl.String()))
}
configuration, err := ParseFromOptions(m.log, driverOptions)
if err != nil {
m.log.Error().Err(err).Msg("Invalid options")
return m.reportError(errors.Wrap(err, "Invalid options"))
}
codec := NewMessageCodec(
transportInstance,
append(m._options, options.WithCustomLogger(m.log))...,
)
m.log.Debug().Stringer("codec", codec).Msg("working with codec")
driverContext := NewDriverContext(configuration)
driverContext.awaitSetupComplete = m.awaitSetupComplete
driverContext.awaitDisconnectComplete = m.awaitDisconnectComplete
// Create the new connection
connection := NewConnection(
codec, configuration,
driverContext,
m.GetPlcTagHandler(),
m.tm, driverOptions,
append(m._options, options.WithCustomLogger(m.log))...,
)
m.log.Debug().Msg("created connection, connecting now")
return connection.ConnectWithContext(ctx)
}
func (m *Driver) reportError(err error) <-chan plc4go.PlcConnectionConnectResult {
ch := make(chan plc4go.PlcConnectionConnectResult, 1)
ch <- _default.NewDefaultPlcConnectionConnectResult(nil, err)
return ch
}
func (m *Driver) SetAwaitSetupComplete(awaitComplete bool) {
m.awaitSetupComplete = awaitComplete
}
func (m *Driver) SetAwaitDisconnectComplete(awaitComplete bool) {
m.awaitDisconnectComplete = awaitComplete
}
func (m *Driver) SupportsDiscovery() bool {
return true
}
func (m *Driver) DiscoverWithContext(ctx context.Context, callback func(event apiModel.PlcDiscoveryItem), discoveryOptions ...options.WithDiscoveryOption) error {
return NewDiscoverer(
append(m._options, options.WithCustomLogger(m.log))...,
).Discover(ctx, callback, discoveryOptions...)
}
func (m *Driver) Close() error {
if err := m.tm.Close(); err != nil {
return errors.Wrap(err, "error closing transaction manager")
}
return nil
}