diff --git a/unstable/libp2p.html b/unstable/libp2p.html index c7338a063..d2d3b21ce 100644 --- a/unstable/libp2p.html +++ b/unstable/libp2p.html @@ -260,7 +260,7 @@ class="link-seesrc" target="_blank">Source
diff --git a/unstable/libp2p/builders.html b/unstable/libp2p/builders.html index 71884f3ac..4c07e2302 100644 --- a/unstable/libp2p/builders.html +++ b/unstable/libp2p/builders.html @@ -494,9 +494,9 @@ class="link-seesrc" target="_blank">Source Helper for common switch configurations. Source - Edit + Edit @@ -768,7 +768,7 @@ class="link-seesrc" target="_blank">SourcePeerEventKind {.pure.} = enum - Left, Identified, Joined
proc contains(c: ConnManager; conn: Connection): bool {....raises: [], tags: [].}
proc expectConnection(c: ConnManager; p: PeerId; dir: Direction): Future[ - Connection] {.stackTrace: false, ...gcsafe, raises: [], raises: [], raises: [], - tags: [RootEffect].}
proc expectConnection(c: ConnManager; p: PeerId; dir: Direction): Future[Muxer] {. + stackTrace: false, ...gcsafe, raises: [], raises: [], raises: [], + tags: [RootEffect].}
proc getStream(c: ConnManager; conn: Connection): Future[Connection] {....gcsafe, ++@@ -790,9 +769,9 @@ class="link-seesrc" target="_blank">Source get a muxed stream for the passed peer from any connection Source - Edit + Edit proc getStream(c: ConnManager; muxer: Muxer): Future[Connection] {....gcsafe, stackTrace: false, ...gcsafe, raises: [], raises: [], raises: [], tags: [RootEffect].}- -get a muxed stream for the passed connection +get a muxed stream for the passed muxer Source - Edit + Edit
proc selectConn(c: ConnManager; peerId: PeerId): Connection {....raises: [], - tags: [].}
proc selectMuxer(c: ConnManager; peerId: PeerId): Muxer {....raises: [], tags: [].}
proc selectConn(c: ConnManager; peerId: PeerId; dir: Direction): Connection {. ++- proc selectMuxer(c: ConnManager; peerId: PeerId; dir: Direction): Muxer {. ...raises: [], tags: [].}- Select a connection for the provided peer and direction Source - Edit - -
--@@ -909,35 +874,23 @@ class="link-seesrc" target="_blank">Source Source - Edit + Edit- -
proc selectMuxer(c: ConnManager; conn: Connection): Muxer {....raises: [], - tags: [WriteIOEffect, TimeEffect].}- - -select the muxer for the provided connection - Source - Edit + Edit
proc storeConn(c: ConnManager; conn: Connection) {....raises: [Defect, LPError], - raises: [], tags: [WriteIOEffect, TimeEffect, RootEffect].}
proc storeMuxer(c: ConnManager; muxer: Muxer; handle: Future[void] = nil) {. - ...raises: [Defect, CatchableError], raises: [], tags: [RootEffect].}
proc storeMuxer(c: ConnManager; muxer: Muxer) {. + ...raises: [Defect, CatchableError], raises: [], + tags: [WriteIOEffect, TimeEffect, RootEffect].}
proc trackMuxer(cs: ConnectionSlot; mux: Muxer) {....raises: [], tags: [RootEffect].}
Dialer = ref object of Dial localPeerId*: PeerId - ms: MultistreamSelect connManager: ConnManager dialLock: Table[PeerId, AsyncLock] transports: seq[Transport] + peerStore: PeerStore nameResolver: NameResolver
DialFailedError = object of LPError
DialFailedError = object of LPError
proc new(T: type Dialer; localPeerId: PeerId; connManager: ConnManager; - transports: seq[Transport]; ms: MultistreamSelect; ++@@ -359,9 +359,9 @@ class="link-seesrc" target="_blank">Source Source - Edit + Edit proc new(T: type Dialer; localPeerId: PeerId; connManager: ConnManager; + peerStore: PeerStore; transports: seq[Transport]; nameResolver: NameResolver = nil): Dialer- Source - Edit + Edit
proc handle(_: type MultistreamSelect; conn: Connection; protos: seq[string]; + matchers = newSeq[Matcher](); active: bool = false): Future[string] {. + ...gcsafe, stackTrace: false, ...gcsafe, raises: [], raises: [], raises: [].}
proc select(_: MultistreamSelect | type MultistreamSelect; conn: Connection; + proto: seq[string]): Future[string] {.stackTrace: false, ...gcsafe, + raises: [], raises: [], raises: [].}
proc select(_: MultistreamSelect | type MultistreamSelect; conn: Connection; + proto: string): Future[bool] {.stackTrace: false, ...gcsafe, + raises: [], raises: [], raises: [].}
proc select(m: MultistreamSelect; conn: Connection; proto: seq[string]): Future[ - string] {.stackTrace: false, ...gcsafe, raises: [], raises: [], raises: [], - tags: [RootEffect].}
proc select(m: MultistreamSelect; conn: Connection; proto: string): Future[bool] {. - stackTrace: false, ...gcsafe, raises: [], raises: [], raises: [], - tags: [RootEffect].}
Muxer = ref object of RootObj streamHandler*: StreamHandler + handler*: Future[void] connection*: Connection
MuxerProvider = ref object of LPProtocol +
MuxerProvider = object newMuxer*: MuxerConstructor - streamHandler*: StreamHandler - muxerHandler*: MuxerHandler + codec*: string
method getWrapped(channel: YamuxChannel): Connection {....raises: [], tags: [].}
The return value is the number of neighbours that we attempted to send the message to, excluding self. Note that this is an optimistic number of attempts - the number of peers that actually receive the message might be lower.
Source - Edit + Edit @@ -1084,9 +1084,9 @@ class="link-seesrc" target="_blank">Source Source - Edit + Edit @@ -1138,9 +1138,9 @@ class="link-seesrc" target="_blank">Source Source - Edit + Edit @@ -1159,7 +1159,7 @@ class="link-seesrc" target="_blank">Source diff --git a/unstable/libp2p/protocols/pubsub/pubsubpeer.html b/unstable/libp2p/protocols/pubsub/pubsubpeer.html index dbb98a10b..4bfe3ff47 100644 --- a/unstable/libp2p/protocols/pubsub/pubsubpeer.html +++ b/unstable/libp2p/protocols/pubsub/pubsubpeer.html @@ -279,6 +279,11 @@ window.addEventListener("DOMContentLoaded", main2);proc hasSendConn(p: PubSubPeer): bool {....raises: [], tags: [].}
proc isUpgraded(s: Connection): bool {....raises: [], tags: [].}
proc onUpgrade(s: Connection): Future[void] {.stackTrace: false, ...gcsafe, - raises: [], raises: [], raises: [], tags: [RootEffect].}
proc upgrade(s: Connection; failed: ref CatchableError = nil) {....raises: [], - tags: [].}
proc newSwitch(peerInfo: PeerInfo; transports: seq[Transport]; - identity: Identify; secureManagers: openArray[Secure] = []; - connManager: ConnManager; ms: MultistreamSelect; - nameResolver: NameResolver = nil; peerStore = PeerStore.new(); - services = newSeq[Service]()): Switch {. - ...raises: [Defect, LPError], public, ...raises: [], tags: [RootEffect].}
proc newSwitch(peerInfo: PeerInfo; transports: seq[Transport]; + secureManagers: openArray[Secure] = []; connManager: ConnManager; + ms: MultistreamSelect; peerStore: PeerStore; + nameResolver: NameResolver = nil; services = newSeq[Service]()): Switch {. + ...raises: [Defect, LPError], raises: [], tags: [].}
method upgradeIncoming(self: Transport; conn: Connection): Future[void] {.base, +
method upgradeIncoming(self: Transport; conn: Connection): Future[Muxer] {.base, ...gcsafe, raises: [], tags: [].}
method upgradeOutgoing(self: Transport; conn: Connection; peerId: Opt[PeerId]): Future[ - Connection] {.base, ...gcsafe, raises: [], tags: [].}
proc identify(self: MuxedUpgrade; muxer: Muxer): Future[void] {....gcsafe, - stackTrace: false, ...gcsafe, raises: [], raises: [], raises: [], - tags: [RootEffect].}
proc mux(self: MuxedUpgrade; conn: Connection; direction: Direction): Future[ + Muxer] {....gcsafe, stackTrace: false, ...gcsafe, raises: [], raises: [], + raises: [], tags: [RootEffect].}
proc mux(self: MuxedUpgrade; conn: Connection): Future[Muxer] {....gcsafe, - stackTrace: false, ...gcsafe, raises: [], raises: [], raises: [], - tags: [RootEffect].}
proc new(T: type MuxedUpgrade; identity: Identify; muxers: seq[MuxerProvider]; ++@@ -350,30 +331,30 @@ class="link-seesrc" target="_blank">Source proc new(T: type MuxedUpgrade; muxers: seq[MuxerProvider]; secureManagers: openArray[Secure] = []; connManager: ConnManager; ms: MultistreamSelect): T:type {....raises: [].}- Source - Edit + Edit
Methods
method upgradeIncoming(self: MuxedUpgrade; incomingConn: Connection): Future[ - void] {....gcsafe, stackTrace: false, ...gcsafe, raises: [], raises: [], - raises: [], tags: [RootEffect].}
method upgradeIncoming(self: MuxedUpgrade; conn: Connection): Future[Muxer] {. + ...gcsafe, stackTrace: false, ...gcsafe, raises: [], raises: [], raises: [], + tags: [RootEffect].}
method upgradeOutgoing(self: MuxedUpgrade; conn: Connection; peerId: Opt[PeerId]): Future[ - Connection] {....gcsafe, stackTrace: false, ...gcsafe, raises: [], raises: [], - raises: [], tags: [RootEffect].}
Upgrade = ref object of RootObj ms*: MultistreamSelect - identity*: Identify connManager*: ConnManager secureManagers*: seq[Secure]
proc identify(self: Upgrade; conn: Connection): Future[void] {....gcsafe, ++- proc secure(self: Upgrade; conn: Connection; direction: Direction; + peerId: Opt[PeerId]): Future[Connection] {....gcsafe, stackTrace: false, ...gcsafe, raises: [], gcsafe, raises: [], gcsafe, raises: [], tags: [RootEffect].}- -identify the connection - Source - Edit - -
--@@ -348,7 +330,7 @@ class="link-seesrc" target="_blank">Source- -
proc secure(self: Upgrade; conn: Connection; peerId: Opt[PeerId]): Future[ - Connection] {....gcsafe, stackTrace: false, ...gcsafe, raises: [], gcsafe, - raises: [], gcsafe, raises: [], tags: [RootEffect].}- - Source - Edit + Edit
Methods
- method upgradeIncoming(self: Upgrade; conn: Connection): Future[void] {.base, + method upgradeIncoming(self: Upgrade; conn: Connection): Future[Muxer] {.base, ...gcsafe, raises: [], tags: [].}- @@ -362,7 +344,7 @@ class="link-seesrc" target="_blank">Source
@@ -388,7 +370,7 @@ class="link-seesrc" target="_blank">Source- + Muxer] {.base, ...gcsafe, raises: [], tags: [].}
method upgradeOutgoing(self: Upgrade; conn: Connection; peerId: Opt[PeerId]): Future[ - Connection] {.base, ...gcsafe, raises: [], tags: [].}- @@ -378,7 +360,7 @@ class="link-seesrc" target="_blank">Source
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, identify, expandItIMPL, new, IdentifyNoPubKeyError, init, IdentifyPush, AgentVersion, IdentityInvalidMsgError, IdentifyCodec, IdentifyPushHandler, new, IdentifyPushCodec, Identify, init, IdentityNoMatchError, ProtoVersion, push, decodeMsg, IdentifyInfo, IdentifyError, formatItIMPL, new, init, readMessage, shortLog, codec=, getWrapped, init, secure, readOnce, maxIncomingStreams=, codec, closeImpl, maxIncomingStreams, DefaultMaxIncomingStreams, start, initStream, LPProtoHandler, Secure, handshake, SecureConn, new, SecureConnTrackerName, LPProtocol, stop, addHandler, MsgSize, handle, MultiStreamError, Ls, Codec, addHandler, start, MultistreamSelect, new, HandlerHolder, list, addHandler, select, select, stop, Matcher, MSCodec, select, Na +newLPStreamWriteError, DNS_OR_IP, shortLog, init, random, $, getProtoHeader, MaError, ephemeral, decode, MaPatternOp, HTTP, initVBuffer, getProtoHeader, decode, MaxSizeError, ProtoHeader, ==, getLen, ECDHEScheme, shortLog, 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, 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, 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, identify, expandItIMPL, new, IdentifyNoPubKeyError, init, IdentifyPush, AgentVersion, IdentityInvalidMsgError, IdentifyCodec, IdentifyPushHandler, new, IdentifyPushCodec, Identify, init, IdentityNoMatchError, ProtoVersion, push, decodeMsg, IdentifyInfo, IdentifyError, formatItIMPL, new, init, readMessage, shortLog, codec=, getWrapped, init, secure, readOnce, maxIncomingStreams=, codec, closeImpl, maxIncomingStreams, DefaultMaxIncomingStreams, start, initStream, LPProtoHandler, Secure, handshake, SecureConn, new, SecureConnTrackerName, LPProtocol, stop, addHandler, start, MultiStreamError, handle, addHandler, list, new, HandlerHolder, stop, addHandler, select, select, Matcher, MultistreamSelect, select, handle