blob: 274e1633ca9c439919db8249fc473becad1cd2d3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/*
* Copyright (c) 2023 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 VNLib.Utils.Logging;
namespace VNLib.Net.Http
{
/// <summary>
/// Represents configration variables used to create the instance and manage http connections
/// </summary>
/// <param name="ServerLog">
/// A log provider that all server related log entiries will be written to
/// </param>
/// <param name="MemoryPool">
/// Server memory pool to use for allocating buffers
/// </param>
public readonly record struct HttpConfig(ILogProvider ServerLog, IHttpMemoryPool MemoryPool)
{
/// <summary>
/// The absolute request entity body size limit in bytes
/// </summary>
public readonly long MaxUploadSize { get; init; } = 5 * 1000 * 1024;
/// <summary>
/// The maximum size in bytes allowed for an MIME form-data content type upload
/// </summary>
/// <remarks>Set to 0 to disabled mulit-part/form-data uploads</remarks>
public readonly int MaxFormDataUploadSize { get; init; } = 40 * 1024;
/// <summary>
/// The maximum number of file uploads allowed per request
/// </summary>
public readonly ushort MaxUploadsPerRequest { get; init; } = 5;
/// <summary>
/// The maximum response entity size in bytes for which the library will allow compresssing response data
/// </summary>
/// <remarks>Set this value to 0 to disable response compression</remarks>
public readonly long CompressionLimit { get; init; } = 1000 * 1024;
/// <summary>
/// The minimum size (in bytes) of respones data that will be compressed
/// </summary>
public readonly int CompressionMinimum { get; init; } = 4096;
/// <summary>
/// The maximum amount of time to listen for data from a connected, but inactive transport connection
/// before closing them
/// </summary>
public readonly TimeSpan ConnectionKeepAlive { get; init; } = TimeSpan.FromSeconds(100);
/// <summary>
/// The encoding to use when sending and receiving HTTP data
/// </summary>
public readonly Encoding HttpEncoding { get; init; } = Encoding.UTF8;
/// <summary>
/// Sets the default Http version for responses when the client version cannot be parsed from the request
/// </summary>
public readonly HttpVersion DefaultHttpVersion { get; init; } = HttpVersion.Http11;
/// <summary>
/// The amount of time (in milliseconds) to wait for data on a connection that is in a receive
/// state, aka active receive.
/// </summary>
public readonly int ActiveConnectionRecvTimeout { get; init; } = 5000;
/// <summary>
/// The amount of time (in milliseconds) to wait for data to be send to the client before
/// the connection is closed
/// </summary>
public readonly int SendTimeout { get; init; } = 5000;
/// <summary>
/// The maximum number of request headers allowed per request
/// </summary>
public readonly int MaxRequestHeaderCount { get; init; } = 100;
/// <summary>
/// The maximum number of open transport connections, before 503 errors
/// will be returned and new connections closed.
/// </summary>
/// <remarks>Set to 0 to disable request processing. Causes perminant 503 results</remarks>
public readonly int MaxOpenConnections { get; init; } = int.MaxValue;
/// <summary>
/// An <see cref="ILogProvider"/> for writing verbose request logs. Set to <c>null</c>
/// to disable verbose request logging
/// </summary>
public readonly ILogProvider? RequestDebugLog { get; init; } = null;
/// <summary>
/// The buffer configuration for the server
/// </summary>
public readonly HttpBufferConfig BufferConfig { get; init; } = new();
/// <summary>
/// Gets the <see cref="IHttpCompressorManager"/> used to manage response compression for
/// the server.
/// </summary>
public readonly IHttpCompressorManager? CompressorManager { get; init; } = null;
}
}
|
