Class Substream

A duplex substream used by the Muxer.

Inheritance
Object
MarshalByRefObject
Stream
Substream
Implements
Inherited Members
Namespace: PeerTalk.Multiplex
Assembly: PeerTalk.dll
Syntax
public class Substream : Stream, IDisposable
Remarks

Reading of data waits on the Muxer calling AddData(Byte[]). NoMoreData() is used to signal the end of stream.

Writing data is buffered until FlushAsync(CancellationToken) is called.

Fields

| Improve this Doc View Source

Id

The stream identifier.

Declaration
public long Id
Field Value
Type Description
Int64

The session initiator allocates odd IDs and the session receiver allocates even IDs.
| Improve this Doc View Source

Name

A name for the stream.

Declaration
public string Name
Field Value
Type Description
String

Names do not need to be unique.
| Improve this Doc View Source

SentMessageType

The type of message of sent to the other side.

Declaration
public PacketType SentMessageType
Field Value
Type Description
PacketType

Either MessageInitiator or MessageReceiver. Defaults to MessageReceiver.

Properties

| Improve this Doc View Source

CanRead

Declaration
public override bool CanRead { get; }
Property Value
Type Description
Boolean
Overrides
| Improve this Doc View Source

CanSeek

Declaration
public override bool CanSeek { get; }
Property Value
Type Description
Boolean
Overrides
| Improve this Doc View Source

CanTimeout

Declaration
public override bool CanTimeout { get; }
Property Value
Type Description
Boolean
Overrides
| Improve this Doc View Source

CanWrite

Declaration
public override bool CanWrite { get; }
Property Value
Type Description
Boolean
Overrides
| Improve this Doc View Source

Length

Declaration
public override long Length { get; }
Property Value
Type Description
Int64
Overrides
| Improve this Doc View Source

Muxer

The multiplexor associated with the substream.

Declaration
public Muxer Muxer { get; set; }
Property Value
Type Description
Muxer
| Improve this Doc View Source

Position

Declaration
public override long Position { get; set; }
Property Value
Type Description
Int64
Overrides

Methods

| Improve this Doc View Source

AddData(Byte[])

Add some data that should be read by the stream.

Declaration
public void AddData(byte[] data)
Parameters
Type Name Description
Byte[] data

The data to be read.
Remarks

AddData is called when the muxer receives a packet for this stream.

| Improve this Doc View Source

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
Boolean disposing
Overrides
| Improve this Doc View Source

Flush()

Declaration
public override void Flush()
Overrides
| Improve this Doc View Source

FlushAsync(CancellationToken)

Declaration
public override Task FlushAsync(CancellationToken cancel)
Parameters
Type Name Description
CancellationToken cancel
Returns
Type Description
Task
Overrides
| Improve this Doc View Source

NoMoreData()

Indicates that the stream will not receive any more data.

Declaration
public void NoMoreData()
Remarks

NoMoreData is called when the muxer receives a packet to close this stream.

See Also
| Improve this Doc View Source

Read(Byte[], Int32, Int32)

Declaration
public override int Read(byte[] buffer, int offset, int count)
Parameters
Type Name Description
Byte[] buffer
Int32 offset
Int32 count
Returns
Type Description
Int32
Overrides
| Improve this Doc View Source

ReadAsync(Byte[], Int32, Int32, CancellationToken)

Declaration
public override Task<int> ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)
Parameters
Type Name Description
Byte[] buffer
Int32 offset
Int32 count
CancellationToken cancellationToken
Returns
Type Description
Task<Int32>
Overrides
| Improve this Doc View Source

Seek(Int64, SeekOrigin)

Declaration
public override long Seek(long offset, SeekOrigin origin)
Parameters
Type Name Description
Int64 offset
SeekOrigin origin
Returns
Type Description
Int64
Overrides
| Improve this Doc View Source

SetLength(Int64)

Declaration
public override void SetLength(long value)
Parameters
Type Name Description
Int64 value
Overrides
| Improve this Doc View Source

Write(Byte[], Int32, Int32)

Declaration
public override void Write(byte[] buffer, int offset, int count)
Parameters
Type Name Description
Byte[] buffer
Int32 offset
Int32 count
Overrides
| Improve this Doc View Source

WriteAsync(Byte[], Int32, Int32, CancellationToken)

Declaration
public override Task WriteAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)
Parameters
Type Name Description
Byte[] buffer
Int32 offset
Int32 count
CancellationToken cancellationToken
Returns
Type Description
Task
Overrides
| Improve this Doc View Source

WriteByte(Byte)

Declaration
public override void WriteByte(byte value)
Parameters
Type Name Description
Byte value
Overrides

Implements

Extension Methods