Commit 69470b81 authored by buildbot121's avatar buildbot121

API documentation update by build server

parent ebd9baca
...@@ -492,7 +492,7 @@ within a proxy connection.</p> ...@@ -492,7 +492,7 @@ within a proxy connection.</p>
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.eventhandler-1">EventHandler</a>&lt;<a class="xref" href="Titanium.Web.Proxy.EventArguments.DataEventArgs.html">DataEventArgs</a>&gt;</td> <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.eventhandler-1">EventHandler</a>&lt;<span class="xref">StreamExtended.Network.DataEventArgs</span>&gt;</td>
<td></td> <td></td>
</tr> </tr>
</tbody> </tbody>
...@@ -517,7 +517,7 @@ within a proxy connection.</p> ...@@ -517,7 +517,7 @@ within a proxy connection.</p>
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.eventhandler-1">EventHandler</a>&lt;<a class="xref" href="Titanium.Web.Proxy.EventArguments.DataEventArgs.html">DataEventArgs</a>&gt;</td> <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.eventhandler-1">EventHandler</a>&lt;<span class="xref">StreamExtended.Network.DataEventArgs</span>&gt;</td>
<td></td> <td></td>
</tr> </tr>
</tbody> </tbody>
......
...@@ -96,9 +96,6 @@ ...@@ -96,9 +96,6 @@
<h4><a class="xref" href="Titanium.Web.Proxy.EventArguments.CertificateValidationEventArgs.html">CertificateValidationEventArgs</a></h4> <h4><a class="xref" href="Titanium.Web.Proxy.EventArguments.CertificateValidationEventArgs.html">CertificateValidationEventArgs</a></h4>
<section><p>An argument passed on to the user for validating the server certificate <section><p>An argument passed on to the user for validating the server certificate
during SSL authentication.</p> during SSL authentication.</p>
</section>
<h4><a class="xref" href="Titanium.Web.Proxy.EventArguments.DataEventArgs.html">DataEventArgs</a></h4>
<section><p>Wraps the data sent/received by a proxy server instance.</p>
</section> </section>
<h4><a class="xref" href="Titanium.Web.Proxy.EventArguments.MultipartRequestPartSentEventArgs.html">MultipartRequestPartSentEventArgs</a></h4> <h4><a class="xref" href="Titanium.Web.Proxy.EventArguments.MultipartRequestPartSentEventArgs.html">MultipartRequestPartSentEventArgs</a></h4>
<section><p>Class that wraps the multipart sent request arguments.</p> <section><p>Class that wraps the multipart sent request arguments.</p>
......
...@@ -40,9 +40,6 @@ ...@@ -40,9 +40,6 @@
<li> <li>
<a href="Titanium.Web.Proxy.EventArguments.CertificateValidationEventArgs.html" name="" title="CertificateValidationEventArgs">CertificateValidationEventArgs</a> <a href="Titanium.Web.Proxy.EventArguments.CertificateValidationEventArgs.html" name="" title="CertificateValidationEventArgs">CertificateValidationEventArgs</a>
</li> </li>
<li>
<a href="Titanium.Web.Proxy.EventArguments.DataEventArgs.html" name="" title="DataEventArgs">DataEventArgs</a>
</li>
<li> <li>
<a href="Titanium.Web.Proxy.EventArguments.MultipartRequestPartSentEventArgs.html" name="" title="MultipartRequestPartSentEventArgs">MultipartRequestPartSentEventArgs</a> <a href="Titanium.Web.Proxy.EventArguments.MultipartRequestPartSentEventArgs.html" name="" title="MultipartRequestPartSentEventArgs">MultipartRequestPartSentEventArgs</a>
</li> </li>
......
...@@ -19,15 +19,10 @@ ...@@ -19,15 +19,10 @@
"title": "Class CertificateValidationEventArgs | Titanium Web Proxy", "title": "Class CertificateValidationEventArgs | Titanium Web Proxy",
"keywords": "Class CertificateValidationEventArgs An argument passed on to the user for validating the server certificate during SSL authentication. Inheritance Object EventArgs CertificateValidationEventArgs Inherited Members EventArgs.Empty Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : Titanium.Web.Proxy.EventArguments Assembly : Titanium.Web.Proxy.dll Syntax public class CertificateValidationEventArgs : EventArgs Properties Certificate Server certificate. Declaration public X509Certificate Certificate { get; } Property Value Type Description X509Certificate Chain Certificate chain. Declaration public X509Chain Chain { get; } Property Value Type Description X509Chain IsValid Is the given server certificate valid? Declaration public bool IsValid { get; set; } Property Value Type Description Boolean SslPolicyErrors SSL policy errors. Declaration public SslPolicyErrors SslPolicyErrors { get; } Property Value Type Description SslPolicyErrors" "keywords": "Class CertificateValidationEventArgs An argument passed on to the user for validating the server certificate during SSL authentication. Inheritance Object EventArgs CertificateValidationEventArgs Inherited Members EventArgs.Empty Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : Titanium.Web.Proxy.EventArguments Assembly : Titanium.Web.Proxy.dll Syntax public class CertificateValidationEventArgs : EventArgs Properties Certificate Server certificate. Declaration public X509Certificate Certificate { get; } Property Value Type Description X509Certificate Chain Certificate chain. Declaration public X509Chain Chain { get; } Property Value Type Description X509Chain IsValid Is the given server certificate valid? Declaration public bool IsValid { get; set; } Property Value Type Description Boolean SslPolicyErrors SSL policy errors. Declaration public SslPolicyErrors SslPolicyErrors { get; } Property Value Type Description SslPolicyErrors"
}, },
"api/Titanium.Web.Proxy.EventArguments.DataEventArgs.html": {
"href": "api/Titanium.Web.Proxy.EventArguments.DataEventArgs.html",
"title": "Class DataEventArgs | Titanium Web Proxy",
"keywords": "Class DataEventArgs Wraps the data sent/received by a proxy server instance. Inheritance Object EventArgs DataEventArgs Inherited Members EventArgs.Empty Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : Titanium.Web.Proxy.EventArguments Assembly : Titanium.Web.Proxy.dll Syntax public class DataEventArgs : EventArgs Properties Buffer The buffer with data. Declaration public byte[] Buffer { get; } Property Value Type Description System.Byte [] Count Length from offset in buffer with valid data. Declaration public int Count { get; } Property Value Type Description Int32 Offset Offset in buffer from which valid data begins. Declaration public int Offset { get; } Property Value Type Description Int32"
},
"api/Titanium.Web.Proxy.EventArguments.html": { "api/Titanium.Web.Proxy.EventArguments.html": {
"href": "api/Titanium.Web.Proxy.EventArguments.html", "href": "api/Titanium.Web.Proxy.EventArguments.html",
"title": "Namespace Titanium.Web.Proxy.EventArguments | Titanium Web Proxy", "title": "Namespace Titanium.Web.Proxy.EventArguments | Titanium Web Proxy",
"keywords": "Namespace Titanium.Web.Proxy.EventArguments Classes BeforeSslAuthenticateEventArgs This is used in transparent endpoint before authenticating client. CertificateSelectionEventArgs An argument passed on to user for client certificate selection during mutual SSL authentication. CertificateValidationEventArgs An argument passed on to the user for validating the server certificate during SSL authentication. DataEventArgs Wraps the data sent/received by a proxy server instance. MultipartRequestPartSentEventArgs Class that wraps the multipart sent request arguments. SessionEventArgs 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. SessionEventArgsBase 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. TunnelConnectSessionEventArgs A class that wraps the state when a tunnel connect event happen for Explicit endpoints. Delegates AsyncEventHandler<TEventArgs> A generic asynchronous event handler used by the proxy." "keywords": "Namespace Titanium.Web.Proxy.EventArguments Classes BeforeSslAuthenticateEventArgs This is used in transparent endpoint before authenticating client. CertificateSelectionEventArgs An argument passed on to user for client certificate selection during mutual SSL authentication. CertificateValidationEventArgs An argument passed on to the user for validating the server certificate during SSL authentication. MultipartRequestPartSentEventArgs Class that wraps the multipart sent request arguments. SessionEventArgs 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. SessionEventArgsBase 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. TunnelConnectSessionEventArgs A class that wraps the state when a tunnel connect event happen for Explicit endpoints. Delegates AsyncEventHandler<TEventArgs> A generic asynchronous event handler used by the proxy."
}, },
"api/Titanium.Web.Proxy.EventArguments.MultipartRequestPartSentEventArgs.html": { "api/Titanium.Web.Proxy.EventArguments.MultipartRequestPartSentEventArgs.html": {
"href": "api/Titanium.Web.Proxy.EventArguments.MultipartRequestPartSentEventArgs.html", "href": "api/Titanium.Web.Proxy.EventArguments.MultipartRequestPartSentEventArgs.html",
...@@ -42,7 +37,7 @@ ...@@ -42,7 +37,7 @@
"api/Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.html": { "api/Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.html": {
"href": "api/Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.html", "href": "api/Titanium.Web.Proxy.EventArguments.SessionEventArgsBase.html",
"title": "Class SessionEventArgsBase | Titanium Web Proxy", "title": "Class SessionEventArgsBase | Titanium Web Proxy",
"keywords": "Class SessionEventArgsBase 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. Inheritance Object EventArgs SessionEventArgsBase SessionEventArgs TunnelConnectSessionEventArgs Implements IDisposable Inherited Members EventArgs.Empty Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : Titanium.Web.Proxy.EventArguments Assembly : Titanium.Web.Proxy.dll Syntax public abstract class SessionEventArgsBase : EventArgs, IDisposable Constructors SessionEventArgsBase(Int32, ProxyEndPoint, CancellationTokenSource, Request, ExceptionHandler) Declaration protected SessionEventArgsBase(int bufferSize, ProxyEndPoint endPoint, CancellationTokenSource cancellationTokenSource, Request request, ExceptionHandler exceptionFunc) Parameters Type Name Description Int32 bufferSize ProxyEndPoint endPoint CancellationTokenSource cancellationTokenSource Request request ExceptionHandler exceptionFunc Fields BufferSize Size of Buffers used by this object Declaration protected readonly int BufferSize Field Value Type Description Int32 ExceptionFunc Declaration protected readonly ExceptionHandler ExceptionFunc Field Value Type Description ExceptionHandler Properties ClientEndPoint Client End Point. Declaration public IPEndPoint ClientEndPoint { get; } Property Value Type Description IPEndPoint CustomUpStreamProxyUsed Are we using a custom upstream HTTP(S) proxy? Declaration public ExternalProxy CustomUpStreamProxyUsed { get; } Property Value Type Description ExternalProxy Exception The last exception that happened. Declaration public Exception Exception { get; } Property Value Type Description Exception Id Returns a unique Id for this request/response session which is same as the RequestId of WebSession. Declaration public Guid Id { get; } Property Value Type Description Guid IsHttps Does this session uses SSL? Declaration public bool IsHttps { get; } Property Value Type Description Boolean IsTransparent Is this a transparent endpoint? Declaration public bool IsTransparent { get; } Property Value Type Description Boolean LocalEndPoint Local endpoint via which we make the request. Declaration public ProxyEndPoint LocalEndPoint { get; } Property Value Type Description ProxyEndPoint WebSession A web session corresponding to a single request/response sequence within a proxy connection. Declaration public HttpWebClient WebSession { get; } Property Value Type Description HttpWebClient Methods Dispose() Implements cleanup here. Declaration public virtual void Dispose() TerminateSession() Terminates the session abruptly by terminating client/server connections. Declaration public void TerminateSession() Events DataReceived Fired when data is received within this session from client/server. Declaration public event EventHandler<DataEventArgs> DataReceived Event Type Type Description EventHandler < DataEventArgs > DataSent Fired when data is sent within this session to server/client. Declaration public event EventHandler<DataEventArgs> DataSent Event Type Type Description EventHandler < DataEventArgs > Implements System.IDisposable" "keywords": "Class SessionEventArgsBase 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. Inheritance Object EventArgs SessionEventArgsBase SessionEventArgs TunnelConnectSessionEventArgs Implements IDisposable Inherited Members EventArgs.Empty Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : Titanium.Web.Proxy.EventArguments Assembly : Titanium.Web.Proxy.dll Syntax public abstract class SessionEventArgsBase : EventArgs, IDisposable Constructors SessionEventArgsBase(Int32, ProxyEndPoint, CancellationTokenSource, Request, ExceptionHandler) Declaration protected SessionEventArgsBase(int bufferSize, ProxyEndPoint endPoint, CancellationTokenSource cancellationTokenSource, Request request, ExceptionHandler exceptionFunc) Parameters Type Name Description Int32 bufferSize ProxyEndPoint endPoint CancellationTokenSource cancellationTokenSource Request request ExceptionHandler exceptionFunc Fields BufferSize Size of Buffers used by this object Declaration protected readonly int BufferSize Field Value Type Description Int32 ExceptionFunc Declaration protected readonly ExceptionHandler ExceptionFunc Field Value Type Description ExceptionHandler Properties ClientEndPoint Client End Point. Declaration public IPEndPoint ClientEndPoint { get; } Property Value Type Description IPEndPoint CustomUpStreamProxyUsed Are we using a custom upstream HTTP(S) proxy? Declaration public ExternalProxy CustomUpStreamProxyUsed { get; } Property Value Type Description ExternalProxy Exception The last exception that happened. Declaration public Exception Exception { get; } Property Value Type Description Exception Id Returns a unique Id for this request/response session which is same as the RequestId of WebSession. Declaration public Guid Id { get; } Property Value Type Description Guid IsHttps Does this session uses SSL? Declaration public bool IsHttps { get; } Property Value Type Description Boolean IsTransparent Is this a transparent endpoint? Declaration public bool IsTransparent { get; } Property Value Type Description Boolean LocalEndPoint Local endpoint via which we make the request. Declaration public ProxyEndPoint LocalEndPoint { get; } Property Value Type Description ProxyEndPoint WebSession A web session corresponding to a single request/response sequence within a proxy connection. Declaration public HttpWebClient WebSession { get; } Property Value Type Description HttpWebClient Methods Dispose() Implements cleanup here. Declaration public virtual void Dispose() TerminateSession() Terminates the session abruptly by terminating client/server connections. Declaration public void TerminateSession() Events DataReceived Fired when data is received within this session from client/server. Declaration public event EventHandler<DataEventArgs> DataReceived Event Type Type Description EventHandler < StreamExtended.Network.DataEventArgs > DataSent Fired when data is sent within this session to server/client. Declaration public event EventHandler<DataEventArgs> DataSent Event Type Type Description EventHandler < StreamExtended.Network.DataEventArgs > Implements System.IDisposable"
}, },
"api/Titanium.Web.Proxy.EventArguments.TunnelConnectSessionEventArgs.html": { "api/Titanium.Web.Proxy.EventArguments.TunnelConnectSessionEventArgs.html": {
"href": "api/Titanium.Web.Proxy.EventArguments.TunnelConnectSessionEventArgs.html", "href": "api/Titanium.Web.Proxy.EventArguments.TunnelConnectSessionEventArgs.html",
......
...@@ -209,51 +209,6 @@ references: ...@@ -209,51 +209,6 @@ references:
isSpec: "True" isSpec: "True"
fullName: Titanium.Web.Proxy.EventArguments.CertificateValidationEventArgs.SslPolicyErrors fullName: Titanium.Web.Proxy.EventArguments.CertificateValidationEventArgs.SslPolicyErrors
nameWithType: CertificateValidationEventArgs.SslPolicyErrors nameWithType: CertificateValidationEventArgs.SslPolicyErrors
- uid: Titanium.Web.Proxy.EventArguments.DataEventArgs
name: DataEventArgs
href: api/Titanium.Web.Proxy.EventArguments.DataEventArgs.html
commentId: T:Titanium.Web.Proxy.EventArguments.DataEventArgs
fullName: Titanium.Web.Proxy.EventArguments.DataEventArgs
nameWithType: DataEventArgs
- uid: Titanium.Web.Proxy.EventArguments.DataEventArgs.Buffer
name: Buffer
href: api/Titanium.Web.Proxy.EventArguments.DataEventArgs.html#Titanium_Web_Proxy_EventArguments_DataEventArgs_Buffer
commentId: P:Titanium.Web.Proxy.EventArguments.DataEventArgs.Buffer
fullName: Titanium.Web.Proxy.EventArguments.DataEventArgs.Buffer
nameWithType: DataEventArgs.Buffer
- uid: Titanium.Web.Proxy.EventArguments.DataEventArgs.Buffer*
name: Buffer
href: api/Titanium.Web.Proxy.EventArguments.DataEventArgs.html#Titanium_Web_Proxy_EventArguments_DataEventArgs_Buffer_
commentId: Overload:Titanium.Web.Proxy.EventArguments.DataEventArgs.Buffer
isSpec: "True"
fullName: Titanium.Web.Proxy.EventArguments.DataEventArgs.Buffer
nameWithType: DataEventArgs.Buffer
- uid: Titanium.Web.Proxy.EventArguments.DataEventArgs.Count
name: Count
href: api/Titanium.Web.Proxy.EventArguments.DataEventArgs.html#Titanium_Web_Proxy_EventArguments_DataEventArgs_Count
commentId: P:Titanium.Web.Proxy.EventArguments.DataEventArgs.Count
fullName: Titanium.Web.Proxy.EventArguments.DataEventArgs.Count
nameWithType: DataEventArgs.Count
- uid: Titanium.Web.Proxy.EventArguments.DataEventArgs.Count*
name: Count
href: api/Titanium.Web.Proxy.EventArguments.DataEventArgs.html#Titanium_Web_Proxy_EventArguments_DataEventArgs_Count_
commentId: Overload:Titanium.Web.Proxy.EventArguments.DataEventArgs.Count
isSpec: "True"
fullName: Titanium.Web.Proxy.EventArguments.DataEventArgs.Count
nameWithType: DataEventArgs.Count
- uid: Titanium.Web.Proxy.EventArguments.DataEventArgs.Offset
name: Offset
href: api/Titanium.Web.Proxy.EventArguments.DataEventArgs.html#Titanium_Web_Proxy_EventArguments_DataEventArgs_Offset
commentId: P:Titanium.Web.Proxy.EventArguments.DataEventArgs.Offset
fullName: Titanium.Web.Proxy.EventArguments.DataEventArgs.Offset
nameWithType: DataEventArgs.Offset
- uid: Titanium.Web.Proxy.EventArguments.DataEventArgs.Offset*
name: Offset
href: api/Titanium.Web.Proxy.EventArguments.DataEventArgs.html#Titanium_Web_Proxy_EventArguments_DataEventArgs_Offset_
commentId: Overload:Titanium.Web.Proxy.EventArguments.DataEventArgs.Offset
isSpec: "True"
fullName: Titanium.Web.Proxy.EventArguments.DataEventArgs.Offset
nameWithType: DataEventArgs.Offset
- uid: Titanium.Web.Proxy.EventArguments.MultipartRequestPartSentEventArgs - uid: Titanium.Web.Proxy.EventArguments.MultipartRequestPartSentEventArgs
name: MultipartRequestPartSentEventArgs name: MultipartRequestPartSentEventArgs
href: api/Titanium.Web.Proxy.EventArguments.MultipartRequestPartSentEventArgs.html href: api/Titanium.Web.Proxy.EventArguments.MultipartRequestPartSentEventArgs.html
......
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