Move off of outbound errors for start/stop

yarpc · Nov 8, 2016 · ab9c17f · ab9c17f
1 parent 2d7059c
commit ab9c17f
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 6 deletions.
diff --git a/internal/errors/peers.go b/internal/errors/peers.go
@@ -31,3 +31,19 @@ type ErrInvalidPeerType struct {
 func (e ErrInvalidPeerType) Error() string {
 	return fmt.Sprintf("expected peer type (%s) but got peer (%v)", e.ExpectedType, e.PeerIdentifier)
 }
+
+// ErrPeerListAlreadyStarted represents a failure because Start() was already
+// called on the peerlist.
+type ErrPeerListAlreadyStarted string
+
+func (e ErrPeerListAlreadyStarted) Error() string {
+	return fmt.Sprintf("%s has already been started", string(e))
+}
+
+// ErrPeerListNotStarted represents a failure because Start() was not called
+// on a peerlist or if Stop() was called.
+type ErrPeerListNotStarted string
+
+func (e ErrPeerListNotStarted) Error() string {
+	return fmt.Sprintf("%s has not been started or was stopped", string(e))
+}
diff --git a/transport/peer/peerlist/single.go b/transport/peer/peerlist/single.go
@@ -26,7 +26,7 @@ func NewSingle(pi transport.PeerIdentifier, agent transport.PeerAgent) transport
 
 func (pl *single) Start() error {
 	if pl.started.Swap(true) {
-		return errors.ErrOutboundAlreadyStarted("single")
+		return errors.ErrPeerListAlreadyStarted("single")
 	}
 	peer, err := pl.agent.RetainPeer(pl.peerID, pl)
 	if err != nil {
@@ -39,7 +39,7 @@ func (pl *single) Start() error {
 
 func (pl *single) Stop() error {
 	if !pl.started.Swap(false) {
-		return errors.ErrOutboundNotStarted("single")
+		return errors.ErrPeerListNotStarted("single")
 	}
 	err := pl.agent.ReleasePeer(pl.peerID, pl)
 	if err != nil {
@@ -52,7 +52,7 @@ func (pl *single) Stop() error {
 
 func (pl *single) ChoosePeer(context.Context, *transport.Request) (transport.Peer, error) {
 	if !pl.started.Load() {
-		return nil, errors.ErrOutboundNotStarted("peerlist was not started")
+		return nil, errors.ErrPeerListNotStarted("single")
 	}
 	return pl.peer, nil
 }

diff --git a/transport/peer/peerlist/single_test.go b/transport/peer/peerlist/single_test.go
@@ -58,7 +58,7 @@ func TestSingle(t *testing.T) {
 				return pl.Stop()
 			}
 
-			s.expectedErr = errors.ErrOutboundNotStarted("single")
+			s.expectedErr = errors.ErrPeerListNotStarted("single")
 			s.expectedPeerID = s.pid
 			s.expectedAgent = s.agent
 			s.expectedStarted = false
@@ -78,7 +78,7 @@ func TestSingle(t *testing.T) {
 			s.expectedStarted = false
 			s.expectedChooseResults = []expectedChooseResult{{
 				peer: nil,
-				err:  errors.ErrOutboundNotStarted("peerlist was not started"),
+				err:  errors.ErrPeerListNotStarted("single"),
 			}}
 			return
 		}(),
@@ -133,7 +133,7 @@ func TestSingle(t *testing.T) {
 				return pl.Start()
 			}
 
-			s.expectedErr = errors.ErrOutboundAlreadyStarted("single")
+			s.expectedErr = errors.ErrPeerListAlreadyStarted("single")
 			s.expectedPeerID = s.pid
 			s.expectedAgent = s.agent
 			s.expectedStarted = true