Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ <h5>Inheritance</h5>
<div class="level3"><a class="xref" href="Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.html">SessionEventArgsBase</a></div>
<div class="level3"><a class="xref" href="Titanium.Web.Proxy.EventArguments.SocksAuthenticateEventArgs.html">SocksAuthenticateEventArgs</a></div>
<div class="level3"><a class="xref" href="Titanium.Web.Proxy.EventArguments.TunnelConnectFailureEventArgs.html">TunnelConnectFailureEventArgs</a></div>
<div class="level3"><a class="xref" href="Titanium.Web.Proxy.EventArguments.WebSocketFrameElidedEventArgs.html">WebSocketFrameElidedEventArgs</a></div>
<div class="level3"><a class="xref" href="Titanium.Web.Proxy.EventArguments.WebSocketFrameInterceptEventArgs.html">WebSocketFrameInterceptEventArgs</a></div>
</div>
<div class="inheritedMembers">
Expand Down
139 changes: 112 additions & 27 deletions docs/api/Titanium.Web.Proxy.EventArguments.SessionEventArgs.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions docs/api/Titanium.Web.Proxy.EventArguments.html
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,10 @@ <h4><a class="xref" href="Titanium.Web.Proxy.EventArguments.TunnelConnectFailure
</section>
<h4><a class="xref" href="Titanium.Web.Proxy.EventArguments.TunnelConnectSessionEventArgs.html">TunnelConnectSessionEventArgs</a></h4>
<section><p>A class that wraps the state when a tunnel connect event happen for Explicit endpoints.</p>
</section>
<h4><a class="xref" href="Titanium.Web.Proxy.EventArguments.WebSocketFrameElidedEventArgs.html">WebSocketFrameElidedEventArgs</a></h4>
<section><p>Metadata for a WebSocket frame that exceeded the payload limit under
<a class="xref" href="Titanium.Web.Proxy.Options.PolicyMode.html#Titanium_Web_Proxy_Options_PolicyMode_Observe">Observe</a>. The payload itself is not included.</p>
</section>
<h4><a class="xref" href="Titanium.Web.Proxy.EventArguments.WebSocketFrameInterceptEventArgs.html">WebSocketFrameInterceptEventArgs</a></h4>
<section><p>Frame-level interception context for an active WebSocket session.</p>
Expand Down
31 changes: 28 additions & 3 deletions docs/api/Titanium.Web.Proxy.Options.PolicyFamily.html
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,15 @@ <h3 id="fields">Fields
</tr>
<tr>
<td id="Titanium_Web_Proxy_Options_PolicyFamily_BodyBudget">BodyBudget</td>
<td><p>Cumulative whole-body buffering limits (<code>MaxBufferedBodyBytes</code> and the
<a class="xref" href="Titanium.Web.Proxy.Options.ProxyResourceLimits.html#Titanium_Web_Proxy_Options_ProxyResourceLimits_MaxEncodedBodyBytes">MaxEncodedBodyBytes</a>/<a class="xref" href="Titanium.Web.Proxy.Options.ProxyResourceLimits.html#Titanium_Web_Proxy_Options_ProxyResourceLimits_MaxDecodedBodyBytes">MaxDecodedBodyBytes</a>
pair) enforced via <span class="xref">Titanium.Web.Proxy.Network.Streams.BoundedWriteStream</span> across H1, H2 and H3.</p>
<td><p>Cumulative whole-body buffering limits (<code>MaxBufferedBodyBytes</code>) enforced via
<span class="xref">Titanium.Web.Proxy.Network.Streams.BoundedWriteStream</span> when a caller materializes a body.
Streaming relays do not consult this family.</p>
<p>
<a class="xref" href="Titanium.Web.Proxy.Options.ProxyResourceLimits.html#Titanium_Web_Proxy_Options_ProxyResourceLimits_MaxEncodedBodyBytes">MaxEncodedBodyBytes</a> and
<a class="xref" href="Titanium.Web.Proxy.Options.ProxyResourceLimits.html#Titanium_Web_Proxy_Options_ProxyResourceLimits_MaxDecodedBodyBytes">MaxDecodedBodyBytes</a> are reserved. They are accepted
by option plumbing and are not enforced on a live read path; the enforced whole-body
budget is <code>MaxBufferedBodyBytes</code>.
</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -194,6 +200,25 @@ <h3 id="fields">Fields
and <a class="xref" href="Titanium.Web.Proxy.Options.ProxyPolicyModes.html#Titanium_Web_Proxy_Options_ProxyPolicyModes_AllEnforce">AllEnforce</a>) decodes and sends
<code>GOAWAY(PROTOCOL_ERROR)</code> on violations.
</p>
</td>
</tr>
<tr>
<td id="Titanium_Web_Proxy_Options_PolicyFamily_WebSocketFrameBudget">WebSocketFrameBudget</td>
<td><p>Per-frame WebSocket payload limit (<code>MaxWebSocketFramePayloadBytes</code>) applied only when
<code>BeforeWebSocketFrame</code> is subscribed. Raw relay is unaffected.</p>
<p>
<a class="xref" href="Titanium.Web.Proxy.Options.PolicyMode.html#Titanium_Web_Proxy_Options_PolicyMode_Enforce">Enforce</a> (default on every profile) closes the connection with
status 1009 before the payload is buffered.
</p>
<p>
<a class="xref" href="Titanium.Web.Proxy.Options.PolicyMode.html#Titanium_Web_Proxy_Options_PolicyMode_Observe">Observe</a> relays an oversize frame without materializing it and
raises <code>SessionEventArgs.WebSocketFrameElided</code>. Frame hooks are not invoked for
that payload, so a content filter must stay on <a class="xref" href="Titanium.Web.Proxy.Options.PolicyMode.html#Titanium_Web_Proxy_Options_PolicyMode_Enforce">Enforce</a>.
</p>
<p>
<a class="xref" href="Titanium.Web.Proxy.Options.PolicyMode.html#Titanium_Web_Proxy_Options_PolicyMode_Disabled">Disabled</a> skips the check and will buffer the frame, up to the
decoder's structural <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32.maxvalue">MaxValue</a> bound.
</p>
</td>
</tr>
</tbody>
Expand Down
13 changes: 8 additions & 5 deletions docs/api/Titanium.Web.Proxy.Options.ProxyPolicyModes.html
Original file line number Diff line number Diff line change
Expand Up @@ -255,11 +255,14 @@ <h3 id="methods">Methods
<a href="https://github.com/justcoding121/titanium-web-proxy/new/develop/apiSpec/new?filename=Titanium_Web_Proxy_Options_ProxyPolicyModes_Create_Titanium_Web_Proxy_Options_PolicyMode_Titanium_Web_Proxy_Options_PolicyMode_Titanium_Web_Proxy_Options_PolicyMode_Titanium_Web_Proxy_Options_PolicyMode_Titanium_Web_Proxy_Options_PolicyMode_Titanium_Web_Proxy_Options_PolicyMode_Titanium_Web_Proxy_Options_PolicyMode_.md&amp;value=---%0Auid%3A%20Titanium.Web.Proxy.Options.ProxyPolicyModes.Create(Titanium.Web.Proxy.Options.PolicyMode%2CTitanium.Web.Proxy.Options.PolicyMode%2CTitanium.Web.Proxy.Options.PolicyMode%2CTitanium.Web.Proxy.Options.PolicyMode%2CTitanium.Web.Proxy.Options.PolicyMode%2CTitanium.Web.Proxy.Options.PolicyMode%2CTitanium.Web.Proxy.Options.PolicyMode)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/justcoding121/titanium-web-proxy/blob/develop/src/Titanium.Web.Proxy/Options/ProxyPolicyModes.cs/#L58">View Source</a>
<a href="https://github.com/justcoding121/titanium-web-proxy/blob/develop/src/Titanium.Web.Proxy/Options/ProxyPolicyModes.cs/#L63">View Source</a>
</span>
<a id="Titanium_Web_Proxy_Options_ProxyPolicyModes_Create_" data-uid="Titanium.Web.Proxy.Options.ProxyPolicyModes.Create*"></a>
<h4 id="Titanium_Web_Proxy_Options_ProxyPolicyModes_Create_Titanium_Web_Proxy_Options_PolicyMode_Titanium_Web_Proxy_Options_PolicyMode_Titanium_Web_Proxy_Options_PolicyMode_Titanium_Web_Proxy_Options_PolicyMode_Titanium_Web_Proxy_Options_PolicyMode_Titanium_Web_Proxy_Options_PolicyMode_Titanium_Web_Proxy_Options_PolicyMode_" data-uid="Titanium.Web.Proxy.Options.ProxyPolicyModes.Create(Titanium.Web.Proxy.Options.PolicyMode,Titanium.Web.Proxy.Options.PolicyMode,Titanium.Web.Proxy.Options.PolicyMode,Titanium.Web.Proxy.Options.PolicyMode,Titanium.Web.Proxy.Options.PolicyMode,Titanium.Web.Proxy.Options.PolicyMode,Titanium.Web.Proxy.Options.PolicyMode)">Create(PolicyMode, PolicyMode, PolicyMode, PolicyMode, PolicyMode, PolicyMode, PolicyMode)</h4>
<div class="markdown level1 summary"><p>Builds a snapshot with an explicit mode for every family. <a class="xref" href="Titanium.Web.Proxy.Options.ProxyPolicyModes.html#Titanium_Web_Proxy_Options_ProxyPolicyModes_AllowAmbiguousFraming">AllowAmbiguousFraming</a> starts <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
<div class="markdown level1 summary"><p>Builds a snapshot with an explicit mode for the first seven families.
<a class="xref" href="Titanium.Web.Proxy.Options.PolicyFamily.html#Titanium_Web_Proxy_Options_PolicyFamily_WebSocketFrameBudget">WebSocketFrameBudget</a> starts at <a class="xref" href="Titanium.Web.Proxy.Options.PolicyMode.html#Titanium_Web_Proxy_Options_PolicyMode_Enforce">Enforce</a> (use
<a class="xref" href="Titanium.Web.Proxy.Options.ProxyPolicyModes.html#Titanium_Web_Proxy_Options_ProxyPolicyModes_With_Titanium_Web_Proxy_Options_PolicyFamily_Titanium_Web_Proxy_Options_PolicyMode_">With(PolicyFamily, PolicyMode)</a> to change it) so this shipped signature stays binary-compatible.
<a class="xref" href="Titanium.Web.Proxy.Options.ProxyPolicyModes.html#Titanium_Web_Proxy_Options_ProxyPolicyModes_AllowAmbiguousFraming">AllowAmbiguousFraming</a> starts <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
Expand Down Expand Up @@ -333,7 +336,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/justcoding121/titanium-web-proxy/new/develop/apiSpec/new?filename=Titanium_Web_Proxy_Options_ProxyPolicyModes_With_Titanium_Web_Proxy_Options_PolicyFamily_Titanium_Web_Proxy_Options_PolicyMode_.md&amp;value=---%0Auid%3A%20Titanium.Web.Proxy.Options.ProxyPolicyModes.With(Titanium.Web.Proxy.Options.PolicyFamily%2CTitanium.Web.Proxy.Options.PolicyMode)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/justcoding121/titanium-web-proxy/blob/develop/src/Titanium.Web.Proxy/Options/ProxyPolicyModes.cs/#L81">View Source</a>
<a href="https://github.com/justcoding121/titanium-web-proxy/blob/develop/src/Titanium.Web.Proxy/Options/ProxyPolicyModes.cs/#L87">View Source</a>
</span>
<a id="Titanium_Web_Proxy_Options_ProxyPolicyModes_With_" data-uid="Titanium.Web.Proxy.Options.ProxyPolicyModes.With*"></a>
<h4 id="Titanium_Web_Proxy_Options_ProxyPolicyModes_With_Titanium_Web_Proxy_Options_PolicyFamily_Titanium_Web_Proxy_Options_PolicyMode_" data-uid="Titanium.Web.Proxy.Options.ProxyPolicyModes.With(Titanium.Web.Proxy.Options.PolicyFamily,Titanium.Web.Proxy.Options.PolicyMode)">With(PolicyFamily, PolicyMode)</h4>
Expand Down Expand Up @@ -386,7 +389,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/justcoding121/titanium-web-proxy/new/develop/apiSpec/new?filename=Titanium_Web_Proxy_Options_ProxyPolicyModes_WithAllObservedExceptDisabled.md&amp;value=---%0Auid%3A%20Titanium.Web.Proxy.Options.ProxyPolicyModes.WithAllObservedExceptDisabled%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/justcoding121/titanium-web-proxy/blob/develop/src/Titanium.Web.Proxy/Options/ProxyPolicyModes.cs/#L93">View Source</a>
<a href="https://github.com/justcoding121/titanium-web-proxy/blob/develop/src/Titanium.Web.Proxy/Options/ProxyPolicyModes.cs/#L99">View Source</a>
</span>
<a id="Titanium_Web_Proxy_Options_ProxyPolicyModes_WithAllObservedExceptDisabled_" data-uid="Titanium.Web.Proxy.Options.ProxyPolicyModes.WithAllObservedExceptDisabled*"></a>
<h4 id="Titanium_Web_Proxy_Options_ProxyPolicyModes_WithAllObservedExceptDisabled" data-uid="Titanium.Web.Proxy.Options.ProxyPolicyModes.WithAllObservedExceptDisabled">WithAllObservedExceptDisabled()</h4>
Expand Down Expand Up @@ -420,7 +423,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/justcoding121/titanium-web-proxy/new/develop/apiSpec/new?filename=Titanium_Web_Proxy_Options_ProxyPolicyModes_WithAllowAmbiguousFramingEnabled.md&amp;value=---%0Auid%3A%20Titanium.Web.Proxy.Options.ProxyPolicyModes.WithAllowAmbiguousFramingEnabled%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/justcoding121/titanium-web-proxy/blob/develop/src/Titanium.Web.Proxy/Options/ProxyPolicyModes.cs/#L110">View Source</a>
<a href="https://github.com/justcoding121/titanium-web-proxy/blob/develop/src/Titanium.Web.Proxy/Options/ProxyPolicyModes.cs/#L116">View Source</a>
</span>
<a id="Titanium_Web_Proxy_Options_ProxyPolicyModes_WithAllowAmbiguousFramingEnabled_" data-uid="Titanium.Web.Proxy.Options.ProxyPolicyModes.WithAllowAmbiguousFramingEnabled*"></a>
<h4 id="Titanium_Web_Proxy_Options_ProxyPolicyModes_WithAllowAmbiguousFramingEnabled" data-uid="Titanium.Web.Proxy.Options.ProxyPolicyModes.WithAllowAmbiguousFramingEnabled">WithAllowAmbiguousFramingEnabled()</h4>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/Titanium.Web.Proxy.ProxyLimits.html
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ <h4 id="Titanium_Web_Proxy_ProxyLimits_DefaultMaxBufferedBodyBytes" data-uid="Ti
<div class="markdown level1 summary"><p>Reference value only - see the type-level remarks. Matches the current default of
<code>ProxyServer.MaxBufferedBodyBytes</code>: maximum buffered request or response body size for
proxied exchanges where full buffering is required (body mutation, authentication retry,
etc.).
etc.). Streaming relays are not counted against this value.
Default: 4 MiB.</p>
</div>
<div class="markdown level1 conceptual"></div>
Expand Down
Loading
Loading