Class YamuxStream
Enumeration GoAwayCode
Index
Enumeration Members
InternalGoAwayCode | @chainsafe/libp2p-yamux - v5.0.2
Enumeration Members
Internal
Internal
Normal
Normal
Protocol
Protocol
Enumeration StreamState
Index
Enumeration Members
Established
+StreamState | @chainsafe/libp2p-yamux - v5.0.2
Enumeration Members
Established
Established: 3
Finished
Finished: 4
Init
Init: 0
SYNReceived
SYNReceived: 2
SYNSent
SYNSent: 1
Function verifyConfig
- verify
Config(config): void Parameters
config: Config
Returns void
Function verifyConfig
- verify
Config(config): void Parameters
config: Config
Returns void
Function yamux
- yamux(init?): (() => StreamMuxerFactory)
Parameters
init: YamuxMuxerInit = {}
Returns (() => StreamMuxerFactory)
- (): StreamMuxerFactory
Returns StreamMuxerFactory
Function yamux
- yamux(init?): (() => StreamMuxerFactory)
Parameters
init: YamuxMuxerInit = {}
Returns (() => StreamMuxerFactory)
- (): StreamMuxerFactory
Returns StreamMuxerFactory
@chainsafe/libp2p-yamux - v5.0.1
@chainsafe/libp2p-yamux
+
@chainsafe/libp2p-yamux - v5.0.2
@chainsafe/libp2p-yamux
Yamux stream multiplexer for libp2p
@@ -37,4 +37,4 @@MIT (LICENSE-MIT / http://opensource.org/licenses/MIT) Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
-
Interface Config
Hierarchy
- Config
Index
Properties
enableConfig | @chainsafe/libp2p-yamux - v5.0.2
max
max
Interface Config
Hierarchy
- Config
Index
Properties
max
max
Maximum number of concurrent outbound streams that we accept.
If the application tries to open more streams, the call to newStream will throw
max
max
Used to control the maximum window size that we allow for a stream.
-Interface YamuxStreamInit
Hierarchy
- AbstractStreamInit
- YamuxStreamInit
Index
Properties
config
+YamuxStreamInit | @chainsafe/libp2p-yamux - v5.0.2
send
Interface YamuxStreamInit
Hierarchy
- AbstractStreamInit
- YamuxStreamInit
Properties
config
getRTT
getRTT: (() => number)
Type declaration
- (): number
Returns number
Optional name
name?: string
send
send
Type declaration
- (header, body?): void
Parameters
header: FrameHeader
Optionalbody: Uint8Array
Returns void
state
Properties
config
getRTT
getRTT: (() => number)
Type declaration
- (): number
Returns number
Optional name
name?: string
send
send
Type declaration
- (header, body?): void
Parameters
header: FrameHeader
Optionalbody: Uint8Array
Returns void
state
Module config
Index
Interfaces
Config
+config | @chainsafe/libp2p-yamux - v5.0.2
Module config
Index
Interfaces
Variables
Functions
Module index
Index
Enumerations
Goindex | @chainsafe/libp2p-yamux - v5.0.2
Module index
Index
Enumerations
Functions
yamux
-
Module stream
Index
Enumerations
Streamstream | @chainsafe/libp2p-yamux - v5.0.2
YamuxStream is used to represent a logical stream within a session
+- Preparing search index...
- The search index is not available
@chainsafe/libp2p-yamux - v5.0.2Class YamuxStream
YamuxStream is used to represent a logical stream within a session
Hierarchy
Index
Constructors
Properties
Returns Promise<void>
send
potentially sends a window update enabling further writes to take place.
Returns void
wait
Wait for the send window to be non-zero
Will throw with ERR_STREAM_ABORT if the stream gets aborted
-Parameters
options: AbortOptions = {}
Returns Promise<void>
Settings
Member Visibility
Theme
On This Page
Parameters
options: AbortOptions = {}
Returns Promise<void>
Settings
Member Visibility
Theme
On This Page