Merge pull request #555 from gopcua/add-missing-with-context-methods

Add missing with context methods

client.go

@@ -34,7 +34,7 @@ func GetEndpoints(ctx context.Context, endpoint string, opts ...Option) ([]*ua.E
 	if err := c.Dial(ctx); err != nil {
 		return nil, err
 	}
-	defer c.Close()
+	defer c.CloseWithContext(ctx)
 	res, err := c.GetEndpointsWithContext(ctx)
 	if err != nil {
 		return nil, err
@@ -195,14 +195,14 @@ func (c *Client) Connect(ctx context.Context) (err error) {
 
 	s, err := c.CreateSessionWithContext(ctx, c.cfg.session)
 	if err != nil {
-		c.Close()
+		c.CloseWithContext(ctx)
 		stats.RecordError(err)
 
 		return err
 	}
 
 	if err := c.ActivateSessionWithContext(ctx, s); err != nil {
-		c.Close()
+		c.CloseWithContext(ctx)
 		stats.RecordError(err)
 
 		return err
@@ -221,7 +221,7 @@ func (c *Client) Connect(ctx context.Context) (err error) {
 	// todo(fs): see the discussion in https://github.com/gopcua/opcua/pull/512
 	// todo(fs): and you should find a commit that implements this option.
 	if err := c.UpdateNamespacesWithContext(ctx); err != nil {
-		c.Close()
+		c.CloseWithContext(ctx)
 		stats.RecordError(err)
 
 		return err
@@ -552,12 +552,20 @@ func (c *Client) Dial(ctx context.Context) error {
 }
 
 // Close closes the session and the secure channel.
+//
+// Note: Starting with v0.5 this method will require a context
+// and the corresponding XXXWithContext(ctx) method will be removed.
 func (c *Client) Close() error {
+	return c.CloseWithContext(context.Background())
+}
+
+// Note: Starting with v0.5 this method is superseded by the non 'WithContext' method.
+func (c *Client) CloseWithContext(ctx context.Context) error {
 	stats.Client().Add("Close", 1)
 
 	// try to close the session but ignore any error
 	// so that we close the underlying channel and connection.
-	c.CloseSession()
+	c.CloseSessionWithContext(ctx)
 	c.setState(Closed)
 
 	if c.mcancel != nil {

examples/accesslevel/accesslevel.go

@@ -29,7 +29,7 @@ func main() {
 	if err := c.Connect(ctx); err != nil {
 		log.Fatal(err)
 	}
-	defer c.CloseSessionWithContext(ctx)
+	defer c.CloseWithContext(ctx)
 
 	id, err := ua.ParseNodeID(*nodeID)
 	if err != nil {

examples/browse/browse.go

@@ -178,7 +178,7 @@ func main() {
 	if err := c.Connect(ctx); err != nil {
 		log.Fatal(err)
 	}
-	defer c.CloseSessionWithContext(ctx)
+	defer c.CloseWithContext(ctx)
 
 	id, err := ua.ParseNodeID(*nodeID)
 	if err != nil {

examples/crypto/crypto.go

@@ -16,12 +16,12 @@ import (
 	"strings"
 	"syscall"
 
+	"golang.org/x/crypto/ssh/terminal"
+
 	"github.com/gopcua/opcua"
 	"github.com/gopcua/opcua/debug"
 	"github.com/gopcua/opcua/errors"
 	"github.com/gopcua/opcua/ua"
-
-	"golang.org/x/crypto/ssh/terminal"
 )
 
 var (
@@ -65,10 +65,10 @@ func main() {
 	if err := c.Connect(ctx); err != nil {
 		log.Fatal(err)
 	}
-	defer c.CloseSessionWithContext(ctx)
+	defer c.CloseWithContext(ctx)
 
 	// Use our connection (read the server's time)
-	v, err := c.Node(ua.NewNumericNodeID(0, 2258)).Value()
+	v, err := c.Node(ua.NewNumericNodeID(0, 2258)).ValueWithContext(ctx)
 	if err != nil {
 		log.Fatal(err)
 	}
@@ -79,7 +79,7 @@ func main() {
 	}
 
 	// Detach our session and try re-establish it on a different secure channel
-	s, err := c.DetachSession()
+	s, err := c.DetachSessionWithContext(ctx)
 	if err != nil {
 		log.Fatalf("Error detaching session: %s", err)
 	}
@@ -88,16 +88,16 @@ func main() {
 
 	// Create a channel only and do not activate it automatically
 	d.Dial(ctx)
-	defer d.Close()
+	defer d.CloseWithContext(ctx)
 
 	// Activate the previous session on the new channel
-	err = d.ActivateSession(s)
+	err = d.ActivateSessionWithContext(ctx, s)
 	if err != nil {
 		log.Fatalf("Error reactivating session: %s", err)
 	}
 
 	// Read the time again to prove our session is still OK
-	v, err = d.Node(ua.NewNumericNodeID(0, 2258)).Value()
+	v, err = d.Node(ua.NewNumericNodeID(0, 2258)).ValueWithContext(ctx)
 	if err != nil {
 		log.Fatal(err)
 	}

examples/datetime/datetime.go

@@ -51,7 +51,7 @@ func main() {
 	if err := c.Connect(ctx); err != nil {
 		log.Fatal(err)
 	}
-	defer c.CloseSessionWithContext(ctx)
+	defer c.CloseWithContext(ctx)
 
 	v, err := c.Node(ua.NewNumericNodeID(0, 2258)).ValueWithContext(ctx)
 	switch {

examples/history-read/history-read.go

@@ -28,7 +28,7 @@ func main() {
 	if err := c.Connect(ctx); err != nil {
 		log.Fatal(err)
 	}
-	defer c.CloseSessionWithContext(ctx)
+	defer c.CloseWithContext(ctx)
 
 	id, err := ua.ParseNodeID(*nodeID)
 	if err != nil {

examples/method/method.go

@@ -28,7 +28,7 @@ func main() {
 	if err := c.Connect(ctx); err != nil {
 		log.Fatal(err)
 	}
-	defer c.CloseSessionWithContext(ctx)
+	defer c.CloseWithContext(ctx)
 
 	in := int64(12)
 	req := &ua.CallMethodRequest{

examples/monitor/monitor.go

@@ -68,7 +68,7 @@ func main() {
 		log.Fatal(err)
 	}
 
-	defer c.CloseSessionWithContext(ctx)
+	defer c.CloseWithContext(ctx)
 
 	m, err := monitor.NewNodeMonitor(c)
 	if err != nil {

examples/read/read.go

@@ -29,7 +29,7 @@ func main() {
 	if err := c.Connect(ctx); err != nil {
 		log.Fatal(err)
 	}
-	defer c.CloseSessionWithContext(ctx)
+	defer c.CloseWithContext(ctx)
 
 	id, err := ua.ParseNodeID(*nodeID)
 	if err != nil {

examples/regread/regread.go

@@ -29,7 +29,7 @@ func main() {
 	if err := c.Connect(ctx); err != nil {
 		log.Fatal(err)
 	}
-	defer c.CloseSessionWithContext(ctx)
+	defer c.CloseWithContext(ctx)
 
 	id, err := ua.ParseNodeID(*nodeID)
 	if err != nil {

examples/subscribe/subscribe.go

@@ -62,7 +62,7 @@ func main() {
 	if err := c.Connect(ctx); err != nil {
 		log.Fatal(err)
 	}
-	defer c.CloseSessionWithContext(ctx)
+	defer c.CloseWithContext(ctx)
 
 	notifyCh := make(chan *opcua.PublishNotificationData)
 

examples/translate/translate.go

@@ -31,7 +31,7 @@ func main() {
 	if err := c.Connect(ctx); err != nil {
 		log.Fatal(err)
 	}
-	defer c.CloseSessionWithContext(ctx)
+	defer c.CloseWithContext(ctx)
 
 	root := c.Node(ua.NewTwoByteNodeID(id.ObjectsFolder))
 	nodeID, err := root.TranslateBrowsePathInNamespaceToNodeIDWithContext(ctx, uint16(*ns), *nodePath)

examples/trigger/trigger.go

@@ -63,7 +63,7 @@ func main() {
 	if err := c.Connect(ctx); err != nil {
 		log.Fatal(err)
 	}
-	defer c.CloseSessionWithContext(ctx)
+	defer c.CloseWithContext(ctx)
 
 	notifyCh := make(chan *opcua.PublishNotificationData)
 

examples/udt/udt.go

@@ -59,7 +59,7 @@ func main() {
 	if err := c.Connect(ctx); err != nil {
 		log.Fatal(err)
 	}
-	defer c.CloseSessionWithContext(ctx)
+	defer c.CloseWithContext(ctx)
 
 	v, err := c.Node(id).ValueWithContext(ctx)
 	switch {

examples/write/write.go

@@ -30,7 +30,7 @@ func main() {
 	if err := c.Connect(ctx); err != nil {
 		log.Fatal(err)
 	}
-	defer c.CloseSessionWithContext(ctx)
+	defer c.CloseWithContext(ctx)
 
 	id, err := ua.ParseNodeID(*nodeID)
 	if err != nil {