From 1a4ff7fcd26ef63feec7b68a0c45dfa34d3ba7df Mon Sep 17 00:00:00 2001 From: "Pascal S. de Kloe" Date: Sun, 7 Feb 2021 15:01:24 +0100 Subject: [PATCH] Follow constructor convention for Dialers. --- client.go | 8 ++++---- cmd/mqttc/main.go | 4 ++-- example_test.go | 2 +- integration/integration_test.go | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/client.go b/client.go index 1347cf8..8d638c4 100644 --- a/client.go +++ b/client.go @@ -47,9 +47,9 @@ var ( // Dialer abstracts the transport layer establishment. type Dialer func(ctx context.Context) (net.Conn, error) -// UnsecuredDialer creates plain network connections. +// NewDialer provides plain network connections. // See net.Dial for details on the network & address syntax. -func UnsecuredDialer(network, address string) Dialer { +func NewDialer(network, address string) Dialer { return func(ctx context.Context) (net.Conn, error) { // minimize timer use; covered by WireTimeout dialer := net.Dialer{KeepAlive: -1} @@ -57,9 +57,9 @@ func UnsecuredDialer(network, address string) Dialer { } } -// SecuredDialer creates TLS network connections. +// NewTLSDialer provides secured network connections. // See net.Dial for details on the network & address syntax. -func SecuredDialer(network, address string, config *tls.Config) Dialer { +func NewTLSDialer(network, address string, config *tls.Config) Dialer { return func(ctx context.Context) (net.Conn, error) { dialer := tls.Dialer{ // minimize timer use; covered by WireTimeout diff --git a/cmd/mqttc/main.go b/cmd/mqttc/main.go index 1472aae..d37f24a 100644 --- a/cmd/mqttc/main.go +++ b/cmd/mqttc/main.go @@ -92,11 +92,11 @@ func parseConfig() *mqtt.Config { UserName: *userFlag, } if *tlsFlag { - config.Dialer = mqtt.SecuredDialer(*netFlag, addr, &tls.Config{ + config.Dialer = mqtt.NewTLSDialer(*netFlag, addr, &tls.Config{ ServerName: *serverFlag, }) } else { - config.Dialer = mqtt.UnsecuredDialer(*netFlag, addr) + config.Dialer = mqtt.NewDialer(*netFlag, addr) } if *passFlag != "" { bytes, err := os.ReadFile(*passFlag) diff --git a/example_test.go b/example_test.go index 330e34f..c28741e 100644 --- a/example_test.go +++ b/example_test.go @@ -42,7 +42,7 @@ func init() { // It is good practice to install the client from main. func ExampleNewClient_setup() { client := mqtt.NewClient(&mqtt.Config{ - Dialer: mqtt.UnsecuredDialer("tcp", "localhost:1883"), + Dialer: mqtt.NewDialer("tcp", "localhost:1883"), Store: mqtt.NewVolatileStore("demo-client"), WireTimeout: time.Second, BufSize: 8192, diff --git a/integration/integration_test.go b/integration/integration_test.go index 8c1306f..afb72c2 100644 --- a/integration/integration_test.go +++ b/integration/integration_test.go @@ -47,7 +47,7 @@ func race(t *testing.T, host string, deliveryLevel int) { testTopic := fmt.Sprintf("test/race-%d", deliveryLevel) client := mqtt.NewClient(&mqtt.Config{ - Dialer: mqtt.UnsecuredDialer("tcp", net.JoinHostPort(host, "1883")), + Dialer: mqtt.NewDialer("tcp", net.JoinHostPort(host, "1883")), WireTimeout: time.Second, BufSize: 1024, Store: mqtt.NewVolatileStore(t.Name()),