You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
75 lines
2.9 KiB
XML
75 lines
2.9 KiB
XML
<Type Name="CloseEventArgs" FullName="WebSocketSharp.CloseEventArgs">
|
|
<TypeSignature Language="C#" Value="public class CloseEventArgs : WebSocketSharp.MessageEventArgs" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CloseEventArgs extends WebSocketSharp.MessageEventArgs" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>websocket-sharp</AssemblyName>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>WebSocketSharp.MessageEventArgs</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Docs>
|
|
<summary>
|
|
Contains the event data associated with a <see cref="E:WebSocketSharp.WebSocket.OnClose" /> event.
|
|
</summary>
|
|
<remarks>
|
|
The <see cref="E:WebSocketSharp.WebSocket.OnClose" /> event occurs when the WebSocket receives a close control frame or
|
|
the <c>WebSocket.Close</c> method is called. If you want to get the reason for closure, you should access
|
|
the <see cref="P:WebSocketSharp.CloseEventArgs.Code" /> or <see cref="P:WebSocketSharp.CloseEventArgs.Reason" /> properties.
|
|
</remarks>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName="Code">
|
|
<MemberSignature Language="C#" Value="public ushort Code { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance unsigned int16 Code" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.UInt16</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets the status code for closure.
|
|
</summary>
|
|
<value>
|
|
A <see cref="T:System.UInt16" /> that contains a status code for closure.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Reason">
|
|
<MemberSignature Language="C#" Value="public string Reason { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance string Reason" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets the reason for closure.
|
|
</summary>
|
|
<value>
|
|
A <see cref="T:System.String" /> that contains a reason for closure.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="WasClean">
|
|
<MemberSignature Language="C#" Value="public bool WasClean { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool WasClean" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Indicates whether the WebSocket connection closed cleanly.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the WebSocket connection closed cleanly; otherwise, <c>false</c>.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type>
|