vacp2p
/
nim-libp2p-experimental
mirror of https://github.com/vacp2p/nim-libp2p-experimental.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

documentation

This commit is contained in:
Dmitriy Ryajov 2019-09-04 00:40:53 -06:00
parent 9b485b3082
commit 80c68206f7
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
libp2p/stream/bufferstream.nim
View File

@ -26,7 +26,7 @@
## and are suspended when not enough data available. This ## and are suspended when not enough data available. This
## allows preserving backpressure while maintaining full ## allows preserving backpressure while maintaining full
## asynchrony. Both writting to the internal buffer with ## asynchrony. Both writting to the internal buffer with
## ``pushTo`` as well as reading with ``read`` and ``readOnce``, ## ``pushTo`` as well as reading with ``read*` methods,
## will suspend until either the amount of elements in the ## will suspend until either the amount of elements in the
## buffer goes below ``maxSize`` or more data becomes available. ## buffer goes below ``maxSize`` or more data becomes available.
@ -165,9 +165,9 @@ method readLine*(s: BufferStream,
break break
inc(index) inc(index)
method readOnce*(s: BufferStream, method readOnce*(s: BufferStream,
pbytes: pointer, pbytes: pointer,
nbytes: int): nbytes: int):
Future[int] {.async, gcsafe.} = Future[int] {.async, gcsafe.} =
## Perform one read operation on read-only stream ``rstream``. ## Perform one read operation on read-only stream ``rstream``.
## ##