Class TrailingHeadersWrapperStream

Namespace

Amazon.Runtime.Internal.Util

Assembly

AWSSDK.Core.dll

Stream wrapper to append trailing headers, including an optional rolling checksum for a request with an unsigned payload.

public class TrailingHeadersWrapperStream : WrapperStream, IDisposable, IAsyncDisposable

Inheritance

object

MarshalByRefObject

Stream

WrapperStream

TrailingHeadersWrapperStream

Implements

IDisposable

IAsyncDisposable

Inherited Members

WrapperStream.GetNonWrapperBaseStream()

WrapperStream.GetSeekableBaseStream()

WrapperStream.GetNonWrapperBaseStream(Stream)

WrapperStream.SearchWrappedStream(Func<Stream, bool>)

WrapperStream.SearchWrappedStream(Stream, Func<Stream, bool>)

WrapperStream.Dispose(bool)

WrapperStream.Flush()

WrapperStream.Seek(long, SeekOrigin)

WrapperStream.SetLength(long)

WrapperStream.Write(byte[], int, int)

WrapperStream.FlushAsync(CancellationToken)

WrapperStream.WriteAsync(byte[], int, int, CancellationToken)

WrapperStream.BaseStream

WrapperStream.CanRead

WrapperStream.CanWrite

WrapperStream.Position

WrapperStream.ReadTimeout

WrapperStream.WriteTimeout

Stream.Null

Stream.CopyTo(Stream)

Stream.CopyTo(Stream, int)

Stream.CopyToAsync(Stream)

Stream.CopyToAsync(Stream, int)

Stream.CopyToAsync(Stream, CancellationToken)

Stream.CopyToAsync(Stream, int, CancellationToken)

Stream.Dispose()

Stream.Close()

Stream.DisposeAsync()

Stream.FlushAsync()

Stream.CreateWaitHandle()

Stream.BeginRead(byte[], int, int, AsyncCallback, object)

Stream.EndRead(IAsyncResult)

Stream.ReadAsync(byte[], int, int)

Stream.ReadAsync(Memory<byte>, CancellationToken)

Stream.ReadExactlyAsync(Memory<byte>, CancellationToken)

Stream.ReadExactlyAsync(byte[], int, int, CancellationToken)

Stream.ReadAtLeastAsync(Memory<byte>, int, bool, CancellationToken)

Stream.BeginWrite(byte[], int, int, AsyncCallback, object)

Stream.EndWrite(IAsyncResult)

Stream.WriteAsync(byte[], int, int)

Stream.WriteAsync(ReadOnlyMemory<byte>, CancellationToken)

Stream.Read(Span<byte>)

Stream.ReadByte()

Stream.ReadExactly(Span<byte>)

Stream.ReadExactly(byte[], int, int)

Stream.ReadAtLeast(Span<byte>, int, bool)

Stream.Write(ReadOnlySpan<byte>)

Stream.WriteByte(byte)

Stream.Synchronized(Stream)

Stream.ObjectInvariant()

Stream.ValidateBufferArguments(byte[], int, int)

Stream.ValidateCopyToArguments(Stream, int)

Stream.CanTimeout

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.InitializeLifetimeService()

MarshalByRefObject.MemberwiseClone(bool)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

TrailingHeadersWrapperStream(Stream, IDictionary<string, string>)

Initiates a stream wrapper to append trailing headers to an unsigned payload

public TrailingHeadersWrapperStream(Stream baseStream, IDictionary<string, string> trailingHeaders)

Parameters

baseStream Stream

Stream to wrap

trailingHeaders IDictionary<string, string>

Trailing headers to append after the wrapped stream

TrailingHeadersWrapperStream(Stream, IDictionary<string, string>, CoreChecksumAlgorithm)

Initiates a stream wrapper to append trailing headers to an unsigned payload, with a trailing checksum

public TrailingHeadersWrapperStream(Stream baseStream, IDictionary<string, string> trailingHeaders, CoreChecksumAlgorithm checksumAlgorithm)

Parameters

baseStream Stream

Stream to wrap

trailingHeaders IDictionary<string, string>

Header keys and values to append after the stream's conent

checksumAlgorithm CoreChecksumAlgorithm

Algorithm to use to calculate the stream's checksum

Properties

CanSeek

Gets a value indicating whether the current stream supports seeking

public override bool CanSeek { get; }

Property Value

bool

Length

Gets the length in bytes of the stream

public override long Length { get; }

Property Value

long

Methods

CalculateLength(IDictionary<string, string>, CoreChecksumAlgorithm, long)

Calculates the length in bytes of a TrailingChecksumWrapperStream initialized with the given trailing headers and optional checksum

public static long CalculateLength(IDictionary<string, string> trailingHeaders, CoreChecksumAlgorithm checksumAlgorithm, long baseStreamLength)

Parameters

trailingHeaders IDictionary<string, string>

Dictionary of trailing headers

checksumAlgorithm CoreChecksumAlgorithm

Trailing checksum

baseStreamLength long

Length of the base stream in bytes

Returns

long

Length of a TrailingChecksumWrapperStream with given parameters, in bytes

Read(byte[], int, int)

Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

public override int Read(byte[] buffer, int offset, int count)

Parameters

buffer byte[]

An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.

offset int

The zero-based byte offset in buffer at which to begin storing the data read from the current stream.

count int

The maximum number of bytes to be read from the current stream.

Returns

int

The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.

ReadAsync(byte[], int, int, CancellationToken)

Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

public override Task<int> ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)

Parameters

buffer byte[]

An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.

offset int

The zero-based byte offset in buffer at which to begin storing the data read from the current stream.

count int

The maximum number of bytes to be read from the current stream.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task<int>

The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.