nim-libp2p/libp2p/stream/chronosstream.nim

## Nim-LibP2P
## 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 chronos, chronicles
import lpstream

logScope:
  topic = "ChronosStream"

type ChronosStream* = ref object of LPStream
    reader: AsyncStreamReader
    writer: AsyncStreamWriter
    server: StreamServer
    client: StreamTransport

proc newChronosStream*(server: StreamServer,
                       client: StreamTransport): ChronosStream =
  new result
  result.server = server
  result.client = client
  result.reader = newAsyncStreamReader(client)
  result.writer = newAsyncStreamWriter(client)
  result.closeEvent = newAsyncEvent()

template withExceptions(body: untyped) =
  try:
    body
  except TransportIncompleteError:
    raise newLPStreamIncompleteError()
  except TransportLimitError:
    raise newLPStreamLimitError()
  except TransportError as exc:
    raise newLPStreamIncorrectError(exc.msg)
  except AsyncStreamIncompleteError:
    raise newLPStreamIncompleteError()

method read*(s: ChronosStream, n = -1): Future[seq[byte]] {.async.} =
  if s.reader.atEof:
    raise newLPStreamEOFError()

  withExceptions:
    result = await s.reader.read(n)

method readExactly*(s: ChronosStream,
                    pbytes: pointer,
                    nbytes: int): Future[void] {.async.} =
  if s.reader.atEof:
    raise newLPStreamEOFError()

  withExceptions:
    await s.reader.readExactly(pbytes, nbytes)

method readLine*(s: ChronosStream, limit = 0, sep = "\r\n"): Future[string] {.async.} =
  if s.reader.atEof:
    raise newLPStreamEOFError()

  withExceptions:
    result = await s.reader.readLine(limit, sep)

method readOnce*(s: ChronosStream, pbytes: pointer, nbytes: int): Future[int] {.async.} =
  if s.reader.atEof:
    raise newLPStreamEOFError()

  withExceptions:
    result = await s.reader.readOnce(pbytes, nbytes)

method readUntil*(s: ChronosStream,
                  pbytes: pointer,
                  nbytes: int,
                  sep: seq[byte]): Future[int] {.async.} =
  if s.reader.atEof:
    raise newLPStreamEOFError()

  withExceptions:
    result = await s.reader.readUntil(pbytes, nbytes, sep)

method write*(s: ChronosStream, pbytes: pointer, nbytes: int) {.async.} =
  if s.writer.atEof:
    raise newLPStreamEOFError()

  withExceptions:
    await s.writer.write(pbytes, nbytes)

method write*(s: ChronosStream, msg: string, msglen = -1) {.async.} =
  if s.writer.atEof:
    raise newLPStreamEOFError()

  withExceptions:
    await s.writer.write(msg, msglen)

method write*(s: ChronosStream, msg: seq[byte], msglen = -1) {.async.} =
  if s.writer.atEof:
    raise newLPStreamEOFError()

  withExceptions:
    await s.writer.write(msg, msglen)

method closed*(s: ChronosStream): bool {.inline.} =
  # TODO: we might only need to check for reader's EOF
  result = s.reader.atEof()

method close*(s: ChronosStream) {.async.} =
  if not s.closed:
    trace "shutting chronos stream", address = $s.client.remoteAddress()
    if not s.writer.closed():
      await s.writer.closeWait()

    if not s.reader.closed():
      await s.reader.closeWait()

    if not s.client.closed():
      await s.client.closeWait()

    s.closeEvent.fire()