nim-libp2p/libp2p/muxers/muxer.nim

93 lines
2.8 KiB
Nim
Raw Normal View History

2022-07-01 18:19:57 +00:00
# Nim-LibP2P
# Copyright (c) 2022 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.
2019-09-03 20:40:51 +00:00
when (NimMajor, NimMinor) < (1, 4):
{.push raises: [Defect].}
else:
{.push raises: [].}
import chronos, chronicles
2019-09-12 17:07:34 +00:00
import ../protocols/protocol,
../stream/connection,
../errors
2019-09-03 20:40:51 +00:00
logScope:
2020-12-01 17:34:27 +00:00
topics = "libp2p muxer"
const
DefaultChanTimeout* = 5.minutes
2019-09-03 20:40:51 +00:00
type
MuxerError* = object of LPError
TooManyChannels* = object of MuxerError
StreamHandler* = proc(conn: Connection): Future[void] {.gcsafe, raises: [Defect].}
MuxerHandler* = proc(muxer: Muxer): Future[void] {.gcsafe, raises: [Defect].}
2019-09-03 20:40:51 +00:00
Muxer* = ref object of RootObj
streamHandler*: StreamHandler
2019-09-03 20:40:51 +00:00
connection*: Connection
2019-11-06 18:09:48 +00:00
# user provider proc that returns a constructed Muxer
MuxerConstructor* = proc(conn: Connection): Muxer {.gcsafe, closure, raises: [Defect].}
2019-11-06 18:09:48 +00:00
2019-09-03 20:40:51 +00:00
# this wraps a creator proc that knows how to make muxers
MuxerProvider* = ref object of LPProtocol
2019-11-06 18:09:48 +00:00
newMuxer*: MuxerConstructor
streamHandler*: StreamHandler # triggered every time there is a new stream, called for any muxer instance
muxerHandler*: MuxerHandler # triggered every time there is a new muxed connection created
2019-09-06 06:51:19 +00:00
func shortLog*(m: Muxer): auto = shortLog(m.connection)
chronicles.formatIt(Muxer): shortLog(it)
2019-11-06 18:09:48 +00:00
# muxer interface
method newStream*(m: Muxer, name: string = "", lazy: bool = false):
Future[Connection] {.base, async, gcsafe.} = discard
2019-09-06 06:51:19 +00:00
method close*(m: Muxer) {.base, async, gcsafe.} = discard
method handle*(m: Muxer): Future[void] {.base, async, gcsafe.} = discard
2019-09-03 20:40:51 +00:00
proc new*(
T: typedesc[MuxerProvider],
creator: MuxerConstructor,
codec: string): T {.gcsafe.} =
let muxerProvider = T(newMuxer: creator)
muxerProvider.codec = codec
muxerProvider.init()
muxerProvider
2019-09-03 20:40:51 +00:00
method init(c: MuxerProvider) =
proc handler(conn: Connection, proto: string) {.async, gcsafe, closure.} =
trace "starting muxer handler", proto=proto, conn
2020-05-23 16:50:05 +00:00
try:
let
muxer = c.newMuxer(conn)
2020-05-23 16:50:05 +00:00
if not isNil(c.streamHandler):
muxer.streamHandler = c.streamHandler
2020-05-23 16:50:05 +00:00
var futs = newSeq[Future[void]]()
futs &= muxer.handle()
2020-05-23 16:50:05 +00:00
# finally await both the futures
if not isNil(c.muxerHandler):
await c.muxerHandler(muxer)
when defined(libp2p_agents_metrics):
conn.shortAgent = muxer.connection.shortAgent
checkFutures(await allFinished(futs))
except CancelledError as exc:
raise exc
2020-05-23 16:50:05 +00:00
except CatchableError as exc:
trace "exception in muxer handler", exc = exc.msg, conn, proto
finally:
await conn.close()
2019-09-03 20:40:51 +00:00
c.handler = handler