/*
* Copyright (c) 2022 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Net.Http
* File: HttpConfig.cs
*
* HttpConfig.cs is part of VNLib.Net.Http which is part of the larger
* VNLib collection of libraries and utilities.
*
* VNLib.Net.Http is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* VNLib.Net.Http is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see https://www.gnu.org/licenses/.
*/
using System;
using System.Text;
using System.IO.Compression;
using VNLib.Utils.Logging;
namespace VNLib.Net.Http
{
///
/// Represents configration variables used to create the instance and manage http connections
///
public readonly struct HttpConfig
{
public HttpConfig(ILogProvider log)
{
ConnectionKeepAlive = TimeSpan.FromSeconds(100);
ServerLog = log;
}
///
/// A log provider that all server related log entiries will be written to
///
public readonly ILogProvider ServerLog { get; }
///
/// The absolute request entity body size limit in bytes
///
public readonly int MaxUploadSize { get; init; } = 5 * 1000 * 1024;
///
/// The maximum size in bytes allowed for an MIME form-data content type upload
///
/// Set to 0 to disabled mulit-part/form-data uploads
public readonly int MaxFormDataUploadSize { get; init; } = 40 * 1024;
///
/// The maximum buffer size to use when parsing Multi-part/Form-data file uploads
///
///
/// This value is used to create the buffer used to read data from the input stream
/// into memory for parsing. Form-data uploads must be parsed in memory because
/// the data is not delimited by a content length.
///
public readonly int FormDataBufferSize { get; init; } = 8192;
///
/// The maximum response entity size in bytes for which the library will allow compresssing response data
///
/// Set this value to 0 to disable response compression
public readonly int CompressionLimit { get; init; } = 1000 * 1024;
///
/// The minimum size (in bytes) of respones data that will be compressed
///
public readonly int CompressionMinimum { get; init; } = 4096;
///
/// The maximum amount of time to listen for data from a connected, but inactive transport connection
/// before closing them
///
public readonly TimeSpan ConnectionKeepAlive { get; init; }
///
/// The encoding to use when sending and receiving HTTP data
///
public readonly Encoding HttpEncoding { get; init; } = Encoding.UTF8;
///
/// Sets the compression level for response entity streams of all supported types when
/// compression is used.
///
public readonly CompressionLevel CompressionLevel { get; init; } = CompressionLevel.Optimal;
///
/// Sets the default Http version for responses when the client version cannot be parsed from the request
///
public readonly HttpVersion DefaultHttpVersion { get; init; } = HttpVersion.Http11;
///
/// The buffer size used to read HTTP headers from the transport.
///
///
/// Setting this value too low will result in header parsing failures
/// and 400 Bad Request responses. Setting it too high can result in
/// resource abuse or high memory usage. 8k is usually a good value.
///
public readonly int HeaderBufferSize { get; init; } = 8192;
///
/// The amount of time (in milliseconds) to wait for data on a connection that is in a receive
/// state, aka active receive.
///
public readonly int ActiveConnectionRecvTimeout { get; init; } = 5000;
///
/// The amount of time (in milliseconds) to wait for data to be send to the client before
/// the connection is closed
///
public readonly int SendTimeout { get; init; } = 5000;
///
/// The maximum number of request headers allowed per request
///
public readonly int MaxRequestHeaderCount { get; init; } = 100;
///
/// The maximum number of open transport connections, before 503 errors
/// will be returned and new connections closed.
///
/// Set to 0 to disable request processing. Causes perminant 503 results
public readonly int MaxOpenConnections { get; init; } = int.MaxValue;
///
/// The size (in bytes) of the http response header accumulator buffer.
///
///
/// Http responses use an internal accumulator to buffer all response headers
/// before writing them to the transport in on write operation. If this value
/// is too low, the response will fail to write. If it is too high, it
/// may cause resource exhaustion or high memory usage.
///
public readonly int ResponseHeaderBufferSize { get; init; } = 16 * 1024;
///
/// The size (in bytes) of the buffer to use to discard unread request entity bodies
///
public readonly int DiscardBufferSize { get; init; } = 64 * 1024;
///
/// The size of the buffer to use when writing response data to the transport
///
///
/// This value is the size of the buffer used to copy data from the response
/// entity stream, to the transport stream.
///
public readonly int ResponseBufferSize { get; init; } = 32 * 1024;
///
/// The size of the buffer used to accumulate chunked response data before writing to the transport
///
public readonly int ChunkedResponseAccumulatorSize { get; init; } = 64 * 1024;
///
/// An for writing verbose request logs. Set to null
/// to disable verbose request logging
///
public readonly ILogProvider? RequestDebugLog { get; init; } = null;
}
}