YamuxSession class

Yamux session that implements the Multiplexer and MuxedConn interfaces

Implemented types

• Multiplexer
• MuxedConn
• Conn

Constructors

YamuxSession.new(TransportConn _connection, MultiplexerConfig _config, bool _isClient, [PeerScope? _peerScope])

Properties

canCreateStream → bool

Returns true if we can create more streams

no setter, override

hashCode → int

The hash code for this object.

no setter, inherited

id → String

ID returns an identifier that uniquely identifies this Conn within this host, during this run. Connection IDs may repeat across restarts.

no setter, override

incomingStreams → Stream<P2PStream>

Event stream for new inbound streams

no setter, override

isClosed → bool

Returns true if the multiplexer is closed

no setter, override

localMultiaddr → MultiAddr

LocalMultiaddr returns the local Multiaddr associated with this connection

no setter, override

localPeer → PeerId

LocalPeer returns our peer ID

no setter, override

maxStreams → int

The maximum number of concurrent streams allowed

no setter, override

numStreams → int

The current number of active streams

no setter, override

protocolId → String

The protocol ID for this multiplexer (e.g., '/yamux/1.0.0')

final

remoteMultiaddr → MultiAddr

RemoteMultiaddr returns the remote Multiaddr associated with this connection

no setter, override

remotePeer → PeerId

RemotePeer returns the peer ID of the remote peer.

no setter, override

remotePublicKey → Future<PublicKey?>

RemotePublicKey returns the public key of the remote peer.

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scope → ConnScope

Scope returns the user view of this connection's resource scope

no setter, override

stat → ConnStats

Stat stores metadata pertaining to this conn.

no setter, override

state → ConnState

ConnState returns information about the connection state.

no setter, override

streams → Future<List<P2PStream>>

Returns all active streams

no setter, override

Methods

acceptStream() → Future<YamuxStream>

Accepts an inbound stream

override

close() → Future<void>

Closes the multiplexer and all its streams

override

newConnOnTransport(TransportConn secureConnection, bool isServer, PeerScope scope) → Future<MuxedConn>

Establishes a new multiplexed connection over an existing transport connection.

override

newStream(Context context) → Future<P2PStream>

NewStream constructs a new Stream over this conn.

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

openStream(Context context) → Future<MuxedStream>

Creates a new stream.

override

removeStreamHandler() → void

Removes the stream handler

override

setStreamHandler(Future<void> handler(P2PStream stream)) → void

Sets the stream handler for accepting new streams

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited