/// <summary>
/// Construct a new headers message.
/// </summary>
/// <param name="headers">the non-<c>null</c> headers to send</param>
/// <param name="endStream">whether these headers should terminate the stream</param>
/// <param name="padding">additional bytes that should be added to obscure the true content size. Must be between 0 and
/// 256 (inclusive).</param>
public DefaultHttp2HeadersFrame(IHttp2Headers headers, bool endStream, int padding)
{
if (headers is null)
{
ThrowHelper.ThrowArgumentNullException(ExceptionArgument.headers);
}
_headers = headers;
_endStream = endStream;
Http2CodecUtil.VerifyPadding(padding);
_padding = padding;
}
/// <summary>
/// Construct a new data message.
/// </summary>
/// <param name="content">non-<c>null</c> payload</param>
/// <param name="endStream">whether this data should terminate the stream</param>
/// <param name="padding">additional bytes that should be added to obscure the true content size. Must be between 0 and
/// 256 (inclusive).</param>
public DefaultHttp2DataFrame(IByteBuffer content, bool endStream, int padding)
{
if (content is null)
{
ThrowHelper.ThrowArgumentNullException(ExceptionArgument.content);
}
_content = content;
_endStream = endStream;
Http2CodecUtil.VerifyPadding(padding);
_padding = padding;
if (Content.ReadableBytes + (long)padding > int.MaxValue)
{
ThrowHelper.ThrowArgumentException_InvalidContendAndPadding();
}
_initialFlowControlledBytes = content.ReadableBytes + padding;
}
public virtual Task WriteDataAsync(IChannelHandlerContext ctx, int streamId, IByteBuffer data, int padding, bool endOfStream, IPromise promise)
{
SimplePromiseAggregator promiseAggregator = new SimplePromiseAggregator(promise);
IByteBuffer frameHeader = null;
try
{
if ((uint)(streamId - 1) > SharedConstants.TooBigOrNegative)
{
ThrowHelper.ThrowArgumentException_Positive(ExceptionArgument.StreamID);
}
Http2CodecUtil.VerifyPadding(padding);
int remainingData = data.ReadableBytes;
Http2Flags flags = new Http2Flags();
_ = flags.EndOfStream(false);
_ = flags.PaddingPresent(false);
// Fast path to write frames of payload size maxFrameSize first.
if (remainingData > _maxFrameSize)
{
frameHeader = ctx.Allocator.Buffer(Http2CodecUtil.FrameHeaderLength);
Http2CodecUtil.WriteFrameHeaderInternal(frameHeader, _maxFrameSize, Http2FrameTypes.Data, flags, streamId);
do
{
// Write the header.
_ = ctx.WriteAsync(frameHeader.RetainedSlice(), promiseAggregator.NewPromise());
// Write the payload.
_ = ctx.WriteAsync(data.ReadRetainedSlice(_maxFrameSize), promiseAggregator.NewPromise());
remainingData -= _maxFrameSize;
// Stop iterating if remainingData == _maxFrameSize so we can take care of reference counts below.
}while (remainingData > _maxFrameSize);
}
if (0u >= (uint)padding)
{
// Write the header.
if (frameHeader is object)
{
_ = frameHeader.Release();
frameHeader = null;
}
IByteBuffer frameHeader2 = ctx.Allocator.Buffer(Http2CodecUtil.FrameHeaderLength);
_ = flags.EndOfStream(endOfStream);
Http2CodecUtil.WriteFrameHeaderInternal(frameHeader2, remainingData, Http2FrameTypes.Data, flags, streamId);
_ = ctx.WriteAsync(frameHeader2, promiseAggregator.NewPromise());
// Write the payload.
IByteBuffer lastFrame = data.ReadSlice(remainingData);
data = null;
_ = ctx.WriteAsync(lastFrame, promiseAggregator.NewPromise());
}
else
{
if (remainingData != _maxFrameSize)
{
if (frameHeader is object)
{
_ = frameHeader.Release();
frameHeader = null;
}
}
else
{
remainingData -= _maxFrameSize;
// Write the header.
IByteBuffer lastFrame;
if (frameHeader is null)
{
lastFrame = ctx.Allocator.Buffer(Http2CodecUtil.FrameHeaderLength);
Http2CodecUtil.WriteFrameHeaderInternal(lastFrame, _maxFrameSize, Http2FrameTypes.Data, flags, streamId);
}
else
{
lastFrame = frameHeader.Slice();
frameHeader = null;
}
_ = ctx.WriteAsync(lastFrame, promiseAggregator.NewPromise());
// Write the payload.
lastFrame = data.ReadableBytes != _maxFrameSize?data.ReadSlice(_maxFrameSize) : data;
data = null;
_ = ctx.WriteAsync(lastFrame, promiseAggregator.NewPromise());
}
do
{
int frameDataBytes = Math.Min(remainingData, _maxFrameSize);
int framePaddingBytes = Math.Min(padding, Math.Max(0, (_maxFrameSize - 1) - frameDataBytes));
// Decrement the remaining counters.
padding -= framePaddingBytes;
remainingData -= frameDataBytes;
// Write the header.
IByteBuffer frameHeader2 = ctx.Allocator.Buffer(Http2CodecUtil.DataFrameHeaderLength);
_ = flags.EndOfStream(endOfStream && 0u >= (uint)remainingData && 0u >= (uint)padding);
_ = flags.PaddingPresent(framePaddingBytes > 0);
Http2CodecUtil.WriteFrameHeaderInternal(frameHeader2, framePaddingBytes + frameDataBytes, Http2FrameTypes.Data, flags, streamId);
WritePaddingLength(frameHeader2, framePaddingBytes);
_ = ctx.WriteAsync(frameHeader2, promiseAggregator.NewPromise());
// Write the payload.
if (frameDataBytes != 0)
{
if (0u >= (uint)remainingData)
{
IByteBuffer lastFrame = data.ReadSlice(frameDataBytes);
data = null;
_ = ctx.WriteAsync(lastFrame, promiseAggregator.NewPromise());
}
else
{
_ = ctx.WriteAsync(data.ReadRetainedSlice(frameDataBytes), promiseAggregator.NewPromise());
}
}
// Write the frame padding.
if (PaddingBytes(framePaddingBytes) > 0)
{
_ = ctx.WriteAsync(
ZeroBuffer.Slice(0, PaddingBytes(framePaddingBytes)),
promiseAggregator.NewPromise());
}
}while (remainingData != 0 || padding != 0);
}
}
catch (Exception cause)
{
if (frameHeader is object)
{
_ = frameHeader.Release();
}
// Use a try/finally here in case the data has been released before calling this method. This is not
// necessary above because we internally allocate frameHeader.
try
{
if (data is object)
{
_ = data.Release();
}
}
finally
{
promiseAggregator.SetException(cause);
_ = promiseAggregator.DoneAllocatingPromises();
}
return(promiseAggregator.Task);
}
_ = promiseAggregator.DoneAllocatingPromises();
return(promiseAggregator.Task);
}
Task WriteHeadersInternal(IChannelHandlerContext ctx, int streamId,
IHttp2Headers headers, int padding, bool endOfStream, bool hasPriority,
int streamDependency, short weight, bool exclusive, IPromise promise)
{
IByteBuffer headerBlock = null;
SimplePromiseAggregator promiseAggregator = new SimplePromiseAggregator(promise);
try
{
if ((uint)(streamId - 1) > SharedConstants.TooBigOrNegative)
{
ThrowHelper.ThrowArgumentException_Positive(ExceptionArgument.StreamID);
}
if (hasPriority)
{
if (streamDependency < 0)
{
ThrowHelper.ThrowArgumentException_PositiveOrZero(ExceptionArgument.StreamDependency);
}
Http2CodecUtil.VerifyPadding(padding);
VerifyWeight(weight);
}
// Encode the entire header block.
headerBlock = ctx.Allocator.Buffer();
_headersEncoder.EncodeHeaders(streamId, headers, headerBlock);
Http2Flags flags =
new Http2Flags().EndOfStream(endOfStream).PriorityPresent(hasPriority).PaddingPresent(padding > 0);
// Read the first fragment (possibly everything).
int nonFragmentBytes = padding + flags.GetNumPriorityBytes();
int maxFragmentLength = _maxFrameSize - nonFragmentBytes;
IByteBuffer fragment = headerBlock.ReadRetainedSlice(Math.Min(headerBlock.ReadableBytes, maxFragmentLength));
// Set the end of headers flag for the first frame.
_ = flags.EndOfHeaders(!headerBlock.IsReadable());
int payloadLength = fragment.ReadableBytes + nonFragmentBytes;
IByteBuffer buf = ctx.Allocator.Buffer(Http2CodecUtil.HeadersFrameHeaderLength);
Http2CodecUtil.WriteFrameHeaderInternal(buf, payloadLength, Http2FrameTypes.Headers, flags, streamId);
WritePaddingLength(buf, padding);
if (hasPriority)
{
_ = buf.WriteInt(exclusive ? (int)(uint)(0x80000000L | streamDependency) : streamDependency);
// Adjust the weight so that it fits into a single byte on the wire.
_ = buf.WriteByte(weight - 1);
}
_ = ctx.WriteAsync(buf, promiseAggregator.NewPromise());
// Write the first fragment.
_ = ctx.WriteAsync(fragment, promiseAggregator.NewPromise());
// Write out the padding, if any.
if (PaddingBytes(padding) > 0)
{
_ = ctx.WriteAsync(ZeroBuffer.Slice(0, PaddingBytes(padding)), promiseAggregator.NewPromise());
}
if (!flags.EndOfHeaders())
{
_ = WriteContinuationFramesAsync(ctx, streamId, headerBlock, promiseAggregator);
}
}
catch (Http2Exception e)
{
promiseAggregator.SetException(e);
}
catch (Exception t)
{
promiseAggregator.SetException(t);
_ = promiseAggregator.DoneAllocatingPromises();
throw;
}
finally
{
_ = (headerBlock?.Release());
}
_ = promiseAggregator.DoneAllocatingPromises();
return(promiseAggregator.Task);
}
public virtual Task WritePushPromiseAsync(IChannelHandlerContext ctx, int streamId,
int promisedStreamId, IHttp2Headers headers, int padding, IPromise promise)
{
IByteBuffer headerBlock = null;
SimplePromiseAggregator promiseAggregator = new SimplePromiseAggregator(promise);
try
{
if ((uint)(streamId - 1) > SharedConstants.TooBigOrNegative)
{
ThrowHelper.ThrowArgumentException_Positive(ExceptionArgument.StreamID);
}
if (promisedStreamId <= 0)
{
ThrowHelper.ThrowArgumentException_Positive(ExceptionArgument.PromisedStreamId);
}
Http2CodecUtil.VerifyPadding(padding);
// Encode the entire header block into an intermediate buffer.
headerBlock = ctx.Allocator.Buffer();
_headersEncoder.EncodeHeaders(streamId, headers, headerBlock);
// Read the first fragment (possibly everything).
Http2Flags flags = new Http2Flags().PaddingPresent(padding > 0);
// IntFieldLength is for the length of the promisedStreamId
int nonFragmentLength = Http2CodecUtil.IntFieldLength + padding;
int maxFragmentLength = _maxFrameSize - nonFragmentLength;
IByteBuffer fragment = headerBlock.ReadRetainedSlice(Math.Min(headerBlock.ReadableBytes, maxFragmentLength));
_ = flags.EndOfHeaders(!headerBlock.IsReadable());
int payloadLength = fragment.ReadableBytes + nonFragmentLength;
IByteBuffer buf = ctx.Allocator.Buffer(Http2CodecUtil.PushPromiseFrameHeaderLength);
Http2CodecUtil.WriteFrameHeaderInternal(buf, payloadLength, Http2FrameTypes.PushPromise, flags, streamId);
WritePaddingLength(buf, padding);
// Write out the promised stream ID.
_ = buf.WriteInt(promisedStreamId);
_ = ctx.WriteAsync(buf, promiseAggregator.NewPromise());
// Write the first fragment.
_ = ctx.WriteAsync(fragment, promiseAggregator.NewPromise());
// Write out the padding, if any.
if (PaddingBytes(padding) > 0)
{
_ = ctx.WriteAsync(ZeroBuffer.Slice(0, PaddingBytes(padding)), promiseAggregator.NewPromise());
}
if (!flags.EndOfHeaders())
{
_ = WriteContinuationFramesAsync(ctx, streamId, headerBlock, promiseAggregator);
}
}
catch (Http2Exception e)
{
promiseAggregator.SetException(e);
}
catch (Exception t)
{
promiseAggregator.SetException(t);
_ = promiseAggregator.DoneAllocatingPromises();
throw;
}
finally
{
if (headerBlock is object)
{
_ = headerBlock.Release();
}
}
_ = promiseAggregator.DoneAllocatingPromises();
return(promiseAggregator.Task);
}
