Merge pull request #42 from libp2p/feat/no-dial-option

NoDial context option

interface.go

@@ -149,6 +149,10 @@ type Network interface {
 // There are no addresses associated with a peer when they were needed.
 var ErrNoRemoteAddrs = errors.New("no remote addresses")
 
+// ErrNoConn is returned when attempting to open a stream to a peer with the NoDial
+// option and no usable connection is available.
+var ErrNoConn = errors.New("no usable connection to peer")
+
 // Dialer represents a service that can dial out to peers
 // (this is usually just a Network, but other services may not need the whole
 // stack, and thus it becomes easier to mock)

options.go

@@ -0,0 +1,25 @@
+package net
+
+import (
+	"context"
+)
+
+type noDialCtxKey struct{}
+
+var noDial = noDialCtxKey{}
+
+// WithNoDial constructs a new context with an option that instructs the network
+// to not attempt a new dial when opening a stream.
+func WithNoDial(ctx context.Context, reason string) {
+	context.WithValue(ctx, noDial, reason)
+}
+
+// GetNoDial returns true if the no dial option is set in the context.
+func GetNoDial(ctx context.Context) (nodial bool, reason string) {
+	v := ctx.Value(noDial)
+	if v != nil {
+		return true, v.(string)
+	}
+
+	return false, ""
+}