nim-libp2p/libp2p/muxers/mplex/lpchannel.nim

169 lines
5.1 KiB
Nim
Raw Normal View History

2019-09-04 03:08:51 +00:00
## Nim-LibP2P
2019-09-24 17:48:23 +00:00
## Copyright (c) 2019 Status Research & Development GmbH
2019-09-04 03:08:51 +00:00
## 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-09 17:33:32 +00:00
import chronos, chronicles
2019-09-12 17:07:34 +00:00
import types,
2019-09-08 07:59:14 +00:00
coder,
nimcrypto/utils,
2019-09-12 17:07:34 +00:00
../../stream/bufferstream,
../../stream/lpstream,
2019-09-09 17:33:32 +00:00
../../connection
2019-09-04 03:08:51 +00:00
2019-09-10 02:15:52 +00:00
logScope:
2019-09-28 19:54:52 +00:00
topic = "MplexChannel"
2019-09-10 02:15:52 +00:00
const DefaultChannelSize* = DefaultBufferSize * 64 # 64kb
2019-09-06 21:27:55 +00:00
2019-09-04 03:08:51 +00:00
type
2019-09-12 17:07:34 +00:00
LPChannel* = ref object of BufferStream
id*: uint
2019-09-06 21:27:55 +00:00
name*: string
2019-09-04 06:40:11 +00:00
conn*: Connection
2019-09-04 03:08:51 +00:00
initiator*: bool
isLazy*: bool
isOpen*: bool
2019-09-04 03:08:51 +00:00
isReset*: bool
closedLocal*: bool
closedRemote*: bool
handlerFuture*: Future[void]
2019-09-04 06:40:11 +00:00
msgCode*: MessageType
closeCode*: MessageType
resetCode*: MessageType
2019-09-07 23:32:32 +00:00
asyncLock: AsyncLock
2019-09-04 03:08:51 +00:00
proc newChannel*(id: uint,
2019-09-04 06:40:11 +00:00
conn: Connection,
2019-09-04 03:08:51 +00:00
initiator: bool,
2019-09-06 21:27:55 +00:00
name: string = "",
size: int = DefaultChannelSize,
lazy: bool = false): LPChannel =
2019-09-04 03:08:51 +00:00
new result
result.id = id
2019-09-06 21:27:55 +00:00
result.name = name
2019-09-04 06:40:11 +00:00
result.conn = conn
2019-09-04 03:08:51 +00:00
result.initiator = initiator
2019-09-04 06:40:11 +00:00
result.msgCode = if initiator: MessageType.MsgOut else: MessageType.MsgIn
result.closeCode = if initiator: MessageType.CloseOut else: MessageType.CloseIn
result.resetCode = if initiator: MessageType.ResetOut else: MessageType.ResetIn
2019-09-07 23:32:32 +00:00
result.asyncLock = newAsyncLock()
result.isLazy = lazy
2019-09-04 03:08:51 +00:00
2019-09-04 06:40:11 +00:00
let chan = result
proc writeHandler(data: seq[byte]): Future[void] {.async.} =
2019-09-07 23:32:32 +00:00
# writes should happen in sequence
await chan.asyncLock.acquire()
trace "sending data ", data = data.toHex(),
id = chan.id,
initiator = chan.initiator
await conn.writeMsg(chan.id, chan.msgCode, data) # write header
2019-09-07 23:32:32 +00:00
chan.asyncLock.release()
2019-09-04 06:40:11 +00:00
result.initBufferStream(writeHandler, size)
proc closeMessage(s: LPChannel) {.async.} =
await s.conn.writeMsg(s.id, s.closeCode) # write header
2019-09-04 06:40:11 +00:00
proc closedByRemote*(s: LPChannel) {.async.} =
2019-09-04 06:40:11 +00:00
s.closedRemote = true
2019-09-12 17:07:34 +00:00
proc cleanUp*(s: LPChannel): Future[void] =
# method which calls the underlying buffer's `close`
# method used instead of `close` since it's overloaded to
# simulate half-closed streams
2019-09-07 23:32:32 +00:00
result = procCall close(BufferStream(s))
proc open*(s: LPChannel): Future[void] =
s.isOpen = true
s.conn.writeMsg(s.id, MessageType.New, s.name)
2019-09-12 17:07:34 +00:00
method close*(s: LPChannel) {.async, gcsafe.} =
2019-09-04 06:40:11 +00:00
s.closedLocal = true
await s.closeMessage()
proc resetMessage(s: LPChannel) {.async.} =
await s.conn.writeMsg(s.id, s.resetCode)
2019-09-04 06:40:11 +00:00
proc resetByRemote*(s: LPChannel) {.async.} =
2019-09-04 16:40:05 +00:00
await allFutures(s.close(), s.closedByRemote())
2019-09-04 06:40:11 +00:00
s.isReset = true
2019-09-12 17:07:34 +00:00
proc reset*(s: LPChannel) {.async.} =
2019-09-04 16:40:05 +00:00
await allFutures(s.resetMessage(), s.resetByRemote())
2019-09-04 06:40:11 +00:00
method closed*(s: LPChannel): bool =
result = s.closedRemote and s.len == 0
2019-09-04 06:40:11 +00:00
proc pushTo*(s: LPChannel, data: seq[byte]): Future[void] =
if s.closedRemote or s.isReset:
raise newLPStreamEOFError()
trace "pushing data to channel", data = data.toHex(),
id = s.id,
initiator = s.initiator
2019-09-04 06:51:16 +00:00
result = procCall pushTo(BufferStream(s), data)
2019-09-04 06:40:11 +00:00
method read*(s: LPChannel, n = -1): Future[seq[byte]] =
if s.closed or s.isReset:
raise newLPStreamEOFError()
2019-09-04 06:40:11 +00:00
result = procCall read(BufferStream(s), n)
method readExactly*(s: LPChannel,
pbytes: pointer,
nbytes: int):
Future[void] =
if s.closed or s.isReset:
raise newLPStreamEOFError()
2019-09-04 06:40:11 +00:00
result = procCall readExactly(BufferStream(s), pbytes, nbytes)
2019-09-12 17:07:34 +00:00
method readLine*(s: LPChannel,
2019-09-04 06:40:11 +00:00
limit = 0,
sep = "\r\n"):
Future[string] =
if s.closed or s.isReset:
raise newLPStreamEOFError()
2019-09-04 06:40:11 +00:00
result = procCall readLine(BufferStream(s), limit, sep)
method readOnce*(s: LPChannel,
pbytes: pointer,
nbytes: int):
Future[int] =
if s.closed or s.isReset:
raise newLPStreamEOFError()
2019-09-04 06:40:11 +00:00
result = procCall readOnce(BufferStream(s), pbytes, nbytes)
2019-09-12 17:07:34 +00:00
method readUntil*(s: LPChannel,
2019-09-04 06:40:11 +00:00
pbytes: pointer, nbytes: int,
sep: seq[byte]):
Future[int] =
if s.closed or s.isReset:
raise newLPStreamEOFError()
2019-09-04 06:40:11 +00:00
result = procCall readOnce(BufferStream(s), pbytes, nbytes)
template writePrefix: untyped =
if s.isLazy and not s.isOpen:
await s.open()
if s.closedLocal or s.isReset:
raise newLPStreamEOFError()
method write*(s: LPChannel,
pbytes: pointer,
nbytes: int): Future[void] {.async.} =
writePrefix()
2019-09-04 06:40:11 +00:00
result = procCall write(BufferStream(s), pbytes, nbytes)
method write*(s: LPChannel, msg: string, msglen = -1) {.async.} =
writePrefix()
2019-09-04 06:40:11 +00:00
result = procCall write(BufferStream(s), msg, msglen)
method write*(s: LPChannel, msg: seq[byte], msglen = -1) {.async.} =
writePrefix()
2019-09-04 06:40:11 +00:00
result = procCall write(BufferStream(s), msg, msglen)