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: [], 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: [], raises: [], tags: [RootEffect].}
  Source   Edit
method readOnce(s: BufferStream; pbytes: pointer; nbytes: int): Future[int] {.
    stackTrace: false, ...gcsafe, raises: [], raises: [], raises: [],
    tags: [RootEffect].}
  Source   Edit

Templates

template formatItIMPL(it: BufferStream): auto
  Source   Edit

Exports

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