add: client.Done()

Author: mdigger

client.go

@@ -18,6 +18,7 @@ type Client struct {
 	chErr  chan error
 	chResp chan response
 	closer io.Closer
+	done   chan struct{}
 }
 
 // Default timeout options.
@@ -72,6 +73,7 @@ func NewClient(rwc io.ReadWriteCloser, password string, opts ...Option) (*Client
 		chErr:  make(chan error, 1),
 		chResp: make(chan response),
 		closer: rwc,
+		done:   make(chan struct{}),
 	}
 
 	go client.runReader(cfg.events, cfg.autoClose)
@@ -87,6 +89,11 @@ func (c *Client) Close() error {
 	return c.closer.Close() //nolint:wrapcheck
 }
 
+// Done returns a channel that will be closed when the client connection is closed.
+func (c *Client) Done() <-chan struct{} {
+	return c.done
+}
+
 // API sends a command to the API and returns the response body or an error.
 //
 // Send a FreeSWITCH API command, blocking mode. That is, the FreeSWITCH
@@ -265,6 +272,7 @@ func (c *Client) runReader(events chan<- Event, autoClose bool) {
 	defer func() {
 		close(c.chResp)
 		close(c.chErr)
+		close(c.done)
 
 		if autoClose && events != nil {
 			close(events)

example_test.go

@@ -6,6 +6,7 @@ import (
 	"github.com/mdigger/esl"
 )
 
+//nolint:testableexamples
 func Example() {
 	// initialize buffered events channel
 	events := make(chan esl.Event, 1)
@@ -37,14 +38,7 @@ func Example() {
 	}
 
 	// read events
-	go func() {
-		for ev := range events {
-			fmt.Println(ev.Name(), ev.Get("Job-UUID"))
-		}
-	}()
-
-	//Output:
-	// 0 total.
-	//
-	// BACKGROUND_JOB test-xxx
+	for ev := range events {
+		fmt.Println(ev.Name(), ev.Get("Job-UUID"))
+	}
 }