rename client struct to udpConn

option.go

@@ -16,7 +16,7 @@ func WithRateLimit(ratelimit time.Duration) Option {
 	}
 }
 
-// WithBPSOpt is a functional option to set the bps index for {VbanTx}.{Packet}.bpsIndex
+// WithBPSOpt is a functional option to set the bps index for {VbanTxt}.packet
 func WithBPSOpt(bps int) Option {
 	return func(vt *VbanTxt) {
 		bpsIndex := indexOf(BpsOpts, bps)
@@ -28,7 +28,7 @@ func WithBPSOpt(bps int) Option {
 	}
 }
 
-// WithChannel is a functional option to set the bps index for {VbanTx}.{Packet}.channel
+// WithChannel is a functional option to set the channel for {VbanTxt}.packet
 func WithChannel(channel int) Option {
 	return func(vt *VbanTxt) {
 		vt.packet.channel = channel

udpconn.go

@@ -7,40 +7,40 @@ import (
 	log "github.com/sirupsen/logrus"
 )
 
-// client represents the UDP client
-type client struct {
+// udpConn represents the UDP client
+type udpConn struct {
 	conn *net.UDPConn
 }
 
-// NewClient returns a UDP client
-func newClient(host string, port int) (client, error) {
+// newUDPConn returns a UDP client
+func newUDPConn(host string, port int) (udpConn, error) {
 	udpAddr, err := net.ResolveUDPAddr("udp4", fmt.Sprintf("%s:%d", host, port))
 	if err != nil {
-		return client{}, err
+		return udpConn{}, err
 	}
 	conn, err := net.DialUDP("udp4", nil, udpAddr)
 	if err != nil {
-		return client{}, err
+		return udpConn{}, err
 	}
 	log.Infof("Outgoing address %s", conn.RemoteAddr())
 
-	return client{conn: conn}, nil
+	return udpConn{conn: conn}, nil
 }
 
 // Write implements the io.WriteCloser interface
-func (c client) Write(buf []byte) (int, error) {
-	n, err := c.conn.Write(buf)
+func (u udpConn) Write(buf []byte) (int, error) {
+	n, err := u.conn.Write(buf)
 	if err != nil {
 		return 0, err
 	}
-	log.Debugf("Sending '%s' to: %s", string(buf), c.conn.RemoteAddr())
+	log.Debugf("Sending '%s' to: %s", string(buf), u.conn.RemoteAddr())
 
 	return n, nil
 }
 
 // Close implements the io.WriteCloser interface
-func (c client) Close() error {
-	err := c.conn.Close()
+func (u udpConn) Close() error {
+	err := u.conn.Close()
 	if err != nil {
 		return err
 	}

vbantxt.go

@@ -8,7 +8,7 @@ import (
 
 // VbanTxt is used to send VBAN-TXT requests to a distant Voicemeeter/Matrix.
 type VbanTxt struct {
-	client    io.WriteCloser
+	udpConn   io.WriteCloser
 	packet    packet
 	ratelimit time.Duration
 }
@@ -16,13 +16,13 @@ type VbanTxt struct {
 // New constructs a fully formed VbanTxt instance. This is the package's entry point.
 // It sets default values for it's fields and then runs the option functions.
 func New(host string, port int, streamname string, options ...Option) (*VbanTxt, error) {
-	client, err := newClient(host, port)
+	udpConn, err := newUDPConn(host, port)
 	if err != nil {
 		return nil, fmt.Errorf("error creating UDP client for (%s:%d): %w", host, port, err)
 	}
 
 	vt := &VbanTxt{
-		client:    client,
+		udpConn:   udpConn,
 		packet:    newPacket(streamname),
 		ratelimit: time.Duration(20) * time.Millisecond,
 	}
@@ -37,7 +37,7 @@ func New(host string, port int, streamname string, options ...Option) (*VbanTxt,
 // Send is resonsible for firing each VBAN-TXT request.
 // It waits for {vt.ratelimit} time before returning.
 func (vt VbanTxt) Send(cmd string) error {
-	_, err := vt.client.Write(append(vt.packet.header(), []byte(cmd)...))
+	_, err := vt.udpConn.Write(append(vt.packet.header(), []byte(cmd)...))
 	if err != nil {
 		return fmt.Errorf("error sending command (%s): %w", cmd, err)
 	}
@@ -51,7 +51,7 @@ func (vt VbanTxt) Send(cmd string) error {
 
 // Close is responsible for closing the UDP Client connection
 func (vt VbanTxt) Close() error {
-	err := vt.client.Close()
+	err := vt.udpConn.Close()
 	if err != nil {
 		return fmt.Errorf("error attempting to close UDP Client: %w", err)
 	}