libp2p.stream_muxer package

Subpackages

• libp2p.stream_muxer.mplex package
  • Submodules
  • libp2p.stream_muxer.mplex.constants module
    • HeaderTags
      • HeaderTags.CloseInitiator
      • HeaderTags.CloseReceiver
      • HeaderTags.MessageInitiator
      • HeaderTags.MessageReceiver
      • HeaderTags.NewStream
      • HeaderTags.ResetInitiator
      • HeaderTags.ResetReceiver
  • libp2p.stream_muxer.mplex.datastructures module
    • StreamID
      • StreamID.channel_id
      • StreamID.is_initiator
  • libp2p.stream_muxer.mplex.exceptions module
    • MplexError
    • MplexStreamClosed
    • MplexStreamEOF
    • MplexStreamReset
    • MplexUnavailable
  • libp2p.stream_muxer.mplex.mplex module
    • Mplex
      • Mplex.accept_stream()
      • Mplex.close()
      • Mplex.event_closed
      • Mplex.event_shutting_down
      • Mplex.event_started
      • Mplex.get_remote_address()
      • Mplex.handle_incoming()
      • Mplex.is_closed
      • Mplex.is_initiator
      • Mplex.new_stream_receive_channel
      • Mplex.new_stream_send_channel
      • Mplex.next_channel_id
      • Mplex.on_close
      • Mplex.open_stream()
      • Mplex.peer_id
      • Mplex.read_message()
      • Mplex.secured_conn
      • Mplex.send_message()
      • Mplex.start()
      • Mplex.streams
      • Mplex.streams_lock
      • Mplex.streams_msg_channels
      • Mplex.write_to_stream()
  • libp2p.stream_muxer.mplex.mplex_stream module
    • MplexStream
      • MplexStream.close()
      • MplexStream.close_lock
      • MplexStream.event_local_closed
      • MplexStream.event_remote_closed
      • MplexStream.event_reset
      • MplexStream.get_remote_address()
      • MplexStream.incoming_data_channel
      • MplexStream.is_initiator
      • MplexStream.muxed_conn
      • MplexStream.name
      • MplexStream.read()
      • MplexStream.read_deadline
      • MplexStream.reset()
      • MplexStream.rw_lock
      • MplexStream.set_deadline()
      • MplexStream.set_read_deadline()
      • MplexStream.set_write_deadline()
      • MplexStream.stream_id
      • MplexStream.write()
      • MplexStream.write_deadline
  • Module contents
• libp2p.stream_muxer.yamux
  • Yamux
    • Yamux.accept_stream()
    • Yamux.close()
    • Yamux.handle_incoming()
    • Yamux.is_closed
    • Yamux.is_initiator
    • Yamux.open_stream()
    • Yamux.read_stream()
    • Yamux.start()

Submodules

libp2p.stream_muxer.exceptions module

exception libp2p.stream_muxer.exceptions.MuxedConnError

Bases: BaseLibp2pError

exception libp2p.stream_muxer.exceptions.MuxedConnUnavailable

Bases: MuxedConnError

exception libp2p.stream_muxer.exceptions.MuxedStreamClosed

Bases: MuxedStreamError

exception libp2p.stream_muxer.exceptions.MuxedStreamEOF

Bases: MuxedStreamError, EOFError

exception libp2p.stream_muxer.exceptions.MuxedStreamError

Bases: BaseLibp2pError

exception libp2p.stream_muxer.exceptions.MuxedStreamReset

Bases: MuxedStreamError

libp2p.stream_muxer.muxer_multistream module

class libp2p.stream_muxer.muxer_multistream.MuxerMultistream(muxer_transports_by_protocol: Mapping[TProtocol, type[object]], negotiate_timeout: int = 30)

Bases: object

MuxerMultistream is a multistream stream muxed transport multiplexer.

go implementation: github.com/libp2p/go-stream-muxer-multistream/multistream.go

add_transport(protocol: TProtocol, transport: type[object]) → None

Add a protocol and its corresponding transport to multistream- select(multiselect). The order that a protocol is added is exactly the precedence it is negotiated in multiselect.

Parameters:

• protocol – the protocol name, which is negotiated in multiselect.

• transport – the corresponding transportation to the protocol.

multiselect: Multiselect

multiselect_client: MultiselectClient

negotiate_timeout: int

async new_conn(conn: ISecureConn, peer_id: ID) → IMuxedConn

async select_transport(conn: IRawConnection) → type[object]

Select a transport that both us and the node on the other end of conn support and agree on.

Parameters:

conn – conn to choose a transport over

Returns:

selected muxer transport

transports: OrderedDict[TProtocol, type[object]]

Module contents