Change API so that the "Header" option adds one header entry.

Previously an entire header could be appended. While more flexible, most usages just want
to add one or two custom header entries, and this new way looks cleaner. It also removes
the need for the calling program to have a reference to the stomp/frame package.

Author: jjeffery

conn_options.go

@@ -124,9 +124,10 @@ var ConnOpt struct {
 	// shorter time duration during unit testing.
 	HeartBeatError func(errorTimeout time.Duration) func(*Conn) error
 
-	// Header is a connect option that allows the client to specify custom header
-	// elements in the CONNECT/STOMP frame.
-	Header func(header *frame.Header) func(*Conn) error
+	// Header is a connect option that allows the client to specify a custom
+	// header entry in the STOMP frame. This connect option can be specified
+	// multiple times for multiple custom headers.
+	Header func(key, value string) func(*Conn) error
 }
 
 func init() {
@@ -177,9 +178,13 @@ func init() {
 		}
 	}
 
-	ConnOpt.Header = func(header *frame.Header) func(*Conn) error {
+	ConnOpt.Header = func(key, value string) func(*Conn) error {
 		return func(c *Conn) error {
-			c.options.Header = header
+			if c.options.Header == nil {
+				c.options.Header = frame.NewHeader(key, value)
+			} else {
+				c.options.Header.Add(key, value)
+			}
 			return nil
 		}
 	}

conn_test.go

@@ -176,7 +176,7 @@ func (s *StompSuite) Test_successful_connect_with_nonstandard_header(c *C) {
 	client, err := Connect(fc1,
 		ConnOpt.Login("guest", "guest"),
 		ConnOpt.Host("/"),
-		ConnOpt.Header(frame.NewHeader("x-max-length", "50")))
+		ConnOpt.Header("x-max-length", "50"))
 	c.Assert(err, IsNil)
 	c.Assert(client, NotNil)
 	c.Assert(client.Version(), Equals, V10)
@@ -220,17 +220,18 @@ func connectHelper(c *C, version Version) (*Conn, *fakeReaderWriter) {
 func (s *StompSuite) Test_subscribe(c *C) {
 	ackModes := []AckMode{AckAuto, AckClient, AckClientIndividual}
 	versions := []Version{V10, V11, V12}
-	header := frame.NewHeader("id", "client-1", "custom", "true")
 
 	for _, ackMode := range ackModes {
 		for _, version := range versions {
-			subscribeHelper(c, ackMode, version, nil)
-			subscribeHelper(c, ackMode, version, header)
+			subscribeHelper(c, ackMode, version)
+			subscribeHelper(c, ackMode, version,
+				SubscribeOpt.Header("id", "client-1"),
+				SubscribeOpt.Header("custom", "true"))
 		}
 	}
 }
 
-func subscribeHelper(c *C, ackMode AckMode, version Version, header *frame.Header) {
+func subscribeHelper(c *C, ackMode AckMode, version Version, opts ...func(*frame.Frame) error) {
 	conn, rw := connectHelper(c, version)
 	stop := make(chan struct{})
 
@@ -247,16 +248,6 @@ func subscribeHelper(c *C, ackMode AckMode, version Version, header *frame.Heade
 		id, ok := f3.Header.Contains("id")
 		c.Assert(ok, Equals, true)
 
-		if header != nil {
-			for i := 0; i < header.Len(); i++ {
-				k, v := header.GetAt(i)
-				if k != frame.Id {
-					headerV, _ := f3.Header.Contains(k)
-					c.Assert(headerV, Equals, v)
-				}
-			}
-		}
-
 		destination := f3.Header.Get("destination")
 		c.Assert(destination, Equals, "/queue/test-1")
 		ack := f3.Header.Get("ack")
@@ -302,7 +293,7 @@ func subscribeHelper(c *C, ackMode AckMode, version Version, header *frame.Heade
 
 	var sub *Subscription
 	var err error
-	sub, err = conn.Subscribe("/queue/test-1", ackMode, SubscribeOpt.Header(header))
+	sub, err = conn.Subscribe("/queue/test-1", ackMode, opts...)
 
 	c.Assert(sub, NotNil)
 	c.Assert(err, IsNil)

example_test.go

@@ -16,7 +16,7 @@ func ExampleConn_Send(c *stomp.Conn) error {
 		"text/plain",               // content-type
 		[]byte("Message number 1"), // body
 		stomp.SendOpt.Receipt,
-		stomp.SendOpt.Header(frame.NewHeader("expires", "2049-12-31 23:59:59")))
+		stomp.SendOpt.Header("expires", "2049-12-31 23:59:59"))
 	if err != nil {
 		return err
 	}
@@ -122,8 +122,8 @@ func ExampleConn_Subscribe_2(c *stomp.Conn) error {
 	}
 
 	// Subscribe to queue with client acknowledgement and a custom header value
-	customHeader := frame.NewHeader("x-custom-header", "some-value")
-	sub2, err := c.Subscribe("/queue/test-2", stomp.AckClient, stomp.SubscribeOpt.Header(customHeader))
+	sub2, err := c.Subscribe("/queue/test-2", stomp.AckClient,
+		stomp.SubscribeOpt.Header("x-custom-header", "some-value"))
 	if err != nil {
 		return err
 	}
@@ -225,7 +225,7 @@ func ExampleDial_2() error {
 		stomp.ConnOpt.AcceptVersion(stomp.V11),
 		stomp.ConnOpt.AcceptVersion(stomp.V12),
 		stomp.ConnOpt.Host("dragon"),
-		stomp.ConnOpt.Header(frame.NewHeader("nonce", "B256B26D320A")))
+		stomp.ConnOpt.Header("nonce", "B256B26D320A"))
 	if err != nil {
 		return err
 	}

send_options.go

@@ -19,8 +19,10 @@ var SendOpt struct {
 	NoContentType func(*frame.Frame) error
 
 	// Header provides the opportunity to include custom header entries
-	// in the SEND frame that the client sends to the server.
-	Header func(header *frame.Header) func(*frame.Frame) error
+	// in the SEND frame that the client sends to the server. This option
+	// can be specified multiple times if multiple custom header entries
+	// are required.
+	Header func(key, value string) func(*frame.Frame) error
 }
 
 func init() {
@@ -33,12 +35,12 @@ func init() {
 		return nil
 	}
 
-	SendOpt.Header = func(header *frame.Header) func(*frame.Frame) error {
+	SendOpt.Header = func(key, value string) func(*frame.Frame) error {
 		return func(f *frame.Frame) error {
 			if f.Command != frame.SEND {
 				return ErrInvalidCommand
 			}
-			f.Header.AddHeader(header)
+			f.Header.Add(key, value)
 			return nil
 		}
 	}

subscribe_options.go

@@ -8,16 +8,20 @@ import (
 var SubscribeOpt struct {
 	// Header provides the opportunity to include custom header entries
 	// in the SUBSCRIBE frame that the client sends to the server.
-	Header func(header *frame.Header) func(*frame.Frame) error
+	Header func(key, value string) func(*frame.Frame) error
 }
 
 func init() {
-	SubscribeOpt.Header = func(header *frame.Header) func(*frame.Frame) error {
+	SubscribeOpt.Header = func(key, value string) func(*frame.Frame) error {
 		return func(f *frame.Frame) error {
 			if f.Command != frame.SUBSCRIBE {
 				return ErrInvalidCommand
 			}
-			f.Header.AddHeader(header)
+			if f.Header == nil {
+				f.Header = frame.NewHeader(key, value)
+			} else {
+				f.Header.Add(key, value)
+			}
 			return nil
 		}
 	}