Commit 4893168b authored by buildbot121's avatar buildbot121

API documentation update by build server

parent 95c4cecf
......@@ -83,7 +83,7 @@
<h1 id="Titanium_Web_Proxy_EventArguments_AsyncEventHandler_1" data-uid="Titanium.Web.Proxy.EventArguments.AsyncEventHandler`1" class="text-break">Delegate AsyncEventHandler&lt;TEventArgs&gt;
</h1>
<div class="markdown level0 summary"><p>A generic asynchronous event handler used by this proxy.</p>
<div class="markdown level0 summary"><p>A generic asynchronous event handler used by the proxy.</p>
</div>
<div class="markdown level0 conceptual"></div>
<h6><strong>Namespace</strong>: <a class="xref" href="Titanium.Web.Proxy.EventArguments.html">Titanium.Web.Proxy.EventArguments</a></h6>
......@@ -142,7 +142,8 @@
<tbody>
<tr>
<td><span class="parametername">TEventArgs</span></td>
<td></td>
<td><p>Event argument type.</p>
</td>
</tr>
</tbody>
</table>
......
......@@ -159,7 +159,7 @@ If false we relay the connection to the hostname mentioned in SniHostname.</p>
<a id="Titanium_Web_Proxy_EventArguments_BeforeSslAuthenticateEventArgs_SniHostName_" data-uid="Titanium.Web.Proxy.EventArguments.BeforeSslAuthenticateEventArgs.SniHostName*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_BeforeSslAuthenticateEventArgs_SniHostName" data-uid="Titanium.Web.Proxy.EventArguments.BeforeSslAuthenticateEventArgs.SniHostName">SniHostName</h4>
<div class="markdown level1 summary"><p>The server name indication hostname.</p>
<div class="markdown level1 summary"><p>The server name indication hostname if available. Otherwise the generic certificate hostname of TransparentEndPoint.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -187,7 +187,7 @@ If false we relay the connection to the hostname mentioned in SniHostname.</p>
<a id="Titanium_Web_Proxy_EventArguments_BeforeSslAuthenticateEventArgs_TerminateSession_" data-uid="Titanium.Web.Proxy.EventArguments.BeforeSslAuthenticateEventArgs.TerminateSession*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_BeforeSslAuthenticateEventArgs_TerminateSession" data-uid="Titanium.Web.Proxy.EventArguments.BeforeSslAuthenticateEventArgs.TerminateSession">TerminateSession()</h4>
<div class="markdown level1 summary"><p>Terminate the request abruptly.</p>
<div class="markdown level1 summary"><p>Terminate the request abruptly by closing client/server connections.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......
......@@ -131,7 +131,7 @@
<a id="Titanium_Web_Proxy_EventArguments_CertificateSelectionEventArgs_AcceptableIssuers_" data-uid="Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs.AcceptableIssuers*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_CertificateSelectionEventArgs_AcceptableIssuers" data-uid="Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs.AcceptableIssuers">AcceptableIssuers</h4>
<div class="markdown level1 summary"><p>Acceptable issuers mentioned by server.</p>
<div class="markdown level1 summary"><p>Acceptable issuers as listed by remoted server.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -157,7 +157,7 @@
<a id="Titanium_Web_Proxy_EventArguments_CertificateSelectionEventArgs_ClientCertificate_" data-uid="Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs.ClientCertificate*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_CertificateSelectionEventArgs_ClientCertificate" data-uid="Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs.ClientCertificate">ClientCertificate</h4>
<div class="markdown level1 summary"><p>Client Certificate we selected.</p>
<div class="markdown level1 summary"><p>Client Certificate we selected. Set this value to override.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -183,7 +183,7 @@
<a id="Titanium_Web_Proxy_EventArguments_CertificateSelectionEventArgs_LocalCertificates_" data-uid="Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs.LocalCertificates*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_CertificateSelectionEventArgs_LocalCertificates" data-uid="Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs.LocalCertificates">LocalCertificates</h4>
<div class="markdown level1 summary"><p>Local certificates with matching issuers.</p>
<div class="markdown level1 summary"><p>Local certificates in store with matching issuers requested by TargetHost website.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -209,7 +209,7 @@
<a id="Titanium_Web_Proxy_EventArguments_CertificateSelectionEventArgs_RemoteCertificate_" data-uid="Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs.RemoteCertificate*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_CertificateSelectionEventArgs_RemoteCertificate" data-uid="Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs.RemoteCertificate">RemoteCertificate</h4>
<div class="markdown level1 summary"><p>Remote certificate of the server.</p>
<div class="markdown level1 summary"><p>Certificate of the remote server.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -261,7 +261,7 @@
<a id="Titanium_Web_Proxy_EventArguments_CertificateSelectionEventArgs_TargetHost_" data-uid="Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs.TargetHost*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_CertificateSelectionEventArgs_TargetHost" data-uid="Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs.TargetHost">TargetHost</h4>
<div class="markdown level1 summary"><p>The host to which we are authenticating against.</p>
<div class="markdown level1 summary"><p>The remote hostname to which we are authenticating against.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......
......@@ -184,7 +184,7 @@ during SSL authentication.</p>
<a id="Titanium_Web_Proxy_EventArguments_CertificateValidationEventArgs_IsValid_" data-uid="Titanium.Web.Proxy.EventArguments.CertificateValidationEventArgs.IsValid*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_CertificateValidationEventArgs_IsValid" data-uid="Titanium.Web.Proxy.EventArguments.CertificateValidationEventArgs.IsValid">IsValid</h4>
<div class="markdown level1 summary"><p>Is the given server certificate is valid?</p>
<div class="markdown level1 summary"><p>Is the given server certificate valid?</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......
......@@ -157,7 +157,7 @@
<a id="Titanium_Web_Proxy_EventArguments_DataEventArgs_Count_" data-uid="Titanium.Web.Proxy.EventArguments.DataEventArgs.Count*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_DataEventArgs_Count" data-uid="Titanium.Web.Proxy.EventArguments.DataEventArgs.Count">Count</h4>
<div class="markdown level1 summary"><p>Length from offset in Buffer with valid data.</p>
<div class="markdown level1 summary"><p>Length from offset in buffer with valid data.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -183,7 +183,7 @@
<a id="Titanium_Web_Proxy_EventArguments_DataEventArgs_Offset_" data-uid="Titanium.Web.Proxy.EventArguments.DataEventArgs.Offset*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_DataEventArgs_Offset" data-uid="Titanium.Web.Proxy.EventArguments.DataEventArgs.Offset">Offset</h4>
<div class="markdown level1 summary"><p>Offset in Buffer where valid data begins.</p>
<div class="markdown level1 summary"><p>Offset in buffer from which valid data begins.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......
......@@ -125,47 +125,13 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class MultipartRequestPartSentEventArgs : EventArgs</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<a id="Titanium_Web_Proxy_EventArguments_MultipartRequestPartSentEventArgs__ctor_" data-uid="Titanium.Web.Proxy.EventArguments.MultipartRequestPartSentEventArgs.#ctor*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_MultipartRequestPartSentEventArgs__ctor_System_String_Titanium_Web_Proxy_Http_HeaderCollection_" data-uid="Titanium.Web.Proxy.EventArguments.MultipartRequestPartSentEventArgs.#ctor(System.String,Titanium.Web.Proxy.Http.HeaderCollection)">MultipartRequestPartSentEventArgs(String, HeaderCollection)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MultipartRequestPartSentEventArgs(string boundary, HeaderCollection headers)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
<td><span class="parametername">boundary</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Titanium.Web.Proxy.Http.HeaderCollection.html">HeaderCollection</a></td>
<td><span class="parametername">headers</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<a id="Titanium_Web_Proxy_EventArguments_MultipartRequestPartSentEventArgs_Boundary_" data-uid="Titanium.Web.Proxy.EventArguments.MultipartRequestPartSentEventArgs.Boundary*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_MultipartRequestPartSentEventArgs_Boundary" data-uid="Titanium.Web.Proxy.EventArguments.MultipartRequestPartSentEventArgs.Boundary">Boundary</h4>
<div class="markdown level1 summary"><p>Boundary</p>
<div class="markdown level1 summary"><p>Boundary.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......
......@@ -255,7 +255,7 @@ or when server terminates connection from proxy.</p>
<a id="Titanium_Web_Proxy_EventArguments_SessionEventArgs_Dispose_" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgs.Dispose*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_SessionEventArgs_Dispose" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgs.Dispose">Dispose()</h4>
<div class="markdown level1 summary"><p>implement any cleanup here</p>
<div class="markdown level1 summary"><p>Implement any cleanup here</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -289,17 +289,20 @@ the specified status to client. And then ignore the request.</p>
<tr>
<td><span class="xref">System.Byte</span>[]</td>
<td><span class="parametername">result</span></td>
<td></td>
<td><p>The bytes to sent.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.net.httpstatuscode">HttpStatusCode</a></td>
<td><span class="parametername">status</span></td>
<td></td>
<td><p>The HTTP status code.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.dictionary-2">Dictionary</a>&lt;<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a>, <a class="xref" href="Titanium.Web.Proxy.Models.HttpHeader.html">HttpHeader</a>&gt;</td>
<td><span class="parametername">headers</span></td>
<td></td>
<td><p>The HTTP headers.</p>
</td>
</tr>
</tbody>
</table>
......@@ -329,17 +332,20 @@ And then ignore the request. </p>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
<td><span class="parametername">html</span></td>
<td></td>
<td><p>The html content.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.net.httpstatuscode">HttpStatusCode</a></td>
<td><span class="parametername">status</span></td>
<td></td>
<td><p>The HTTP status code.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.dictionary-2">Dictionary</a>&lt;<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a>, <a class="xref" href="Titanium.Web.Proxy.Models.HttpHeader.html">HttpHeader</a>&gt;</td>
<td><span class="parametername">headers</span></td>
<td></td>
<td><p>The HTTP headers.</p>
</td>
</tr>
</tbody>
</table>
......@@ -367,7 +373,8 @@ And then ignore the request. </p>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></td>
<td><span class="parametername">cancellationToken</span></td>
<td></td>
<td><p>Optional cancellation token for this async task.</p>
</td>
</tr>
</tbody>
</table>
......@@ -411,7 +418,7 @@ And then ignore the request. </p>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></td>
<td><span class="parametername">cancellationToken</span></td>
<td><p>Cancellation token for this async task is optional.</p>
<td><p>Optional cancellation token for this async task.</p>
</td>
</tr>
</tbody>
......@@ -456,7 +463,8 @@ And then ignore the request. </p>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></td>
<td><span class="parametername">cancellationToken</span></td>
<td></td>
<td><p>Optional cancellation token for this async task.</p>
</td>
</tr>
</tbody>
</table>
......@@ -471,7 +479,8 @@ And then ignore the request. </p>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<span class="xref">System.Byte</span>[]&gt;</td>
<td></td>
<td><p>The resulting bytes.</p>
</td>
</tr>
</tbody>
</table>
......@@ -499,7 +508,8 @@ And then ignore the request. </p>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></td>
<td><span class="parametername">cancellationToken</span></td>
<td></td>
<td><p>Optional cancellation token for this async task.</p>
</td>
</tr>
</tbody>
</table>
......@@ -544,12 +554,14 @@ and ignore the request. </p>
<tr>
<td><span class="xref">System.Byte</span>[]</td>
<td><span class="parametername">result</span></td>
<td></td>
<td><p>The html content bytes.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.dictionary-2">Dictionary</a>&lt;<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a>, <a class="xref" href="Titanium.Web.Proxy.Models.HttpHeader.html">HttpHeader</a>&gt;</td>
<td><span class="parametername">headers</span></td>
<td></td>
<td><p>The HTTP headers.</p>
</td>
</tr>
</tbody>
</table>
......@@ -578,12 +590,14 @@ and ignore the request. </p>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
<td><span class="parametername">html</span></td>
<td></td>
<td><p>HTML content to sent.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.dictionary-2">Dictionary</a>&lt;<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a>, <a class="xref" href="Titanium.Web.Proxy.Models.HttpHeader.html">HttpHeader</a>&gt;</td>
<td><span class="parametername">headers</span></td>
<td></td>
<td><p>HTTP response headers.</p>
</td>
</tr>
</tbody>
</table>
......@@ -611,7 +625,8 @@ and ignore the request. </p>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
<td><span class="parametername">url</span></td>
<td></td>
<td><p>The URL to redirect.</p>
</td>
</tr>
</tbody>
</table>
......@@ -619,7 +634,8 @@ and ignore the request. </p>
<a id="Titanium_Web_Proxy_EventArguments_SessionEventArgs_Respond_" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgs.Respond*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_SessionEventArgs_Respond_Titanium_Web_Proxy_Http_Response_" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgs.Respond(Titanium.Web.Proxy.Http.Response)">Respond(Response)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Respond with given response object to client.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
......@@ -638,7 +654,8 @@ and ignore the request. </p>
<tr>
<td><a class="xref" href="Titanium.Web.Proxy.Http.Response.html">Response</a></td>
<td><span class="parametername">response</span></td>
<td></td>
<td><p>The response object.</p>
</td>
</tr>
</tbody>
</table>
......@@ -724,7 +741,8 @@ and ignore the request. </p>
<tr>
<td><span class="xref">System.Byte</span>[]</td>
<td><span class="parametername">body</span></td>
<td></td>
<td><p>The body bytes to set.</p>
</td>
</tr>
</tbody>
</table>
......@@ -752,7 +770,8 @@ and ignore the request. </p>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
<td><span class="parametername">body</span></td>
<td></td>
<td><p>The body string to set.</p>
</td>
</tr>
</tbody>
</table>
......@@ -760,7 +779,8 @@ and ignore the request. </p>
<a id="Titanium_Web_Proxy_EventArguments_SessionEventArgs_TerminateServerConnection_" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgs.TerminateServerConnection*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_SessionEventArgs_TerminateServerConnection" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgs.TerminateServerConnection">TerminateServerConnection()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Terminate the connection to server.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
......
......@@ -83,10 +83,10 @@
<h1 id="Titanium_Web_Proxy_EventArguments_SessionEventArgsBase" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgsBase" class="text-break">Class SessionEventArgsBase
</h1>
<div class="markdown level0 summary"><p>Holds info related to a single proxy session (single request/response sequence)
A proxy session is bounded to a single connection from client
<div class="markdown level0 summary"><p>Holds info related to a single proxy session (single request/response sequence).
A proxy session is bounded to a single connection from client.
A proxy session ends when client terminates connection to proxy
or when server terminates connection from proxy</p>
or when server terminates connection from proxy.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
......@@ -292,7 +292,8 @@ or when server terminates connection from proxy</p>
<a id="Titanium_Web_Proxy_EventArguments_SessionEventArgsBase_Exception_" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.Exception*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_SessionEventArgsBase_Exception" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.Exception">Exception</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>The last exception that happened.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
......@@ -317,8 +318,8 @@ or when server terminates connection from proxy</p>
<a id="Titanium_Web_Proxy_EventArguments_SessionEventArgsBase_Id_" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.Id*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_SessionEventArgsBase_Id" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.Id">Id</h4>
<div class="markdown level1 summary"><p>Returns a unique Id for this request/response session
same as RequestId of WebSession</p>
<div class="markdown level1 summary"><p>Returns a unique Id for this request/response session which is
same as the RequestId of WebSession.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -344,7 +345,7 @@ same as RequestId of WebSession</p>
<a id="Titanium_Web_Proxy_EventArguments_SessionEventArgsBase_IsHttps_" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.IsHttps*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_SessionEventArgsBase_IsHttps" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.IsHttps">IsHttps</h4>
<div class="markdown level1 summary"><p>Does this session uses SSL</p>
<div class="markdown level1 summary"><p>Does this session uses SSL?</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -370,7 +371,8 @@ same as RequestId of WebSession</p>
<a id="Titanium_Web_Proxy_EventArguments_SessionEventArgsBase_IsTransparent_" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.IsTransparent*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_SessionEventArgsBase_IsTransparent" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.IsTransparent">IsTransparent</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Is this a transparent endpoint?</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
......@@ -395,7 +397,8 @@ same as RequestId of WebSession</p>
<a id="Titanium_Web_Proxy_EventArguments_SessionEventArgsBase_LocalEndPoint_" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.LocalEndPoint*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_SessionEventArgsBase_LocalEndPoint" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.LocalEndPoint">LocalEndPoint</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Local endpoint via which we make the request.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
......@@ -421,7 +424,7 @@ same as RequestId of WebSession</p>
<a id="Titanium_Web_Proxy_EventArguments_SessionEventArgsBase_WebSession_" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.WebSession*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_SessionEventArgsBase_WebSession" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.WebSession">WebSession</h4>
<div class="markdown level1 summary"><p>A web session corresponding to a single request/response sequence
within a proxy connection</p>
within a proxy connection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -449,7 +452,7 @@ within a proxy connection</p>
<a id="Titanium_Web_Proxy_EventArguments_SessionEventArgsBase_Dispose_" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.Dispose*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_SessionEventArgsBase_Dispose" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.Dispose">Dispose()</h4>
<div class="markdown level1 summary"><p>implement any cleanup here</p>
<div class="markdown level1 summary"><p>Implements cleanup here.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -460,7 +463,7 @@ within a proxy connection</p>
<a id="Titanium_Web_Proxy_EventArguments_SessionEventArgsBase_TerminateSession_" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.TerminateSession*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_SessionEventArgsBase_TerminateSession" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.TerminateSession">TerminateSession()</h4>
<div class="markdown level1 summary"><p>Terminates the session abruptly by terminating client/server connections</p>
<div class="markdown level1 summary"><p>Terminates the session abruptly by terminating client/server connections.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -472,7 +475,8 @@ within a proxy connection</p>
<h4 id="Titanium_Web_Proxy_EventArguments_SessionEventArgsBase_DataReceived" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.DataReceived">DataReceived</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Fired when data is received within this session from client/server.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
......@@ -496,7 +500,8 @@ within a proxy connection</p>
<h4 id="Titanium_Web_Proxy_EventArguments_SessionEventArgsBase_DataSent" data-uid="Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.DataSent">DataSent</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Fired when data is sent within this session to server/client.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
......
......@@ -83,7 +83,8 @@
<h1 id="Titanium_Web_Proxy_EventArguments_TunnelConnectSessionEventArgs" data-uid="Titanium.Web.Proxy.EventArguments.TunnelConnectSessionEventArgs" class="text-break">Class TunnelConnectSessionEventArgs
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 summary"><p>A class that wraps the state when a tunnel connect event happen for Explicit endpoints.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
......@@ -177,7 +178,9 @@
<a id="Titanium_Web_Proxy_EventArguments_TunnelConnectSessionEventArgs_DecryptSsl_" data-uid="Titanium.Web.Proxy.EventArguments.TunnelConnectSessionEventArgs.DecryptSsl*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_TunnelConnectSessionEventArgs_DecryptSsl" data-uid="Titanium.Web.Proxy.EventArguments.TunnelConnectSessionEventArgs.DecryptSsl">DecryptSsl</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Should we decrypt the Ssl or relay it to server?
Default is true.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
......@@ -202,7 +205,7 @@
<a id="Titanium_Web_Proxy_EventArguments_TunnelConnectSessionEventArgs_DenyConnect_" data-uid="Titanium.Web.Proxy.EventArguments.TunnelConnectSessionEventArgs.DenyConnect*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_TunnelConnectSessionEventArgs_DenyConnect" data-uid="Titanium.Web.Proxy.EventArguments.TunnelConnectSessionEventArgs.DenyConnect">DenyConnect</h4>
<div class="markdown level1 summary"><p>Denies the connect request with a Forbidden status</p>
<div class="markdown level1 summary"><p>When set to true it denies the connect request with a Forbidden status.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -228,7 +231,8 @@
<a id="Titanium_Web_Proxy_EventArguments_TunnelConnectSessionEventArgs_IsHttpsConnect_" data-uid="Titanium.Web.Proxy.EventArguments.TunnelConnectSessionEventArgs.IsHttpsConnect*"></a>
<h4 id="Titanium_Web_Proxy_EventArguments_TunnelConnectSessionEventArgs_IsHttpsConnect" data-uid="Titanium.Web.Proxy.EventArguments.TunnelConnectSessionEventArgs.IsHttpsConnect">IsHttpsConnect</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Is this a connect request to secure HTTP server? Or is it to someother protocol.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
......
......@@ -110,17 +110,18 @@ A proxy session ends when client terminates connection to proxy
or when server terminates connection from proxy.</p>
</section>
<h4><a class="xref" href="Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.html">SessionEventArgsBase</a></h4>
<section><p>Holds info related to a single proxy session (single request/response sequence)
A proxy session is bounded to a single connection from client
<section><p>Holds info related to a single proxy session (single request/response sequence).
A proxy session is bounded to a single connection from client.
A proxy session ends when client terminates connection to proxy
or when server terminates connection from proxy</p>
or when server terminates connection from proxy.</p>
</section>
<h4><a class="xref" href="Titanium.Web.Proxy.EventArguments.TunnelConnectSessionEventArgs.html">TunnelConnectSessionEventArgs</a></h4>
<section></section>
<section><p>A class that wraps the state when a tunnel connect event happen for Explicit endpoints.</p>
</section>
<h3 id="delegates">Delegates
</h3>
<h4><a class="xref" href="Titanium.Web.Proxy.EventArguments.AsyncEventHandler-1.html">AsyncEventHandler&lt;TEventArgs&gt;</a></h4>
<section><p>A generic asynchronous event handler used by this proxy.</p>
<section><p>A generic asynchronous event handler used by the proxy.</p>
</section>
</article>
</div>
......
......@@ -83,7 +83,7 @@
<h1 id="Titanium_Web_Proxy_Exceptions_BodyNotFoundException" data-uid="Titanium.Web.Proxy.Exceptions.BodyNotFoundException" class="text-break">Class BodyNotFoundException
</h1>
<div class="markdown level0 summary"><p>An expception thrown when body is unexpectedly empty</p>
<div class="markdown level0 summary"><p>An exception thrown when body is unexpectedly empty.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
......
......@@ -83,7 +83,7 @@
<h1 id="Titanium_Web_Proxy_Exceptions_ProxyAuthorizationException" data-uid="Titanium.Web.Proxy.Exceptions.ProxyAuthorizationException" class="text-break">Class ProxyAuthorizationException
</h1>
<div class="markdown level0 summary"><p>Proxy authorization exception</p>
<div class="markdown level0 summary"><p>Proxy authorization exception.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
......@@ -167,7 +167,7 @@
<a id="Titanium_Web_Proxy_Exceptions_ProxyAuthorizationException_Headers_" data-uid="Titanium.Web.Proxy.Exceptions.ProxyAuthorizationException.Headers*"></a>
<h4 id="Titanium_Web_Proxy_Exceptions_ProxyAuthorizationException_Headers" data-uid="Titanium.Web.Proxy.Exceptions.ProxyAuthorizationException.Headers">Headers</h4>
<div class="markdown level1 summary"><p>Headers associated with the authorization exception</p>
<div class="markdown level1 summary"><p>Headers associated with the authorization exception.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -193,7 +193,8 @@
<a id="Titanium_Web_Proxy_Exceptions_ProxyAuthorizationException_Session_" data-uid="Titanium.Web.Proxy.Exceptions.ProxyAuthorizationException.Session*"></a>
<h4 id="Titanium_Web_Proxy_Exceptions_ProxyAuthorizationException_Session" data-uid="Titanium.Web.Proxy.Exceptions.ProxyAuthorizationException.Session">Session</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>The current session within which this error happened.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
......
......@@ -83,7 +83,7 @@
<h1 id="Titanium_Web_Proxy_Exceptions_ProxyException" data-uid="Titanium.Web.Proxy.Exceptions.ProxyException" class="text-break">Class ProxyException
</h1>
<div class="markdown level0 summary"><p>Base class exception associated with this proxy implementation</p>
<div class="markdown level0 summary"><p>Base class exception associated with this proxy server.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
......
......@@ -83,7 +83,7 @@
<h1 id="Titanium_Web_Proxy_Exceptions_ProxyHttpException" data-uid="Titanium.Web.Proxy.Exceptions.ProxyHttpException" class="text-break">Class ProxyHttpException
</h1>
<div class="markdown level0 summary"><p>Proxy HTTP exception</p>
<div class="markdown level0 summary"><p>Proxy HTTP exception.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
......@@ -167,7 +167,7 @@
<a id="Titanium_Web_Proxy_Exceptions_ProxyHttpException_SessionEventArgs_" data-uid="Titanium.Web.Proxy.Exceptions.ProxyHttpException.SessionEventArgs*"></a>
<h4 id="Titanium_Web_Proxy_Exceptions_ProxyHttpException_SessionEventArgs" data-uid="Titanium.Web.Proxy.Exceptions.ProxyHttpException.SessionEventArgs">SessionEventArgs</h4>
<div class="markdown level1 summary"><p>Gets session info associated to the exception</p>
<div class="markdown level1 summary"><p>Gets session info associated to the exception.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -190,7 +190,7 @@
</tbody>
</table>
<h5 id="Titanium_Web_Proxy_Exceptions_ProxyHttpException_SessionEventArgs_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This object should not be edited</p>
<div class="markdown level1 remarks"><p>This object properties should not be edited.</p>
</div>
<h3 id="implements">Implements</h3>
<div>
......
......@@ -88,16 +88,16 @@
<h3 id="classes">Classes
</h3>
<h4><a class="xref" href="Titanium.Web.Proxy.Exceptions.BodyNotFoundException.html">BodyNotFoundException</a></h4>
<section><p>An expception thrown when body is unexpectedly empty</p>
<section><p>An exception thrown when body is unexpectedly empty.</p>
</section>
<h4><a class="xref" href="Titanium.Web.Proxy.Exceptions.ProxyAuthorizationException.html">ProxyAuthorizationException</a></h4>
<section><p>Proxy authorization exception</p>
<section><p>Proxy authorization exception.</p>
</section>
<h4><a class="xref" href="Titanium.Web.Proxy.Exceptions.ProxyException.html">ProxyException</a></h4>
<section><p>Base class exception associated with this proxy implementation</p>
<section><p>Base class exception associated with this proxy server.</p>
</section>
<h4><a class="xref" href="Titanium.Web.Proxy.Exceptions.ProxyHttpException.html">ProxyHttpException</a></h4>
<section><p>Proxy HTTP exception</p>
<section><p>Proxy HTTP exception.</p>
</section>
</article>
</div>
......
......@@ -145,7 +145,7 @@ public class HeaderCollection : IEnumerable&lt;HttpHeader&gt;, IEnumerable</code
<a id="Titanium_Web_Proxy_Http_HeaderCollection_Headers_" data-uid="Titanium.Web.Proxy.Http.HeaderCollection.Headers*"></a>
<h4 id="Titanium_Web_Proxy_Http_HeaderCollection_Headers" data-uid="Titanium.Web.Proxy.Http.HeaderCollection.Headers">Headers</h4>
<div class="markdown level1 summary"><p>Unique Request header collection</p>
<div class="markdown level1 summary"><p>Unique Request header collection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -171,7 +171,7 @@ public class HeaderCollection : IEnumerable&lt;HttpHeader&gt;, IEnumerable</code
<a id="Titanium_Web_Proxy_Http_HeaderCollection_NonUniqueHeaders_" data-uid="Titanium.Web.Proxy.Http.HeaderCollection.NonUniqueHeaders*"></a>
<h4 id="Titanium_Web_Proxy_Http_HeaderCollection_NonUniqueHeaders" data-uid="Titanium.Web.Proxy.Http.HeaderCollection.NonUniqueHeaders">NonUniqueHeaders</h4>
<div class="markdown level1 summary"><p>Non Unique headers</p>
<div class="markdown level1 summary"><p>Non Unique headers.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......
......@@ -166,7 +166,7 @@ public class Request : RequestResponseBase</code></pre>
<a id="Titanium_Web_Proxy_Http_Request_ExpectationFailed_" data-uid="Titanium.Web.Proxy.Http.Request.ExpectationFailed*"></a>
<h4 id="Titanium_Web_Proxy_Http_Request_ExpectationFailed" data-uid="Titanium.Web.Proxy.Http.Request.ExpectationFailed">ExpectationFailed</h4>
<div class="markdown level1 summary"><p>Server responsed negatively for the request for 100 continue</p>
<div class="markdown level1 summary"><p>Did server responsed negatively for the request for 100 continue?</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -274,9 +274,9 @@ public class Request : RequestResponseBase</code></pre>
<a id="Titanium_Web_Proxy_Http_Request_Host_" data-uid="Titanium.Web.Proxy.Http.Request.Host*"></a>
<h4 id="Titanium_Web_Proxy_Http_Request_Host" data-uid="Titanium.Web.Proxy.Http.Request.Host">Host</h4>
<div class="markdown level1 summary"><p>Http hostname header value if exists
Note: Changing this does NOT change host in RequestUri
Users can set new RequestUri separately</p>
<div class="markdown level1 summary"><p>Http hostname header value if exists.
Note: Changing this does NOT change host in RequestUri.
Users can set new RequestUri separately.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -302,7 +302,7 @@ Users can set new RequestUri separately</p>
<a id="Titanium_Web_Proxy_Http_Request_Is100Continue_" data-uid="Titanium.Web.Proxy.Http.Request.Is100Continue*"></a>
<h4 id="Titanium_Web_Proxy_Http_Request_Is100Continue" data-uid="Titanium.Web.Proxy.Http.Request.Is100Continue">Is100Continue</h4>
<div class="markdown level1 summary"><p>Does server responsed positively for 100 continue request</p>
<div class="markdown level1 summary"><p>Did server responsed positively for 100 continue request?</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -354,7 +354,8 @@ Users can set new RequestUri separately</p>
<a id="Titanium_Web_Proxy_Http_Request_IsMultipartFormData_" data-uid="Titanium.Web.Proxy.Http.Request.IsMultipartFormData*"></a>
<h4 id="Titanium_Web_Proxy_Http_Request_IsMultipartFormData" data-uid="Titanium.Web.Proxy.Http.Request.IsMultipartFormData">IsMultipartFormData</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Does this request contain multipart/form-data?</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
......@@ -379,7 +380,7 @@ Users can set new RequestUri separately</p>
<a id="Titanium_Web_Proxy_Http_Request_Method_" data-uid="Titanium.Web.Proxy.Http.Request.Method*"></a>
<h4 id="Titanium_Web_Proxy_Http_Request_Method" data-uid="Titanium.Web.Proxy.Http.Request.Method">Method</h4>
<div class="markdown level1 summary"><p>Request Method</p>
<div class="markdown level1 summary"><p>Request Method.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -431,7 +432,7 @@ Users can set new RequestUri separately</p>
<a id="Titanium_Web_Proxy_Http_Request_RequestUri_" data-uid="Titanium.Web.Proxy.Http.Request.RequestUri*"></a>
<h4 id="Titanium_Web_Proxy_Http_Request_RequestUri" data-uid="Titanium.Web.Proxy.Http.Request.RequestUri">RequestUri</h4>
<div class="markdown level1 summary"><p>Request HTTP Uri</p>
<div class="markdown level1 summary"><p>Request HTTP Uri.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -483,7 +484,7 @@ Users can set new RequestUri separately</p>
<a id="Titanium_Web_Proxy_Http_Request_Url_" data-uid="Titanium.Web.Proxy.Http.Request.Url*"></a>
<h4 id="Titanium_Web_Proxy_Http_Request_Url" data-uid="Titanium.Web.Proxy.Http.Request.Url">Url</h4>
<div class="markdown level1 summary"><p>Request Url</p>
<div class="markdown level1 summary"><p>Request Url.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......
......@@ -124,7 +124,7 @@
<h4 id="Titanium_Web_Proxy_Http_RequestResponseBase_BodyInternal" data-uid="Titanium.Web.Proxy.Http.RequestResponseBase.BodyInternal">BodyInternal</h4>
<div class="markdown level1 summary"><p>Cached body content as byte array</p>
<div class="markdown level1 summary"><p>Cached body content as byte array.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -179,7 +179,7 @@ public byte[] Body { get; }</code></pre>
<a id="Titanium_Web_Proxy_Http_RequestResponseBase_BodyString_" data-uid="Titanium.Web.Proxy.Http.RequestResponseBase.BodyString*"></a>
<h4 id="Titanium_Web_Proxy_Http_RequestResponseBase_BodyString" data-uid="Titanium.Web.Proxy.Http.RequestResponseBase.BodyString">BodyString</h4>
<div class="markdown level1 summary"><p>Body as string
<div class="markdown level1 summary"><p>Body as string.
Use the encoding specified to decode the byte[] data to string</p>
</div>
<div class="markdown level1 conceptual"></div>
......@@ -207,7 +207,7 @@ public string BodyString { get; }</code></pre>
<a id="Titanium_Web_Proxy_Http_RequestResponseBase_ContentEncoding_" data-uid="Titanium.Web.Proxy.Http.RequestResponseBase.ContentEncoding*"></a>
<h4 id="Titanium_Web_Proxy_Http_RequestResponseBase_ContentEncoding" data-uid="Titanium.Web.Proxy.Http.RequestResponseBase.ContentEncoding">ContentEncoding</h4>
<div class="markdown level1 summary"><p>Content encoding for this request/response</p>
<div class="markdown level1 summary"><p>Content encoding for this request/response.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -233,7 +233,7 @@ public string BodyString { get; }</code></pre>
<a id="Titanium_Web_Proxy_Http_RequestResponseBase_ContentLength_" data-uid="Titanium.Web.Proxy.Http.RequestResponseBase.ContentLength*"></a>
<h4 id="Titanium_Web_Proxy_Http_RequestResponseBase_ContentLength" data-uid="Titanium.Web.Proxy.Http.RequestResponseBase.ContentLength">ContentLength</h4>
<div class="markdown level1 summary"><p>Length of the body</p>
<div class="markdown level1 summary"><p>Length of the body.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -259,7 +259,7 @@ public string BodyString { get; }</code></pre>
<a id="Titanium_Web_Proxy_Http_RequestResponseBase_ContentType_" data-uid="Titanium.Web.Proxy.Http.RequestResponseBase.ContentType*"></a>
<h4 id="Titanium_Web_Proxy_Http_RequestResponseBase_ContentType" data-uid="Titanium.Web.Proxy.Http.RequestResponseBase.ContentType">ContentType</h4>
<div class="markdown level1 summary"><p>Content-type of the request/response</p>
<div class="markdown level1 summary"><p>Content-type of the request/response.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -285,7 +285,7 @@ public string BodyString { get; }</code></pre>
<a id="Titanium_Web_Proxy_Http_RequestResponseBase_Encoding_" data-uid="Titanium.Web.Proxy.Http.RequestResponseBase.Encoding*"></a>
<h4 id="Titanium_Web_Proxy_Http_RequestResponseBase_Encoding" data-uid="Titanium.Web.Proxy.Http.RequestResponseBase.Encoding">Encoding</h4>
<div class="markdown level1 summary"><p>Encoding for this request/response</p>
<div class="markdown level1 summary"><p>Encoding for this request/response.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -337,7 +337,7 @@ public string BodyString { get; }</code></pre>
<a id="Titanium_Web_Proxy_Http_RequestResponseBase_Headers_" data-uid="Titanium.Web.Proxy.Http.RequestResponseBase.Headers*"></a>
<h4 id="Titanium_Web_Proxy_Http_RequestResponseBase_Headers" data-uid="Titanium.Web.Proxy.Http.RequestResponseBase.Headers">Headers</h4>
<div class="markdown level1 summary"><p>Collection of all headers</p>
<div class="markdown level1 summary"><p>Collection of all headers.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -363,7 +363,8 @@ public string BodyString { get; }</code></pre>
<a id="Titanium_Web_Proxy_Http_RequestResponseBase_HeaderText_" data-uid="Titanium.Web.Proxy.Http.RequestResponseBase.HeaderText*"></a>
<h4 id="Titanium_Web_Proxy_Http_RequestResponseBase_HeaderText" data-uid="Titanium.Web.Proxy.Http.RequestResponseBase.HeaderText">HeaderText</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>The header text.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
......@@ -388,7 +389,7 @@ public string BodyString { get; }</code></pre>
<a id="Titanium_Web_Proxy_Http_RequestResponseBase_HttpVersion_" data-uid="Titanium.Web.Proxy.Http.RequestResponseBase.HttpVersion*"></a>
<h4 id="Titanium_Web_Proxy_Http_RequestResponseBase_HttpVersion" data-uid="Titanium.Web.Proxy.Http.RequestResponseBase.HttpVersion">HttpVersion</h4>
<div class="markdown level1 summary"><p>Http Version</p>
<div class="markdown level1 summary"><p>Http Version.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -440,7 +441,7 @@ public string BodyString { get; }</code></pre>
<a id="Titanium_Web_Proxy_Http_RequestResponseBase_IsChunked_" data-uid="Titanium.Web.Proxy.Http.RequestResponseBase.IsChunked*"></a>
<h4 id="Titanium_Web_Proxy_Http_RequestResponseBase_IsChunked" data-uid="Titanium.Web.Proxy.Http.RequestResponseBase.IsChunked">IsChunked</h4>
<div class="markdown level1 summary"><p>Is body send as chunked bytes</p>
<div class="markdown level1 summary"><p>Is body send as chunked bytes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -466,7 +467,7 @@ public string BodyString { get; }</code></pre>
<a id="Titanium_Web_Proxy_Http_RequestResponseBase_KeepBody_" data-uid="Titanium.Web.Proxy.Http.RequestResponseBase.KeepBody*"></a>
<h4 id="Titanium_Web_Proxy_Http_RequestResponseBase_KeepBody" data-uid="Titanium.Web.Proxy.Http.RequestResponseBase.KeepBody">KeepBody</h4>
<div class="markdown level1 summary"><p>Keeps the body data after the session is finished</p>
<div class="markdown level1 summary"><p>Keeps the body data after the session is finished.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......
......@@ -83,8 +83,8 @@
<h1 id="Titanium_Web_Proxy_Models_ExplicitProxyEndPoint" data-uid="Titanium.Web.Proxy.Models.ExplicitProxyEndPoint" class="text-break">Class ExplicitProxyEndPoint
</h1>
<div class="markdown level0 summary"><p>A proxy endpoint that the client is aware of
So client application know that it is communicating with a proxy server</p>
<div class="markdown level0 summary"><p>A proxy endpoint that the client is aware of.
So client application know that it is communicating with a proxy server.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
......@@ -161,17 +161,20 @@ So client application know that it is communicating with a proxy server</p>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.net.ipaddress">IPAddress</a></td>
<td><span class="parametername">ipAddress</span></td>
<td></td>
<td><p>Listening IP address.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.int32">Int32</a></td>
<td><span class="parametername">port</span></td>
<td></td>
<td><p>Listening port.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
<td><span class="parametername">decryptSsl</span></td>
<td></td>
<td><p>Should we decrypt ssl?</p>
</td>
</tr>
</tbody>
</table>
......@@ -208,10 +211,10 @@ So client application know that it is communicating with a proxy server</p>
<h4 id="Titanium_Web_Proxy_Models_ExplicitProxyEndPoint_BeforeTunnelConnectRequest" data-uid="Titanium.Web.Proxy.Models.ExplicitProxyEndPoint.BeforeTunnelConnectRequest">BeforeTunnelConnectRequest</h4>
<div class="markdown level1 summary"><p>Intercept tunnel connect request
Valid only for explicit endpoints
<div class="markdown level1 summary"><p>Intercept tunnel connect request.
Valid only for explicit endpoints.
Set the <a class="xref" href="Titanium.Web.Proxy.EventArguments.TunnelConnectSessionEventArgs.html#Titanium_Web_Proxy_EventArguments_TunnelConnectSessionEventArgs_DecryptSsl">DecryptSsl</a> property to false if this HTTP connect request
should&apos;nt be decrypted and instead be relayed</p>
should&apos;nt be decrypted and instead be relayed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -236,8 +239,8 @@ should&apos;nt be decrypted and instead be relayed</p>
<h4 id="Titanium_Web_Proxy_Models_ExplicitProxyEndPoint_BeforeTunnelConnectResponse" data-uid="Titanium.Web.Proxy.Models.ExplicitProxyEndPoint.BeforeTunnelConnectResponse">BeforeTunnelConnectResponse</h4>
<div class="markdown level1 summary"><p>Intercept tunnel connect response
Valid only for explicit endpoints</p>
<div class="markdown level1 summary"><p>Intercept tunnel connect response.
Valid only for explicit endpoints.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......
......@@ -83,7 +83,7 @@
<h1 id="Titanium_Web_Proxy_Models_ExternalProxy" data-uid="Titanium.Web.Proxy.Models.ExternalProxy" class="text-break">Class ExternalProxy
</h1>
<div class="markdown level0 summary"><p>An upstream proxy this proxy uses if any</p>
<div class="markdown level0 summary"><p>An upstream proxy this proxy uses if any.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
......@@ -282,7 +282,8 @@
<a id="Titanium_Web_Proxy_Models_ExternalProxy_ToString_" data-uid="Titanium.Web.Proxy.Models.ExternalProxy.ToString*"></a>
<h4 id="Titanium_Web_Proxy_Models_ExternalProxy_ToString" data-uid="Titanium.Web.Proxy.Models.ExternalProxy.ToString">ToString()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>returns data in Hostname:port format.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
......
......@@ -124,7 +124,7 @@
<a id="Titanium_Web_Proxy_Models_HttpHeader__ctor_" data-uid="Titanium.Web.Proxy.Models.HttpHeader.#ctor*"></a>
<h4 id="Titanium_Web_Proxy_Models_HttpHeader__ctor_System_String_System_String_" data-uid="Titanium.Web.Proxy.Models.HttpHeader.#ctor(System.String,System.String)">HttpHeader(String, String)</h4>
<div class="markdown level1 summary"><p>Constructor.</p>
<div class="markdown level1 summary"><p>Initialize a new instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -144,27 +144,14 @@
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
<td><span class="parametername">name</span></td>
<td></td>
<td><p>Header name.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
<td><span class="parametername">value</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.exception">Exception</a></td>
<td></td>
<td><p>Header value.</p>
</td>
</tr>
</tbody>
</table>
......@@ -228,7 +215,7 @@
<a id="Titanium_Web_Proxy_Models_HttpHeader_ToString_" data-uid="Titanium.Web.Proxy.Models.HttpHeader.ToString*"></a>
<h4 id="Titanium_Web_Proxy_Models_HttpHeader_ToString" data-uid="Titanium.Web.Proxy.Models.HttpHeader.ToString">ToString()</h4>
<div class="markdown level1 summary"><p>Returns header as a valid header string</p>
<div class="markdown level1 summary"><p>Returns header as a valid header string.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......
......@@ -83,8 +83,8 @@
<h1 id="Titanium_Web_Proxy_Models_TransparentProxyEndPoint" data-uid="Titanium.Web.Proxy.Models.TransparentProxyEndPoint" class="text-break">Class TransparentProxyEndPoint
</h1>
<div class="markdown level0 summary"><p>A proxy end point client is not aware of
Usefull when requests are redirected to this proxy end point through port forwarding</p>
<div class="markdown level0 summary"><p>A proxy end point client is not aware of.
Useful when requests are redirected to this proxy end point through port forwarding via router.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
......@@ -141,7 +141,7 @@ Usefull when requests are redirected to this proxy end point through port forwar
<a id="Titanium_Web_Proxy_Models_TransparentProxyEndPoint__ctor_" data-uid="Titanium.Web.Proxy.Models.TransparentProxyEndPoint.#ctor*"></a>
<h4 id="Titanium_Web_Proxy_Models_TransparentProxyEndPoint__ctor_System_Net_IPAddress_System_Int32_System_Boolean_" data-uid="Titanium.Web.Proxy.Models.TransparentProxyEndPoint.#ctor(System.Net.IPAddress,System.Int32,System.Boolean)">TransparentProxyEndPoint(IPAddress, Int32, Boolean)</h4>
<div class="markdown level1 summary"><p>Constructor.</p>
<div class="markdown level1 summary"><p>Initialize a new instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -161,17 +161,20 @@ Usefull when requests are redirected to this proxy end point through port forwar
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.net.ipaddress">IPAddress</a></td>
<td><span class="parametername">ipAddress</span></td>
<td></td>
<td><p>Listening Ip address.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.int32">Int32</a></td>
<td><span class="parametername">port</span></td>
<td></td>
<td><p>Listening port.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
<td><span class="parametername">decryptSsl</span></td>
<td></td>
<td><p>Should we decrypt ssl?</p>
</td>
</tr>
</tbody>
</table>
......@@ -181,8 +184,8 @@ Usefull when requests are redirected to this proxy end point through port forwar
<a id="Titanium_Web_Proxy_Models_TransparentProxyEndPoint_GenericCertificateName_" data-uid="Titanium.Web.Proxy.Models.TransparentProxyEndPoint.GenericCertificateName*"></a>
<h4 id="Titanium_Web_Proxy_Models_TransparentProxyEndPoint_GenericCertificateName" data-uid="Titanium.Web.Proxy.Models.TransparentProxyEndPoint.GenericCertificateName">GenericCertificateName</h4>
<div class="markdown level1 summary"><p>Name of the Certificate need to be sent (same as the hostname we want to proxy)
This is valid only when UseServerNameIndication is set to false</p>
<div class="markdown level1 summary"><p>Name of the Certificate need to be sent (same as the hostname we want to proxy).
This is valid only when UseServerNameIndication is set to false.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......@@ -209,7 +212,7 @@ This is valid only when UseServerNameIndication is set to false</p>
<h4 id="Titanium_Web_Proxy_Models_TransparentProxyEndPoint_BeforeSslAuthenticate" data-uid="Titanium.Web.Proxy.Models.TransparentProxyEndPoint.BeforeSslAuthenticate">BeforeSslAuthenticate</h4>
<div class="markdown level1 summary"><p>Before Ssl authentication</p>
<div class="markdown level1 summary"><p>Before Ssl authentication this event is fired.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
......
......@@ -88,11 +88,11 @@
<h3 id="classes">Classes
</h3>
<h4><a class="xref" href="Titanium.Web.Proxy.Models.ExplicitProxyEndPoint.html">ExplicitProxyEndPoint</a></h4>
<section><p>A proxy endpoint that the client is aware of
So client application know that it is communicating with a proxy server</p>
<section><p>A proxy endpoint that the client is aware of.
So client application know that it is communicating with a proxy server.</p>
</section>
<h4><a class="xref" href="Titanium.Web.Proxy.Models.ExternalProxy.html">ExternalProxy</a></h4>
<section><p>An upstream proxy this proxy uses if any</p>
<section><p>An upstream proxy this proxy uses if any.</p>
</section>
<h4><a class="xref" href="Titanium.Web.Proxy.Models.HttpHeader.html">HttpHeader</a></h4>
<section><p>Http Header object used by proxy</p>
......@@ -101,8 +101,8 @@ So client application know that it is communicating with a proxy server</p>
<section><p>An abstract endpoint where the proxy listens</p>
</section>
<h4><a class="xref" href="Titanium.Web.Proxy.Models.TransparentProxyEndPoint.html">TransparentProxyEndPoint</a></h4>
<section><p>A proxy end point client is not aware of
Usefull when requests are redirected to this proxy end point through port forwarding</p>
<section><p>A proxy end point client is not aware of.
Useful when requests are redirected to this proxy end point through port forwarding via router.</p>
</section>
</article>
</div>
......
......@@ -83,7 +83,7 @@
<h1 id="Titanium_Web_Proxy_Network_CertificateEngine" data-uid="Titanium.Web.Proxy.Network.CertificateEngine" class="text-break">Enum CertificateEngine
</h1>
<div class="markdown level0 summary"><p>Certificate Engine option</p>
<div class="markdown level0 summary"><p>Certificate Engine option.</p>
</div>
<div class="markdown level0 conceptual"></div>
<h6><strong>Namespace</strong>: <a class="xref" href="Titanium.Web.Proxy.Network.html">Titanium.Web.Proxy.Network</a></h6>
......@@ -104,12 +104,12 @@
<tbody>
<tr>
<td id="Titanium_Web_Proxy_Network_CertificateEngine_BouncyCastle">BouncyCastle</td>
<td><p>Uses BouncyCastle 3rd party library</p>
<td><p>Uses BouncyCastle 3rd party library.</p>
</td>
</tr>
<tr>
<td id="Titanium_Web_Proxy_Network_CertificateEngine_DefaultWindows">DefaultWindows</td>
<td><p>Uses Windows Certification Generation API</p>
<td><p>Uses Windows Certification Generation API.</p>
</td>
</tr>
</tbody>
......
......@@ -88,12 +88,12 @@
<h3 id="classes">Classes
</h3>
<h4><a class="xref" href="Titanium.Web.Proxy.Network.CertificateManager.html">CertificateManager</a></h4>
<section><p>A class to manage SSL certificates used by this proxy server</p>
<section><p>A class to manage SSL certificates used by this proxy server.</p>
</section>
<h3 id="enums">Enums
</h3>
<h4><a class="xref" href="Titanium.Web.Proxy.Network.CertificateEngine.html">CertificateEngine</a></h4>
<section><p>Certificate Engine option</p>
<section><p>Certificate Engine option.</p>
</section>
</article>
</div>
......
......@@ -74,21 +74,6 @@
<a href="Titanium.Web.Proxy.Exceptions.ProxyHttpException.html" name="" title="ProxyHttpException">ProxyHttpException</a>
</li>
</ul> </li>
<li>
<span class="expand-stub"></span>
<a href="Titanium.Web.Proxy.Extensions.html" name="" title="Titanium.Web.Proxy.Extensions">Titanium.Web.Proxy.Extensions</a>
<ul class="nav level2">
<li>
<a href="Titanium.Web.Proxy.Extensions.SslApplicationProtocol.html" name="" title="SslApplicationProtocol">SslApplicationProtocol</a>
</li>
<li>
<a href="Titanium.Web.Proxy.Extensions.SslClientAuthenticationOptions.html" name="" title="SslClientAuthenticationOptions">SslClientAuthenticationOptions</a>
</li>
<li>
<a href="Titanium.Web.Proxy.Extensions.SslServerAuthenticationOptions.html" name="" title="SslServerAuthenticationOptions">SslServerAuthenticationOptions</a>
</li>
</ul> </li>
<li>
<span class="expand-stub"></span>
<a href="Titanium.Web.Proxy.Helpers.html" name="" title="Titanium.Web.Proxy.Helpers">Titanium.Web.Proxy.Helpers</a>
......
This source diff could not be displayed because it is too large. You can view the blob instead.
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment