libp2p/stream/bufferstream

    Dark Mode
Search:
Group by:
  Source   Edit

Types

BufferStream = ref object of Connection
  readQueue*: AsyncQueue[seq[byte]]
  readBuf*: StreamSeq
  pushing*: bool
  reading*: bool
  pushedEof*: bool
  returnedEof*: bool
  Source   Edit

Consts

BufferStreamTrackerName = "BufferStream"
  Source   Edit

Procs

proc len(s: BufferStream): int {....raises: [], tags: [].}
  Source   Edit
proc new(T: typedesc[BufferStream]; timeout: Duration = DefaultConnectionTimeout): T:type {.
    ...raises: [].}
  Source   Edit
func shortLog(s: BufferStream): auto {....raises: [], tags: [].}
  Source   Edit

Methods

method atEof(s: BufferStream): bool {....raises: [], tags: [].}
  Source   Edit
method closeImpl(s: BufferStream): Future[void] {....raises: [], tags: [RootEffect].}
close the stream and clear the buffer   Source   Edit
method initStream(s: BufferStream) {....raises: [], tags: [TimeEffect, RootEffect].}
  Source   Edit
method pushData(s: BufferStream; data: seq[byte]): Future[void] {.base,
    stackTrace: false, ...gcsafe, raises: [], raises: [], tags: [RootEffect].}

Write bytes to internal read buffer, use this to fill up the buffer with data.

pushTo will block if the queue is full, thus maintaining backpressure.

  Source   Edit
method pushEof(s: BufferStream): Future[void] {.base, stackTrace: false, ...gcsafe,
    raises: [], raises: [], tags: [RootEffect].}
  Source   Edit
method readOnceX(s: BufferStream; pbytes: pointer; nbytes: int;
                 info: tuple[filename: string, line: int, column: int]): Future[
    int] {.stackTrace: false, ...gcsafe, raises: [], raises: [], tags: [RootEffect].}
  Source   Edit

Templates

template formatItIMPL(it: BufferStream): auto
  Source   Edit
template readOnce(s: BufferStream; pbytes: pointer; nbytes: int): untyped
  Source   Edit

Exports

newLPStreamWriteError, getProtoHeader, shortLog, init, random, $, MaError, ephemeral, MaPatternOp, HTTP, initVBuffer, getProtoHeader, MaxSizeError, ProtoHeader, ==, getLen, ECDHEScheme, shortLog, isUpgraded, closed, [], shuffle, random, init, VBuffer, Secret, peekVarint, random, $, validate, mapOr, init, maxInlineKeyLength, TranscoderDNS, QUIC, [], init, ephemeral, getRequiredField, getField, supported, getWrapped, getBytes, public, MAKind, write, write, init, getField, checkFieldNumber, init, getRepeatedField, matchPartial, getBytes, len, ==, init, readLp, init, initVBuffer, atEof, peekSeq, payloadType, <=, LPStreamError, init, decode, IP, protoAddress, newRng, DefaultConnectionTimeout, checkValid, getPublicKey, decodeProposal, len, CircuitRelay, extractPublicKey, mapAnd, new, verify, new, newLPStreamEOFError, ==, DNSADDR, hash, init, write, WSS, LPStream, writePacked, init, init, writeLpX, readSeq, toBytes, shortLog, encode, TranscoderIP4, init, protoName, toRawBytes, TranscoderIP6Zone, $, initProtoBuffer, newLPStreamReadError, init, match, writeLPVarint, CryptoResult, ProtoResult, WebRTCDirect, init, UDP, TranscoderOnion, StreamTracker, write, init, finish, isEmpty, writeArray, writeLp, shcopy, LPStreamIncompleteError, PeerId, LPStreamEOFError, IP6, shortLog, initVBuffer, decode, ProtoFlags, PKScheme, TimeoutHandler, payload, stretchKeys, Connection, write, TCP, PrivateKey, getBytes, write, &=, PeerInfoError, hash, newLPStreamClosedError, close, initProtoBuffer, toException, DNS, MAProtocol, upgrade, UTP, goffset, getRawBytes, >, KeyPair, init, high, toString, cmp, init, SupportedWireTypes, readOnceX, formatItIMPL, formatItIMPL, formatItIMPL, Signature, formatItIMPL, toBytes, DigestSheme, IPFS, readOnce, init, isEmpty, MultiAddress, ProtoScalar, shortLog, LPStreamIncorrectDefect, hex, protocols, HTTPS, tryAndWarn, len, LPError, getPtr, write, sign, encode, MaResult, init, ProtoField, toBytes, writeSeq, init, &, DNS6, closeX, IpTransportProtocol, toOpenArray, init, allFuturesThrowing, IP4, TranscoderPort, isEnough, write, getField, DNSANY, createExchange, >=, init, mac, payloadDomain, $, LPStreamLimitError, libp2p_pki_schemes, SignedPayload, finish, closeImpl, toBytes, newLPStreamLimitError, write, keyOpenArray, match, $, closeImpl, isEmpty, LPStreamReadError, getRequiredRepeatedField, init, newLPStreamIncompleteError, newLPStreamReadError, initProtoBuffer, getPackedRepeatedField, initStream, contains, shortLog, DNS4, readArray, selectBest, newLPStreamIncorrectDefect, P2PPattern, Envelope, hasPublicKey, toException, init, isEnough, Reliable, hex, ProtoBuffer, write, decode, WS, readVarint, encode, init, init, init, getField, match, getField, <, iv, onUpgrade, readLine, Eof, CryptoError, getField, append, MaPattern, vsizeof, init, peekArray, UNIX, PeerRecord, key, SupportedSchemes, update, getRepeatedField, LPStreamWriteError, getField, RsaDefaultKeySize, writeX, hash, Unreliable, SupportedSchemesInt, random, checkFutures, macOpenArray, init, validate, $, protoCode, mapEq, getField, init, write, LPStreamTrackerName, concat, TranscoderP2P, PeerInfo, AddressInfo, ConnectionTrackerName, TranscoderIP6, init, write, EnvelopeError, encode, WebSockets, MaxMessageSize, createProposal, MaPatResult, Direction, init, InvalidVarintError, shortLog, ==, init, write, getBytes, write, readLpX, PublicKey, writeLp, writePBVarint, ProtoFieldKind, readExactly, protoArgument, getRepeatedField, ProtoError, init, initStream, getField, readVarint, writeLpX, ivOpenArray, closeWithEOF, orError, decodeExchange, getField, MaInvalidAddress, LPStreamClosedError, writeVarint, items, write, getOrder, [], TranscoderUnix, SignedPeerRecord, join