From b0f4b7c89dba78094259039f99df93a7f817b2ae Mon Sep 17 00:00:00 2001 From: Jeromy Date: Sat, 8 Nov 2014 20:44:48 -0800 Subject: [PATCH] some net docs --- net/conn/interface.go | 7 +++---- net/interface.go | 4 ++-- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/net/conn/interface.go b/net/conn/interface.go index 689b6c9d6..47f25540d 100644 --- a/net/conn/interface.go +++ b/net/conn/interface.go @@ -22,7 +22,7 @@ type Conn interface { // LocalMultiaddr is the Multiaddr on this side LocalMultiaddr() ma.Multiaddr - // LocalPeer is the Peer on this side + // LocalPeer is the Peer on our side of the connection LocalPeer() peer.Peer // RemoteMultiaddr is the Multiaddr on the remote side @@ -37,10 +37,9 @@ type Conn interface { // Out returns a writable message channel Out() chan<- []byte + // Get an error from this conn if one is available + // TODO: implement a better error handling system GetError() error - - // Close ends the connection - // Close() error -- already in ContextCloser } // Dialer is an object that can open connections. We could have a "convenience" diff --git a/net/interface.go b/net/interface.go index 832588490..04a74c0bf 100644 --- a/net/interface.go +++ b/net/interface.go @@ -59,9 +59,9 @@ type Handler srv.Handler // Service interface for network resources. type Service srv.Service -// Dialer service that can dial to peers +// Dialer represents a service that can dial out to peers // (this is usually just a Network, but other services may not need the whole -// thing, and thus it becomes easier to mock) +// stack, and thus it becomes easier to mock) type Dialer interface { // DialPeer attempts to establish a connection to a given peer