nim-libp2p/libp2p/connection.nim

150 lines
4.3 KiB
Nim
Raw Normal View History

## Nim-LibP2P
2019-09-24 17:48:23 +00:00
## Copyright (c) 2019 Status Research & Development GmbH
## Licensed under either of
## * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE))
## * MIT license ([LICENSE-MIT](LICENSE-MIT))
## at your option.
## This file may not be copied, modified, or distributed except according to
## those terms.
import oids
import chronos, chronicles, metrics
import peerinfo,
errors,
multiaddress,
stream/lpstream,
peerinfo
export lpstream
logScope:
topic = "Connection"
const
ConnectionTrackerName* = "libp2p.connection"
type
2019-08-27 21:45:21 +00:00
Connection* = ref object of LPStream
peerInfo*: PeerInfo
2019-08-30 05:15:43 +00:00
stream*: LPStream
2019-09-12 17:07:34 +00:00
observedAddrs*: Multiaddress
# notice this is a ugly circular reference collection
# (we got many actually :-))
readLoops*: seq[Future[void]]
ConnectionTracker* = ref object of TrackerBase
opened*: uint64
closed*: uint64
proc setupConnectionTracker(): ConnectionTracker {.gcsafe.}
proc getConnectionTracker*(): ConnectionTracker {.gcsafe.} =
result = cast[ConnectionTracker](getTracker(ConnectionTrackerName))
if isNil(result):
result = setupConnectionTracker()
proc dumpTracking(): string {.gcsafe.} =
var tracker = getConnectionTracker()
result = "Opened conns: " & $tracker.opened & "\n" &
"Closed conns: " & $tracker.closed
proc leakTransport(): bool {.gcsafe.} =
var tracker = getConnectionTracker()
result = (tracker.opened != tracker.closed)
proc setupConnectionTracker(): ConnectionTracker =
result = new ConnectionTracker
result.opened = 0
result.closed = 0
result.dump = dumpTracking
result.isLeaked = leakTransport
addTracker(ConnectionTrackerName, result)
declareGauge libp2p_open_connection, "open Connection instances"
proc `$`*(conn: Connection): string =
if not isNil(conn.peerInfo):
result = $(conn.peerInfo)
2020-04-07 15:49:43 +00:00
proc bindStreamClose(conn: Connection) {.async.} =
# bind stream's close event to connection's close
# to ensure correct close propagation
if not isNil(conn.stream.closeEvent):
await conn.stream.closeEvent.wait()
trace "wrapped stream closed, about to close conn",
closed = conn.isClosed, conn = $conn
2020-04-07 15:49:43 +00:00
if not conn.isClosed:
trace "wrapped stream closed, closing conn",
closed = conn.isClosed, conn = $conn
await conn.close()
2020-04-07 15:49:43 +00:00
proc init[T: Connection](self: var T, stream: LPStream): T =
## create a new Connection for the specified async reader/writer
new self
self.stream = stream
self.closeEvent = newAsyncEvent()
when chronicles.enabledLogLevel == LogLevel.TRACE:
self.oid = genOid()
2020-04-07 15:49:43 +00:00
asyncCheck self.bindStreamClose()
inc getConnectionTracker().opened
libp2p_open_connection.inc()
2020-04-07 15:49:43 +00:00
return self
2019-09-04 21:21:12 +00:00
proc newConnection*(stream: LPStream): Connection =
## create a new Connection for the specified async reader/writer
result.init(stream)
2019-08-26 15:37:15 +00:00
method readExactly*(s: Connection,
pbytes: pointer,
nbytes: int):
2019-09-02 20:45:00 +00:00
Future[void] {.gcsafe.} =
s.stream.readExactly(pbytes, nbytes)
2019-08-26 15:37:15 +00:00
method readOnce*(s: Connection,
pbytes: pointer,
nbytes: int):
2019-09-02 20:45:00 +00:00
Future[int] {.gcsafe.} =
2020-02-05 17:54:03 +00:00
s.stream.readOnce(pbytes, nbytes)
method write*(s: Connection,
msg: seq[byte]):
2019-09-02 20:45:00 +00:00
Future[void] {.gcsafe.} =
s.stream.write(msg)
2019-08-21 22:53:16 +00:00
method closed*(s: Connection): bool =
if isNil(s.stream):
return true
result = s.stream.closed
2019-08-30 15:28:07 +00:00
method close*(s: Connection) {.async, gcsafe.} =
trace "about to close connection", closed = s.closed, conn = $s
if not s.isClosed:
s.isClosed = true
inc getConnectionTracker().closed
if not isNil(s.stream) and not s.stream.closed:
trace "closing child stream", closed = s.closed, conn = $s
try:
await s.stream.close()
except CancelledError as exc:
raise exc
except CatchableError as exc:
debug "Error while closing child stream", err = exc.msg
2020-04-03 20:36:51 +00:00
s.closeEvent.fire()
trace "waiting readloops", count=s.readLoops.len, conn = $s
let loopFuts = await allFinished(s.readLoops)
checkFutures(loopFuts)
s.readLoops = @[]
2020-04-06 21:33:44 +00:00
trace "connection closed", closed = s.closed, conn = $s
libp2p_open_connection.dec()
2019-08-30 15:28:07 +00:00
method getObservedAddrs*(c: Connection): Future[MultiAddress] {.base, async, gcsafe.} =
## get resolved multiaddresses for the connection
2019-09-12 17:07:34 +00:00
result = c.observedAddrs