TCP transport implementation
Types
TcpTransport = ref object of Transport servers*: seq[StreamServer] clients: array[Direction, seq[StreamTransport]] flags: set[ServerFlags] clientFlags: set[SocketFlags] acceptFuts: seq[AcceptFuture] connectionsTimeout: Duration stopping: bool
- Source Edit
TcpTransportError = object of transport.TransportError
- Source Edit
Consts
TcpTransportTrackerName = "libp2p.tcptransport"
- Source Edit
Procs
proc connHandler(self: TcpTransport; client: StreamTransport; observedAddr: Opt[MultiAddress]; dir: Direction): Connection {. ...raises: [], raises: [], raises: [], tags: [TimeEffect, RootEffect].}
- Source Edit
proc new(T: typedesc[TcpTransport]; flags: set[ServerFlags] = {}; upgrade: Upgrade; connectionsTimeout = 10.minutes): T:type {.public, ...raises: [].}
- Source Edit
Methods
method accept(self: TcpTransport): InternalRaisesFuture[Connection, (TransportError, CancelledError)] {.stackTrace: false, ...raises: [], gcsafe, raises: [], raises: [], tags: [RootEffect].}
-
accept a new TCP connection, returning nil on non-fatal errors
Raises an exception when the transport is broken and cannot be used for accepting further connections
Source Edit method dial(self: TcpTransport; hostname: string; address: MultiAddress; peerId: Opt[PeerId] = Opt.none(PeerId)): InternalRaisesFuture[ Connection, (TransportError, CancelledError)] {.stackTrace: false, ...raises: [], gcsafe, raises: [], raises: [], tags: [RootEffect].}
- dial a peer Source Edit
method handles(t: TcpTransport; address: MultiAddress): bool {....raises: [], raises: [], tags: [].}
- Source Edit
method start(self: TcpTransport; addrs: seq[MultiAddress]): InternalRaisesFuture[ void, (LPError, TransportError)] {.stackTrace: false, ...raises: [], gcsafe, raises: [], raises: [], tags: [RootEffect].}
- Start transport listening to the given addresses - for dial-only transports, start with an empty list Source Edit
method stop(self: TcpTransport): InternalRaisesFuture[void, void] {. stackTrace: false, ...raises: [], gcsafe, raises: [], raises: [], tags: [RootEffect].}
- Source Edit
Exports
-
TransportInvalidAddrError, dial, upgrade, Transport, newTransportClosedError, TransportDialError, safeCloseWait, stop, accept, TransportError, TransportClosedError, NetworkReachability, handles, dial, safeClose, start, DNS_OR_IP, ==, shortLog, init, random, UDP_DNS, MaError, ephemeral, MaPattern, MaPatternOp, ==, WS_DNS, initVBuffer, <=, decode, filterIt, ECDHEScheme, shortLog, init, closed, [], MaxSizeError, shuffle, random, init, Secret, peekVarint, random, $, validate, mac, init, Memory, bytes, maxInlineKeyLength, TranscoderDNS, QUIC, [], init, ephemeral, withValue, WS_IP, public, MAKind, write, write, init, getField, valueOr, init, getRepeatedField, matchPartial, libp2p_pki_schemes, getBytes, WebSockets, init, readLp, HTTP, initVBuffer, atEof, LPStreamTrackerName, peekSeq, toOpt, join, fullAddrs, payloadType, LPStreamError, init, $, IP, protoAddress, QUIC_V1_IP, newRng, ==, withValue, checkValid, getPublicKey, len, CircuitRelay, extractPublicKey, mapAnd, new, maErr, UDP_IP, new, newLPStreamEOFError, init, DNSADDR, AddressMapper, write, WSS, LPStream, QUIC_V1, TCP_IP, init, closeImpl, readSeq, toBytes, TCP_DNS, shortLog, encode, len, capLen, init, protoName, protoArgument, ==, toRawBytes, TranscoderIP6Zone, $, init, WSS_DNS, match, writeLPVarint, CryptoResult, parseFullAddress, init, WebRTCDirect, init, UDP, PeerInfo, TranscoderOnion, StreamTracker, write, init, LPStreamResetError, writeArray, getRawBytes, LPStreamIncompleteError, [], LPStreamEOFError, IP6, shortLog, decode, initVBuffer, PKScheme, payload, init, Connection, write, TCP, PrivateKey, getBytes, write, init, &=, PeerInfoError, newLPStreamClosedError, random, compilesOr, TranscoderMemory, close, TranscoderIP4, init, toException, DNS, init, goffset, >, KeyPair, high, toString, init, cmp, init, DefaultConnectionTimeout, formatItIMPL, formatItIMPL, formatItIMPL, Signature, contains, exclIfIt, formatItIMPL, toBytes, DigestSheme, IPFS, getField, readOnce, init, isEmpty, data, shortLog, hex, protocols, hash, HTTPS, UNIX, LPError, TLS_WS, sign, init, encode, supported, MaResult, toBytes, writeSeq, init, &, DNS6, decode, IpTransportProtocol, init, IP4, TranscoderPort, writeLp, getBytes, safeConvert, init, >=, QUIC_V1_DNS, payloadDomain, $, withValue, init, LPStreamLimitError, TranscoderOnion3, SignedPayload, toBytes, newLPStreamLimitError, write, keyOpenArray, match, WebSockets_DNS, $, isEmpty, init, newLPStreamIncompleteError, MAProtocol, newLPStreamResetError, initStream, init, getField, shortLog, DNS4, MultiAddress, getWrapped, selectBest, P2PPattern, Envelope, hasPublicKey, toException, isEnough, DNSANY, finish, Reliable, addrs, hex, closeImpl, write, WS, stretchKeys, encode, init, getField, match, readArray, <, iv, readLine, Eof, CryptoError, append, hash, init, parseFullAddress, WSS_IP, LPStreamConnDownError, peekArray, PeerRecord, init, SupportedSchemes, getField, RsaDefaultKeySize, hash, Unreliable, SupportedSchemesInt, random, checkFutures, macOpenArray, init, validate, $, mapEq, Onion3, TcpOnion3, concat, TranscoderP2P, AddressInfo, ConnectionTrackerName, TranscoderIP6, write, EnvelopeError, encode, len, newLPStreamRemoteClosedError, MaPatResult, Direction, key, InvalidVarintError, shortLog, items, init, write, getBytes, write, UTP, readVarint, verify, TimeoutHandler, QUIC_IP, PublicKey, WebSockets_IP, VBuffer, writeLp, writePBVarint, readExactly, protoArgument, mapOr, newLPStreamConnDownError, init, initStream, readVarint, ivOpenArray, closeWithEOF, orError, getField, LPStreamRemoteClosedError, protoCode, MaInvalidAddress, LPStreamClosedError, PeerId, write, getOrder, QUIC_DNS, update, TranscoderUnix, SignedPeerRecord, writeVarint, DNS_OR_IP, ==, AlreadyExpectingConnectionError, shortLog, init, MaxSizeError, random, new, UDP_DNS, $, MaxConnectionsPerPeer, ephemeral, decode, MaPattern, MaPatternOp, ==, WS_DNS, initVBuffer, <=, LPError, handler, filterIt, ECDHEScheme, shortLog, init, closed, addConnEventHandler, [], new, shuffle, random, init, new, Secret, peekVarint, random, handshake, handle, MaxConnections, $, validate, mapOr, MaError, init, secure, Memory, UpgradeFailedError, IdentityInvalidMsgError, maxInlineKeyLength, addHandler, TranscoderDNS, QUIC, ProtoVersion, [], init, ephemeral, withValue, mac, init, removeConnEventHandler, WS_IP, write, public, MAKind, write, write, decode, init, getField, valueOr, DNSANY, codec, getRepeatedField, matchPartial, addObservation, libp2p_pki_schemes, push, getBytes, len, trackConnection, ==, init, readLp, HTTP, initVBuffer, start, atEof, finish, PeerEventKind, getOutgoingSlot, peekSeq, toOpt, join, fullAddrs, payloadType, LPStreamError, init, IP, protoAddress, QUIC_V1_IP, newRng, ==, withValue, SecureConn, checkValid, handle, getPublicKey, len, libp2p_failed_upgrades_incoming, CircuitRelay, extractPublicKey, mapAnd, new, maErr, UDP_IP, new, newLPStreamEOFError, selectMuxer, connCount, DNSADDR, handler, AddressMapper, IdentifyPushHandler, init, write, ConnManager, PeerId, WSS, LPStream, QUIC_V1, TCP_IP, close, selectMuxer, init, closeImpl, identify, readSeq, toBytes, TCP_DNS, shortLog, encode, WebSockets, capLen, supported, init, protoName, protoArgument, PeerEventHandler, LPProtoHandler, toRawBytes, IdentifyPush, getStream, TranscoderIP6Zone, $, init, maxIncomingStreams, WSS_DNS, list, match, <, CryptoResult, parseFullAddress, WebRTCDirect, init, upgrade, $, UDP, TranscoderOnion, goffset, IdentifyNoPubKeyError, write, init, LPStreamResetError, writeArray, new, LPStreamIncompleteError, LPStreamEOFError, maxIncomingStreams=, IP6, shortLog, new, release, initVBuffer, PKScheme, readVarint, new, payload, triggerConnEvent, triggerPeerEvents, init, write, init, TCP, PrivateKey, dropPeer, getBytes, start, write, init, close, &=, PeerInfoError, newLPStreamClosedError, random, compilesOr, TranscoderMemory, toString, trackMuxer, toException, DNS, key, Matcher, Upgrade, StreamTracker, HandlerHolder, getRawBytes, >, SecureConnTrackerName, KeyPair, init, high, init, cmp, formatItIMPL, formatItIMPL, initStream, formatItIMPL, Signature, contains, exclIfIt, hash, formatItIMPL, getStream, DigestSheme, init, IPFS, shortLog, readOnce, init, Secure, isEmpty, ConnEventKind, data, shortLog, Connection, contains, hex, expandItIMPL, protocols, codec=, bytes, DefaultMaxIncomingStreams, verify, HTTPS, UNIX, encode, TooManyConnectionsError, IdentifyCodec, TLS_WS, TranscoderIP6, init, addHandler, encode, TranscoderIP4, formatItIMPL, PeerEvent, MaResult, init, getStream, writeSeq, ConnEvent, init, $, DNS6, [], IpTransportProtocol, init, IP4, TranscoderPort, safeConvert, addPeerEventHandler, >=, expectConnection, init, payloadDomain, $, withValue, init, LPStreamLimitError, TranscoderOnion3, SignedPayload, closeImpl, toBytes, secure, newLPStreamLimitError, getBytes, keyOpenArray, init, match, parseFullAddress, closeImpl, isEmpty, writeLp, connectedPeers, init, newLPStreamIncompleteError, readOnce, MAProtocol, newLPStreamResetError, initStream, contains, getField, shortLog, DNS4, getWrapped, selectBest, P2PPattern, getWrapped, Envelope, hasPublicKey, toException, decode, init, isEnough, getConnections, Reliable, addrs, hex, slotsAvailable, write, WS, AgentVersion, MultiStreamError, stretchKeys, MultistreamSelect, encode, LPProtocol, init, init, getField, match, TcpOnion3, readArray, getField, writeLPVarint, iv, DefaultConnectionTimeout, RsaDefaultKeySize, readLine, Eof, CryptoError, append, hash, init, WebSockets_DNS, WSS_IP, LPStreamConnDownError, getMostObservedProtosAndPorts, init, SupportedSchemes, getField, select, hash, Unreliable, SupportedSchemesInt, random, checkFutures, handler=, ConnectionSlot, macOpenArray, init, validate, $, mapEq, IdentifyPushCodec, removePeerEventHandler, Onion3, select, concat, TranscoderP2P, PeerInfo, AddressInfo, ConnectionTrackerName, sign, init, write, EnvelopeError, guessDialableAddr, IdentifyInfo, IdentifyError, addHandler, Identify, storeMuxer, len, newLPStreamRemoteClosedError, MaPatResult, Direction, QUIC_V1_DNS, InvalidVarintError, shortLog, &, init, write, getBytes, write, init, UTP, toBytes, peekArray, QUIC_DNS, TimeoutHandler, PeerRecord, QUIC_IP, ObservedAddrManager, PublicKey, ConnEventHandler, WebSockets_IP, decodeMsg, VBuffer, writeLp, IdentityNoMatchError, writePBVarint, readExactly, protoArgument, newLPStreamConnDownError, new, init, readMessage, initStream, MultiAddress, readVarint, ivOpenArray, closeWithEOF, LPStreamTrackerName, orError, getField, LPStreamRemoteClosedError, libp2p_failed_upgrades_outgoing, protoCode, stop, MaInvalidAddress, select, LPStreamClosedError, getIncomingSlot, items, write, toBytes, getOrder, update, TranscoderUnix, SignedPeerRecord, stop, writeVarint