UNPKG

react-native-windows-cursor

Version:
1,053 lines 376 kB
<?xml version="1.0"?> <doc> <assembly> <name>websocket-sharp</name> </assembly> <members> <member name="T:WebSocketSharp.Ext"> <summary> Provides a set of static methods for websocket-sharp. </summary> </member> <member name="M:WebSocketSharp.Ext.EqualsWith(System.Int32,System.Char,System.Action{System.Int32})"> <summary> Determines whether the specified <see cref="T:System.Int32"/> equals the specified <see cref="T:System.Char"/>, and invokes the specified <c>Action&lt;int&gt;</c> delegate at the same time. </summary> <returns> <c>true</c> if <paramref name="value"/> equals <paramref name="c"/>; otherwise, <c>false</c>. </returns> <param name="value"> An <see cref="T:System.Int32"/> to compare. </param> <param name="c"> A <see cref="T:System.Char"/> to compare. </param> <param name="action"> An <c>Action&lt;int&gt;</c> delegate that references the method(s) called at the same time as comparing. An <see cref="T:System.Int32"/> parameter to pass to the method(s) is <paramref name="value"/>. </param> </member> <member name="M:WebSocketSharp.Ext.GetAbsolutePath(System.Uri)"> <summary> Gets the absolute path from the specified <see cref="T:System.Uri"/>. </summary> <returns> A <see cref="T:System.String"/> that represents the absolute path if it's successfully found; otherwise, <see langword="null"/>. </returns> <param name="uri"> A <see cref="T:System.Uri"/> that represents the URI to get the absolute path from. </param> </member> <member name="M:WebSocketSharp.Ext.GetName(System.String,System.Char)"> <summary> Gets the name from the specified <see cref="T:System.String"/> that contains a pair of name and value separated by a separator character. </summary> <returns> A <see cref="T:System.String"/> that represents the name if any; otherwise, <c>null</c>. </returns> <param name="nameAndValue"> A <see cref="T:System.String"/> that contains a pair of name and value separated by a separator character. </param> <param name="separator"> A <see cref="T:System.Char"/> that represents the separator character. </param> </member> <member name="M:WebSocketSharp.Ext.GetValue(System.String,System.Char)"> <summary> Gets the value from the specified <see cref="T:System.String"/> that contains a pair of name and value separated by a separator character. </summary> <returns> A <see cref="T:System.String"/> that represents the value if any; otherwise, <c>null</c>. </returns> <param name="nameAndValue"> A <see cref="T:System.String"/> that contains a pair of name and value separated by a separator character. </param> <param name="separator"> A <see cref="T:System.Char"/> that represents the separator character. </param> </member> <member name="M:WebSocketSharp.Ext.TryCreateWebSocketUri(System.String,System.Uri@,System.String@)"> <summary> Tries to create a <see cref="T:System.Uri"/> for WebSocket with the specified <paramref name="uriString"/>. </summary> <returns> <c>true</c> if a <see cref="T:System.Uri"/> is successfully created; otherwise, <c>false</c>. </returns> <param name="uriString"> A <see cref="T:System.String"/> that represents a WebSocket URL to try. </param> <param name="result"> When this method returns, a <see cref="T:System.Uri"/> that represents a WebSocket URL, or <see langword="null"/> if <paramref name="uriString"/> is invalid. </param> <param name="message"> When this method returns, a <see cref="T:System.String"/> that represents an error message, or <see cref="F:System.String.Empty"/> if <paramref name="uriString"/> is valid. </param> </member> <member name="M:WebSocketSharp.Ext.Contains(System.String,System.Char[])"> <summary> Determines whether the specified <see cref="T:System.String"/> contains any of characters in the specified array of <see cref="T:System.Char"/>. </summary> <returns> <c>true</c> if <paramref name="value"/> contains any of <paramref name="chars"/>; otherwise, <c>false</c>. </returns> <param name="value"> A <see cref="T:System.String"/> to test. </param> <param name="chars"> An array of <see cref="T:System.Char"/> that contains characters to find. </param> </member> <member name="M:WebSocketSharp.Ext.Contains(System.Collections.Specialized.NameValueCollection,System.String)"> <summary> Determines whether the specified <see cref="T:System.Collections.Specialized.NameValueCollection"/> contains the entry with the specified <paramref name="name"/>. </summary> <returns> <c>true</c> if <paramref name="collection"/> contains the entry with <paramref name="name"/>; otherwise, <c>false</c>. </returns> <param name="collection"> A <see cref="T:System.Collections.Specialized.NameValueCollection"/> to test. </param> <param name="name"> A <see cref="T:System.String"/> that represents the key of the entry to find. </param> </member> <member name="M:WebSocketSharp.Ext.Contains(System.Collections.Specialized.NameValueCollection,System.String,System.String)"> <summary> Determines whether the specified <see cref="T:System.Collections.Specialized.NameValueCollection"/> contains the entry with the specified both <paramref name="name"/> and <paramref name="value"/>. </summary> <returns> <c>true</c> if <paramref name="collection"/> contains the entry with both <paramref name="name"/> and <paramref name="value"/>; otherwise, <c>false</c>. </returns> <param name="collection"> A <see cref="T:System.Collections.Specialized.NameValueCollection"/> to test. </param> <param name="name"> A <see cref="T:System.String"/> that represents the key of the entry to find. </param> <param name="value"> A <see cref="T:System.String"/> that represents the value of the entry to find. </param> </member> <member name="M:WebSocketSharp.Ext.Emit(System.EventHandler,System.Object,System.EventArgs)"> <summary> Emits the specified <see cref="T:System.EventHandler"/> delegate if it isn't <see langword="null"/>. </summary> <param name="eventHandler"> A <see cref="T:System.EventHandler"/> to emit. </param> <param name="sender"> An <see cref="T:System.Object"/> from which emits this <paramref name="eventHandler"/>. </param> <param name="e"> A <see cref="T:System.EventArgs"/> that contains no event data. </param> </member> <member name="M:WebSocketSharp.Ext.Emit``1(System.EventHandler{``0},System.Object,``0)"> <summary> Emits the specified <c>EventHandler&lt;TEventArgs&gt;</c> delegate if it isn't <see langword="null"/>. </summary> <param name="eventHandler"> An <c>EventHandler&lt;TEventArgs&gt;</c> to emit. </param> <param name="sender"> An <see cref="T:System.Object"/> from which emits this <paramref name="eventHandler"/>. </param> <param name="e"> A <c>TEventArgs</c> that represents the event data. </param> <typeparam name="TEventArgs"> The type of the event data generated by the event. </typeparam> </member> <member name="M:WebSocketSharp.Ext.GetCookies(System.Collections.Specialized.NameValueCollection,System.Boolean)"> <summary> Gets the collection of the HTTP cookies from the specified HTTP <paramref name="headers"/>. </summary> <returns> A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that receives a collection of the HTTP cookies. </returns> <param name="headers"> A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains a collection of the HTTP headers. </param> <param name="response"> <c>true</c> if <paramref name="headers"/> is a collection of the response headers; otherwise, <c>false</c>. </param> </member> <member name="M:WebSocketSharp.Ext.GetDescription(WebSocketSharp.Net.HttpStatusCode)"> <summary> Gets the description of the specified HTTP status <paramref name="code"/>. </summary> <returns> A <see cref="T:System.String"/> that represents the description of the HTTP status code. </returns> <param name="code"> One of <see cref="T:WebSocketSharp.Net.HttpStatusCode"/> enum values, indicates the HTTP status code. </param> </member> <member name="M:WebSocketSharp.Ext.GetStatusDescription(System.Int32)"> <summary> Gets the description of the specified HTTP status <paramref name="code"/>. </summary> <returns> A <see cref="T:System.String"/> that represents the description of the HTTP status code. </returns> <param name="code"> An <see cref="T:System.Int32"/> that represents the HTTP status code. </param> </member> <member name="M:WebSocketSharp.Ext.IsCloseStatusCode(System.UInt16)"> <summary> Determines whether the specified <see cref="T:System.UInt16"/> is in the allowable range of the WebSocket close status code. </summary> <remarks> Not allowable ranges are the following: <list type="bullet"> <item> <term> Numbers in the range 0-999 are not used. </term> </item> <item> <term> Numbers greater than 4999 are out of the reserved close status code ranges. </term> </item> </list> </remarks> <returns> <c>true</c> if <paramref name="value"/> is in the allowable range of the WebSocket close status code; otherwise, <c>false</c>. </returns> <param name="value"> A <see cref="T:System.UInt16"/> to test. </param> </member> <member name="M:WebSocketSharp.Ext.IsEnclosedIn(System.String,System.Char)"> <summary> Determines whether the specified <see cref="T:System.String"/> is enclosed in the specified <see cref="T:System.Char"/>. </summary> <returns> <c>true</c> if <paramref name="value"/> is enclosed in <paramref name="c"/>; otherwise, <c>false</c>. </returns> <param name="value"> A <see cref="T:System.String"/> to test. </param> <param name="c"> A <see cref="T:System.Char"/> that represents the character to find. </param> </member> <member name="M:WebSocketSharp.Ext.IsHostOrder(WebSocketSharp.ByteOrder)"> <summary> Determines whether the specified <see cref="T:WebSocketSharp.ByteOrder"/> is host (this computer architecture) byte order. </summary> <returns> <c>true</c> if <paramref name="order"/> is host byte order; otherwise, <c>false</c>. </returns> <param name="order"> One of the <see cref="T:WebSocketSharp.ByteOrder"/> enum values, to test. </param> </member> <member name="M:WebSocketSharp.Ext.IsLocal(System.Net.IPAddress)"> <summary> Determines whether the specified <see cref="T:System.Net.IPAddress"/> represents a local IP address. </summary> <remarks> This local means NOT REMOTE for the current host. </remarks> <returns> <c>true</c> if <paramref name="address"/> represents a local IP address; otherwise, <c>false</c>. </returns> <param name="address"> A <see cref="T:System.Net.IPAddress"/> to test. </param> </member> <member name="M:WebSocketSharp.Ext.IsNullOrEmpty(System.String)"> <summary> Determines whether the specified <see cref="T:System.String"/> is <see langword="null"/> or empty. </summary> <returns> <c>true</c> if <paramref name="value"/> is <see langword="null"/> or empty; otherwise, <c>false</c>. </returns> <param name="value"> A <see cref="T:System.String"/> to test. </param> </member> <member name="M:WebSocketSharp.Ext.IsPredefinedScheme(System.String)"> <summary> Determines whether the specified <see cref="T:System.String"/> is a predefined scheme. </summary> <returns> <c>true</c> if <paramref name="value"/> is a predefined scheme; otherwise, <c>false</c>. </returns> <param name="value"> A <see cref="T:System.String"/> to test. </param> </member> <member name="M:WebSocketSharp.Ext.IsUpgradeTo(WebSocketSharp.Net.HttpListenerRequest,System.String)"> <summary> Determines whether the specified <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/> is an HTTP Upgrade request to switch to the specified <paramref name="protocol"/>. </summary> <returns> <c>true</c> if <paramref name="request"/> is an HTTP Upgrade request to switch to <paramref name="protocol"/>; otherwise, <c>false</c>. </returns> <param name="request"> A <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/> that represents the HTTP request. </param> <param name="protocol"> A <see cref="T:System.String"/> that represents the protocol name. </param> <exception cref="T:System.ArgumentNullException"> <para> <paramref name="request"/> is <see langword="null"/>. </para> <para> -or- </para> <para> <paramref name="protocol"/> is <see langword="null"/>. </para> </exception> <exception cref="T:System.ArgumentException"> <paramref name="protocol"/> is empty. </exception> </member> <member name="M:WebSocketSharp.Ext.MaybeUri(System.String)"> <summary> Determines whether the specified <see cref="T:System.String"/> is a URI string. </summary> <returns> <c>true</c> if <paramref name="value"/> may be a URI string; otherwise, <c>false</c>. </returns> <param name="value"> A <see cref="T:System.String"/> to test. </param> </member> <member name="M:WebSocketSharp.Ext.SubArray``1(``0[],System.Int32,System.Int32)"> <summary> Retrieves a sub-array from the specified <paramref name="array"/>. A sub-array starts at the specified element position in <paramref name="array"/>. </summary> <returns> An array of T that receives a sub-array, or an empty array of T if any problems with the parameters. </returns> <param name="array"> An array of T from which to retrieve a sub-array. </param> <param name="startIndex"> An <see cref="T:System.Int32"/> that represents the zero-based starting position of a sub-array in <paramref name="array"/>. </param> <param name="length"> An <see cref="T:System.Int32"/> that represents the number of elements to retrieve. </param> <typeparam name="T"> The type of elements in <paramref name="array"/>. </typeparam> </member> <member name="M:WebSocketSharp.Ext.SubArray``1(``0[],System.Int64,System.Int64)"> <summary> Retrieves a sub-array from the specified <paramref name="array"/>. A sub-array starts at the specified element position in <paramref name="array"/>. </summary> <returns> An array of T that receives a sub-array, or an empty array of T if any problems with the parameters. </returns> <param name="array"> An array of T from which to retrieve a sub-array. </param> <param name="startIndex"> A <see cref="T:System.Int64"/> that represents the zero-based starting position of a sub-array in <paramref name="array"/>. </param> <param name="length"> A <see cref="T:System.Int64"/> that represents the number of elements to retrieve. </param> <typeparam name="T"> The type of elements in <paramref name="array"/>. </typeparam> </member> <member name="M:WebSocketSharp.Ext.Times(System.Int32,System.Action)"> <summary> Executes the specified <see cref="T:System.Action"/> delegate <paramref name="n"/> times. </summary> <param name="n"> An <see cref="T:System.Int32"/> is the number of times to execute. </param> <param name="action"> An <see cref="T:System.Action"/> delegate that references the method(s) to execute. </param> </member> <member name="M:WebSocketSharp.Ext.Times(System.Int64,System.Action)"> <summary> Executes the specified <see cref="T:System.Action"/> delegate <paramref name="n"/> times. </summary> <param name="n"> A <see cref="T:System.Int64"/> is the number of times to execute. </param> <param name="action"> An <see cref="T:System.Action"/> delegate that references the method(s) to execute. </param> </member> <member name="M:WebSocketSharp.Ext.Times(System.UInt32,System.Action)"> <summary> Executes the specified <see cref="T:System.Action"/> delegate <paramref name="n"/> times. </summary> <param name="n"> A <see cref="T:System.UInt32"/> is the number of times to execute. </param> <param name="action"> An <see cref="T:System.Action"/> delegate that references the method(s) to execute. </param> </member> <member name="M:WebSocketSharp.Ext.Times(System.UInt64,System.Action)"> <summary> Executes the specified <see cref="T:System.Action"/> delegate <paramref name="n"/> times. </summary> <param name="n"> A <see cref="T:System.UInt64"/> is the number of times to execute. </param> <param name="action"> An <see cref="T:System.Action"/> delegate that references the method(s) to execute. </param> </member> <member name="M:WebSocketSharp.Ext.Times(System.Int32,System.Action{System.Int32})"> <summary> Executes the specified <c>Action&lt;int&gt;</c> delegate <paramref name="n"/> times. </summary> <param name="n"> An <see cref="T:System.Int32"/> is the number of times to execute. </param> <param name="action"> An <c>Action&lt;int&gt;</c> delegate that references the method(s) to execute. An <see cref="T:System.Int32"/> parameter to pass to the method(s) is the zero-based count of iteration. </param> </member> <member name="M:WebSocketSharp.Ext.Times(System.Int64,System.Action{System.Int64})"> <summary> Executes the specified <c>Action&lt;long&gt;</c> delegate <paramref name="n"/> times. </summary> <param name="n"> A <see cref="T:System.Int64"/> is the number of times to execute. </param> <param name="action"> An <c>Action&lt;long&gt;</c> delegate that references the method(s) to execute. A <see cref="T:System.Int64"/> parameter to pass to the method(s) is the zero-based count of iteration. </param> </member> <member name="M:WebSocketSharp.Ext.Times(System.UInt32,System.Action{System.UInt32})"> <summary> Executes the specified <c>Action&lt;uint&gt;</c> delegate <paramref name="n"/> times. </summary> <param name="n"> A <see cref="T:System.UInt32"/> is the number of times to execute. </param> <param name="action"> An <c>Action&lt;uint&gt;</c> delegate that references the method(s) to execute. A <see cref="T:System.UInt32"/> parameter to pass to the method(s) is the zero-based count of iteration. </param> </member> <member name="M:WebSocketSharp.Ext.Times(System.UInt64,System.Action{System.UInt64})"> <summary> Executes the specified <c>Action&lt;ulong&gt;</c> delegate <paramref name="n"/> times. </summary> <param name="n"> A <see cref="T:System.UInt64"/> is the number of times to execute. </param> <param name="action"> An <c>Action&lt;ulong&gt;</c> delegate that references the method(s) to execute. A <see cref="T:System.UInt64"/> parameter to pass to this method(s) is the zero-based count of iteration. </param> </member> <member name="M:WebSocketSharp.Ext.To``1(System.Byte[],WebSocketSharp.ByteOrder)"> <summary> Converts the specified array of <see cref="T:System.Byte"/> to the specified type data. </summary> <returns> A T converted from <paramref name="source"/>, or a default value of T if <paramref name="source"/> is an empty array of <see cref="T:System.Byte"/> or if the type of T isn't <see cref="T:System.Boolean"/>, <see cref="T:System.Char"/>, <see cref="T:System.Double"/>, <see cref="T:System.Single"/>, <see cref="T:System.Int32"/>, <see cref="T:System.Int64"/>, <see cref="T:System.Int16"/>, <see cref="T:System.UInt32"/>, <see cref="T:System.UInt64"/>, or <see cref="T:System.UInt16"/>. </returns> <param name="source"> An array of <see cref="T:System.Byte"/> to convert. </param> <param name="sourceOrder"> One of the <see cref="T:WebSocketSharp.ByteOrder"/> enum values, specifies the byte order of <paramref name="source"/>. </param> <typeparam name="T"> The type of the return. The T must be a value type. </typeparam> <exception cref="T:System.ArgumentNullException"> <paramref name="source"/> is <see langword="null"/>. </exception> </member> <member name="M:WebSocketSharp.Ext.ToByteArray``1(``0,WebSocketSharp.ByteOrder)"> <summary> Converts the specified <paramref name="value"/> to an array of <see cref="T:System.Byte"/>. </summary> <returns> An array of <see cref="T:System.Byte"/> converted from <paramref name="value"/>. </returns> <param name="value"> A T to convert. </param> <param name="order"> One of the <see cref="T:WebSocketSharp.ByteOrder"/> enum values, specifies the byte order of the return. </param> <typeparam name="T"> The type of <paramref name="value"/>. The T must be a value type. </typeparam> </member> <member name="M:WebSocketSharp.Ext.ToHostOrder(System.Byte[],WebSocketSharp.ByteOrder)"> <summary> Converts the order of the specified array of <see cref="T:System.Byte"/> to the host byte order. </summary> <returns> An array of <see cref="T:System.Byte"/> converted from <paramref name="source"/>. </returns> <param name="source"> An array of <see cref="T:System.Byte"/> to convert. </param> <param name="sourceOrder"> One of the <see cref="T:WebSocketSharp.ByteOrder"/> enum values, specifies the byte order of <paramref name="source"/>. </param> <exception cref="T:System.ArgumentNullException"> <paramref name="source"/> is <see langword="null"/>. </exception> </member> <member name="M:WebSocketSharp.Ext.ToString``1(``0[],System.String)"> <summary> Converts the specified <paramref name="array"/> to a <see cref="T:System.String"/> that concatenates the each element of <paramref name="array"/> across the specified <paramref name="separator"/>. </summary> <returns> A <see cref="T:System.String"/> converted from <paramref name="array"/>, or <see cref="F:System.String.Empty"/> if <paramref name="array"/> is empty. </returns> <param name="array"> An array of T to convert. </param> <param name="separator"> A <see cref="T:System.String"/> that represents the separator string. </param> <typeparam name="T"> The type of elements in <paramref name="array"/>. </typeparam> <exception cref="T:System.ArgumentNullException"> <paramref name="array"/> is <see langword="null"/>. </exception> </member> <member name="M:WebSocketSharp.Ext.ToUri(System.String)"> <summary> Converts the specified <see cref="T:System.String"/> to a <see cref="T:System.Uri"/>. </summary> <returns> A <see cref="T:System.Uri"/> converted from <paramref name="uriString"/>, or <see langword="null"/> if <paramref name="uriString"/> isn't successfully converted. </returns> <param name="uriString"> A <see cref="T:System.String"/> to convert. </param> </member> <member name="M:WebSocketSharp.Ext.UrlDecode(System.String)"> <summary> URL-decodes the specified <see cref="T:System.String"/>. </summary> <returns> A <see cref="T:System.String"/> that receives the decoded string, or the <paramref name="value"/> if it's <see langword="null"/> or empty. </returns> <param name="value"> A <see cref="T:System.String"/> to decode. </param> </member> <member name="M:WebSocketSharp.Ext.UrlEncode(System.String)"> <summary> URL-encodes the specified <see cref="T:System.String"/>. </summary> <returns> A <see cref="T:System.String"/> that receives the encoded string, or <paramref name="value"/> if it's <see langword="null"/> or empty. </returns> <param name="value"> A <see cref="T:System.String"/> to encode. </param> </member> <member name="M:WebSocketSharp.Ext.WriteContent(WebSocketSharp.Net.HttpListenerResponse,System.Byte[])"> <summary> Writes and sends the specified <paramref name="content"/> data with the specified <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/>. </summary> <param name="response"> A <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> that represents the HTTP response used to send the content data. </param> <param name="content"> An array of <see cref="T:System.Byte"/> that represents the content data to send. </param> <exception cref="T:System.ArgumentNullException"> <para> <paramref name="response"/> is <see langword="null"/>. </para> <para> -or- </para> <para> <paramref name="content"/> is <see langword="null"/>. </para> </exception> </member> <member name="T:WebSocketSharp.MessageEventArgs"> <summary> Represents the event data for the <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event. </summary> <remarks> <para> A <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event occurs when the <see cref="T:WebSocketSharp.WebSocket"/> receives a text or binary message, or a ping if the <see cref="P:WebSocketSharp.WebSocket.EmitOnPing"/> property is set to <c>true</c>. </para> <para> If you would like to get the message data, you should access the <see cref="P:WebSocketSharp.MessageEventArgs.Data"/> or <see cref="P:WebSocketSharp.MessageEventArgs.RawData"/> property. </para> </remarks> </member> <member name="P:WebSocketSharp.MessageEventArgs.Data"> <summary> Gets the message data as a <see cref="T:System.String"/>. </summary> <value> A <see cref="T:System.String"/> that represents the message data, or <see langword="null"/> if the message data cannot be decoded to a string. </value> </member> <member name="P:WebSocketSharp.MessageEventArgs.IsBinary"> <summary> Gets a value indicating whether the message type is binary. </summary> <value> <c>true</c> if the message type is binary; otherwise, <c>false</c>. </value> </member> <member name="P:WebSocketSharp.MessageEventArgs.IsPing"> <summary> Gets a value indicating whether the message type is ping. </summary> <value> <c>true</c> if the message type is ping; otherwise, <c>false</c>. </value> </member> <member name="P:WebSocketSharp.MessageEventArgs.IsText"> <summary> Gets a value indicating whether the message type is text. </summary> <value> <c>true</c> if the message type is text; otherwise, <c>false</c>. </value> </member> <member name="P:WebSocketSharp.MessageEventArgs.RawData"> <summary> Gets the message data as an array of <see cref="T:System.Byte"/>. </summary> <value> An array of <see cref="T:System.Byte"/> that represents the message data. </value> </member> <member name="P:WebSocketSharp.MessageEventArgs.Type"> <summary> Gets the message type. </summary> <value> <see cref="F:WebSocketSharp.Opcode.Text"/>, <see cref="F:WebSocketSharp.Opcode.Binary"/>, or <see cref="F:WebSocketSharp.Opcode.Ping"/>. </value> </member> <member name="T:WebSocketSharp.CloseEventArgs"> <summary> Represents the event data for the <see cref="E:WebSocketSharp.WebSocket.OnClose"/> event. </summary> <remarks> <para> A <see cref="E:WebSocketSharp.WebSocket.OnClose"/> event occurs when the WebSocket connection has been closed. </para> <para> If you would like to get the reason for the close, you should access the <see cref="P:WebSocketSharp.CloseEventArgs.Code"/> or <see cref="P:WebSocketSharp.CloseEventArgs.Reason"/> property. </para> </remarks> </member> <member name="P:WebSocketSharp.CloseEventArgs.Code"> <summary> Gets the status code for the close. </summary> <value> A <see cref="T:System.UInt16"/> that represents the status code for the close if any. </value> </member> <member name="P:WebSocketSharp.CloseEventArgs.Reason"> <summary> Gets the reason for the close. </summary> <value> A <see cref="T:System.String"/> that represents the reason for the close if any. </value> </member> <member name="P:WebSocketSharp.CloseEventArgs.WasClean"> <summary> Gets a value indicating whether the connection has been closed cleanly. </summary> <value> <c>true</c> if the connection has been closed cleanly; otherwise, <c>false</c>. </value> </member> <member name="T:WebSocketSharp.ByteOrder"> <summary> Specifies the byte order. </summary> </member> <member name="F:WebSocketSharp.ByteOrder.Little"> <summary> Specifies Little-endian. </summary> </member> <member name="F:WebSocketSharp.ByteOrder.Big"> <summary> Specifies Big-endian. </summary> </member> <member name="T:WebSocketSharp.ErrorEventArgs"> <summary> Represents the event data for the <see cref="E:WebSocketSharp.WebSocket.OnError"/> event. </summary> <remarks> <para> A <see cref="E:WebSocketSharp.WebSocket.OnError"/> event occurs when the <see cref="T:WebSocketSharp.WebSocket"/> gets an error. </para> <para> If you would like to get the error message, you should access the <see cref="P:WebSocketSharp.ErrorEventArgs.Message"/> property. </para> <para> And if the error is due to an exception, you can get the exception by accessing the <see cref="P:WebSocketSharp.ErrorEventArgs.Exception"/> property. </para> </remarks> </member> <member name="P:WebSocketSharp.ErrorEventArgs.Exception"> <summary> Gets the exception that caused the error. </summary> <value> An <see cref="T:System.Exception"/> instance that represents the cause of the error, or <see langword="null"/> if the error isn't due to an exception. </value> </member> <member name="P:WebSocketSharp.ErrorEventArgs.Message"> <summary> Gets the error message. </summary> <value> A <see cref="T:System.String"/> that represents the error message. </value> </member> <member name="T:WebSocketSharp.WebSocket"> <summary> Implements the WebSocket interface. </summary> <remarks> The WebSocket class provides a set of methods and properties for two-way communication using the WebSocket protocol (<see href="http://tools.ietf.org/html/rfc6455">RFC 6455</see>). </remarks> </member> <member name="F:WebSocketSharp.WebSocket.EmptyBytes"> <summary> Represents the empty array of <see cref="T:System.Byte"/> used internally. </summary> </member> <member name="F:WebSocketSharp.WebSocket.FragmentLength"> <summary> Represents the length used to determine whether the data should be fragmented in sending. </summary> <remarks> <para> The data will be fragmented if that length is greater than the value of this field. </para> <para> If you would like to change the value, you must set it to a value between <c>125</c> and <c>Int32.MaxValue - 14</c> inclusive. </para> </remarks> </member> <member name="F:WebSocketSharp.WebSocket.RandomNumber"> <summary> Represents the random number generator used internally. </summary> </member> <member name="M:WebSocketSharp.WebSocket.#ctor(System.String,System.String[])"> <summary> Initializes a new instance of the <see cref="T:WebSocketSharp.WebSocket"/> class with the specified WebSocket URL and subprotocols. </summary> <param name="url"> A <see cref="T:System.String"/> that represents the WebSocket URL to connect. </param> <param name="protocols"> An array of <see cref="T:System.String"/> that contains the WebSocket subprotocols if any. Each value of <paramref name="protocols"/> must be a token defined in <see href="http://tools.ietf.org/html/rfc2616#section-2.2">RFC 2616</see>. </param> <exception cref="T:System.ArgumentNullException"> <paramref name="url"/> is <see langword="null"/>. </exception> <exception cref="T:System.ArgumentException"> <para> <paramref name="url"/> is invalid. </para> <para> -or- </para> <para> <paramref name="protocols"/> is invalid. </para> </exception> </member> <member name="M:WebSocketSharp.WebSocket.Accept"> <summary> Accepts the WebSocket handshake request. </summary> <remarks> This method isn't available in a client. </remarks> </member> <member name="M:WebSocketSharp.WebSocket.AcceptAsync"> <summary> Accepts the WebSocket handshake request asynchronously. </summary> <remarks> <para> This method doesn't wait for the accept to be complete. </para> <para> This method isn't available in a client. </para> </remarks> </member> <member name="M:WebSocketSharp.WebSocket.Close"> <summary> Closes the WebSocket connection, and releases all associated resources. </summary> </member> <member name="M:WebSocketSharp.WebSocket.Close(System.UInt16)"> <summary> Closes the WebSocket connection with the specified <see cref="T:System.UInt16"/>, and releases all associated resources. </summary> <remarks> This method emits a <see cref="E:WebSocketSharp.WebSocket.OnError"/> event if <paramref name="code"/> isn't in the allowable range of the close status code. </remarks> <param name="code"> A <see cref="T:System.UInt16"/> that represents the status code indicating the reason for the close. </param> </member> <member name="M:WebSocketSharp.WebSocket.Close(WebSocketSharp.CloseStatusCode)"> <summary> Closes the WebSocket connection with the specified <see cref="T:WebSocketSharp.CloseStatusCode"/>, and releases all associated resources. </summary> <param name="code"> One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values, represents the status code indicating the reason for the close. </param> </member> <member name="M:WebSocketSharp.WebSocket.Close(System.UInt16,System.String)"> <summary> Closes the WebSocket connection with the specified <see cref="T:System.UInt16"/> and <see cref="T:System.String"/>, and releases all associated resources. </summary> <remarks> This method emits a <see cref="E:WebSocketSharp.WebSocket.OnError"/> event if <paramref name="code"/> isn't in the allowable range of the close status code or the size of <paramref name="reason"/> is greater than 123 bytes. </remarks> <param name="code"> A <see cref="T:System.UInt16"/> that represents the status code indicating the reason for the close. </param> <param name="reason"> A <see cref="T:System.String"/> that represents the reason for the close. </param> </member> <member name="M:WebSocketSharp.WebSocket.Close(WebSocketSharp.CloseStatusCode,System.String)"> <summary> Closes the WebSocket connection with the specified <see cref="T:WebSocketSharp.CloseStatusCode"/> and <see cref="T:System.String"/>, and releases all associated resources. </summary> <remarks> This method emits a <see cref="E:WebSocketSharp.WebSocket.OnError"/> event if the size of <paramref name="reason"/> is greater than 123 bytes. </remarks> <param name="code"> One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values, represents the status code indicating the reason for the close. </param> <param name="reason"> A <see cref="T:System.String"/> that represents the reason for the close. </param> </member> <member name="M:WebSocketSharp.WebSocket.CloseAsync"> <summary> Closes the WebSocket connection asynchronously, and releases all associated resources. </summary> <remarks> This method doesn't wait for the close to be complete. </remarks> </member> <member name="M:WebSocketSharp.WebSocket.CloseAsync(System.UInt16)"> <summary> Closes the WebSocket connection asynchronously with the specified <see cref="T:System.UInt16"/>, and releases all associated resources. </summary> <remarks> <para> This method doesn't wait for the close to be complete. </para> <para> This method emits a <see cref="E:WebSocketSharp.WebSocket.OnError"/> event if <paramref name="code"/> isn't in the allowable range of the close status code. </para> </remarks> <param name="code"> A <see cref="T:System.UInt16"/> that represents the status code indicating the reason for the close. </param> </member> <member name="M:WebSocketSharp.WebSocket.CloseAsync(WebSocketSharp.CloseStatusCode)"> <summary> Closes the WebSocket connection asynchronously with the specified <see cref="T:WebSocketSharp.CloseStatusCode"/>, and releases all associated resources. </summary> <remarks> This method doesn't wait for the close to be complete. </remarks> <param name="code"> One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values, represents the status code indicating the reason for the close. </param> </member> <member name="M:WebSocketSharp.WebSocket.CloseAsync(System.UInt16,System.String)"> <summary> Closes the WebSocket connection asynchronously with the specified <see cref="T:System.UInt16"/> and <see cref="T:System.String"/>, and releases all associated resources. </summary> <remarks> <para> This method doesn't wait for the close to be complete. </para> <para> This method emits a <see cref="E:WebSocketSharp.WebSocket.OnError"/> event if <paramref name="code"/> isn't in the allowable range of the close status code or the size of <paramref name="reason"/> is greater than 123 bytes. </para> </remarks> <param name="code"> A <see cref="T:System.UInt16"/> that represents the status code indicating the reason for the close. </param> <param name="reason"> A <see cref="T:System.String"/> that represents the reason for the close. </param> </member> <member name="M:WebSocketSharp.WebSocket.CloseAsync(WebSocketSharp.CloseStatusCode,System.String)"> <summary> Closes the WebSocket connection asynchronously with the specified <see cref="T:WebSocketSharp.CloseStatusCode"/> and <see cref="T:System.String"/>, and releases all associated resources. </summary> <remarks> <para> This method doesn't wait for the close to be complete. </para> <para> This method emits a <see cref="E:WebSocketSharp.WebSocket.OnError"/> event if the size of <paramref name="reason"/> is greater than 123 bytes. </para> </remarks> <param name="code"> One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values, represents the status code indicating the reason for the close. </param> <param name="reason"> A <see cref="T:System.String"/> that represents the reason for the close. </param> </member> <member name="M:WebSocketSharp.WebSocket.Connect"> <summary> Establishes a WebSocket connection. </summary> <remarks> This method isn't available in a server. </remarks> </member> <member name="M:WebSocketSharp.WebSocket.ConnectAsync"> <summary> Establishes a WebSocket connection asynchronously. </summary> <remarks> <para> This method doesn't wait for the connect to be complete. </para> <para> This method isn't available in a server. </para> </remarks> </member> <member name="M:WebSocketSharp.WebSocket.Ping"> <summary> Sends a ping using the WebSocket connection. </summary> <returns> <c>true</c> if the <see cref="T:WebSocketSharp.WebSocket"/> receives a pong to this ping in a time; otherwise, <c>false</c>. </returns> </member> <member name="M:WebSocketSharp.WebSocket.Ping(System.String)"> <summary> Sends a ping with the specified <paramref name="message"/> using the WebSocket connec