libp2p/go-libp2p-core
1
0
Fork 0
mirror of https://github.com/libp2p/go-libp2p-core.git synced 2026-08-18 15:03:28 +08:00
Code Issues Projects Releases Wiki Activity

doc: document Close on Transport (#188)

Browse Source 
fixes libp2p/go-libp2p#999
This commit is contained in:
Steven Allen
2021-03-29 08:41:49 -07:00
committed by GitHub
parent 11f3c3ac0c
commit cfab100b7b
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
transport/transport.go
View File

@@ -54,6 +54,10 @@ type CapableConn interface {
// CapableConn, which means that they have been upgraded to support
// stream multiplexing and connection security (encryption and authentication).
//
// If a transport implements `io.Closer` (optional), libp2p will call `Close` on
// shutdown. NOTE: `Dial` and `Listen` may be called after or concurrently with
// `Close`.
//
// For a conceptual overview, see https://docs.libp2p.io/concepts/transport/
type Transport interface {
// Dial dials a remote peer. It should try to reuse local listener