673 lines
29 KiB
XML
673 lines
29 KiB
XML
<Type Name="WebSocket" FullName="WebSocketSharp.WebSocket">
|
|
<TypeSignature Language="C#" Value="public class WebSocket : IDisposable" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi WebSocket extends System.Object implements class System.IDisposable" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>websocket-sharp</AssemblyName>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.Object</BaseTypeName>
|
|
</Base>
|
|
<Interfaces>
|
|
<Interface>
|
|
<InterfaceName>System.IDisposable</InterfaceName>
|
|
</Interface>
|
|
</Interfaces>
|
|
<Docs>
|
|
<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>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public WebSocket (string url, string[] protocols);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string url, string[] protocols) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="url" Type="System.String" />
|
|
<Parameter Name="protocols" Type="System.String[]">
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ParamArray</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Parameter>
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="url">
|
|
A <see cref="T:System.String" /> that contains a WebSocket URL to connect.
|
|
</param>
|
|
<param name="protocols">
|
|
An array of <see cref="T:System.String" /> that contains the WebSocket subprotocols if any.
|
|
</param>
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:WebSocketSharp.WebSocket" /> class with the specified WebSocket URL and subprotocols.
|
|
</summary>
|
|
<remarks />
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="url" /> is <see langword="null" />.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="url" /> is not valid WebSocket URL.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public WebSocket (string url, EventHandler onOpen, EventHandler<WebSocketSharp.MessageEventArgs> onMessage, EventHandler<WebSocketSharp.ErrorEventArgs> onError, EventHandler<WebSocketSharp.CloseEventArgs> onClose, string[] protocols);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string url, class System.EventHandler onOpen, class System.EventHandler`1<class WebSocketSharp.MessageEventArgs> onMessage, class System.EventHandler`1<class WebSocketSharp.ErrorEventArgs> onError, class System.EventHandler`1<class WebSocketSharp.CloseEventArgs> onClose, string[] protocols) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="url" Type="System.String" />
|
|
<Parameter Name="onOpen" Type="System.EventHandler" />
|
|
<Parameter Name="onMessage" Type="System.EventHandler<WebSocketSharp.MessageEventArgs>" />
|
|
<Parameter Name="onError" Type="System.EventHandler<WebSocketSharp.ErrorEventArgs>" />
|
|
<Parameter Name="onClose" Type="System.EventHandler<WebSocketSharp.CloseEventArgs>" />
|
|
<Parameter Name="protocols" Type="System.String[]">
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ParamArray</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Parameter>
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="url">
|
|
A <see cref="T:System.String" /> that contains a WebSocket URL to connect.
|
|
</param>
|
|
<param name="onOpen">
|
|
An <see cref="E:WebSocketSharp.WebSocket.OnOpen" /> event handler.
|
|
</param>
|
|
<param name="onMessage">
|
|
An <see cref="E:WebSocketSharp.WebSocket.OnMessage" /> event handler.
|
|
</param>
|
|
<param name="onError">
|
|
An <see cref="E:WebSocketSharp.WebSocket.OnError" /> event handler.
|
|
</param>
|
|
<param name="onClose">
|
|
An <see cref="E:WebSocketSharp.WebSocket.OnClose" /> event handler.
|
|
</param>
|
|
<param name="protocols">
|
|
An array of <see cref="T:System.String" /> that contains the WebSocket subprotocols if any.
|
|
</param>
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:WebSocketSharp.WebSocket" /> class with the specified WebSocket URL,
|
|
OnOpen, OnMessage, OnError, OnClose event handlers and subprotocols.
|
|
</summary>
|
|
<remarks>
|
|
This constructor initializes a new instance of the <see cref="T:WebSocketSharp.WebSocket" /> class and
|
|
establishes a WebSocket connection.
|
|
</remarks>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="url" /> is <see langword="null" />.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="url" /> is not valid WebSocket URL.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Close">
|
|
<MemberSignature Language="C#" Value="public void Close ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Close() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>
|
|
Closes the WebSocket connection and releases all associated resources.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Close">
|
|
<MemberSignature Language="C#" Value="public void Close (ushort code);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Close(unsigned int16 code) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="code" Type="System.UInt16" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="code">
|
|
A <see cref="T:System.UInt16" /> that indicates the status code for closure.
|
|
</param>
|
|
<summary>
|
|
Closes the WebSocket connection with the specified <paramref name="code" /> and
|
|
releases all associated resources.
|
|
</summary>
|
|
<remarks>
|
|
This Close method emits a <see cref="E:WebSocketSharp.WebSocket.OnError" /> event if <paramref name="code" /> is not
|
|
in the allowable range of the WebSocket close status code.
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Close">
|
|
<MemberSignature Language="C#" Value="public void Close (WebSocketSharp.CloseStatusCode code);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Close(valuetype WebSocketSharp.CloseStatusCode code) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="code" Type="WebSocketSharp.CloseStatusCode" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="code">
|
|
One of the <see cref="T:WebSocketSharp.CloseStatusCode" /> values that indicates the status code for closure.
|
|
</param>
|
|
<summary>
|
|
Closes the WebSocket connection with the specified <paramref name="code" /> and
|
|
releases all associated resources.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Close">
|
|
<MemberSignature Language="C#" Value="public void Close (ushort code, string reason);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Close(unsigned int16 code, string reason) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="code" Type="System.UInt16" />
|
|
<Parameter Name="reason" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="code">
|
|
A <see cref="T:System.UInt16" /> that indicates the status code for closure.
|
|
</param>
|
|
<param name="reason">
|
|
A <see cref="T:System.String" /> that contains the reason for closure.
|
|
</param>
|
|
<summary>
|
|
Closes the WebSocket connection with the specified <paramref name="code" /> and
|
|
<paramref name="reason" />, and releases all associated resources.
|
|
</summary>
|
|
<remarks>
|
|
This Close method emits a <see cref="E:WebSocketSharp.WebSocket.OnError" /> event if <paramref name="code" /> is not
|
|
in the allowable range of the WebSocket close status code.
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Close">
|
|
<MemberSignature Language="C#" Value="public void Close (WebSocketSharp.CloseStatusCode code, string reason);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Close(valuetype WebSocketSharp.CloseStatusCode code, string reason) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="code" Type="WebSocketSharp.CloseStatusCode" />
|
|
<Parameter Name="reason" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="code">
|
|
One of the <see cref="T:WebSocketSharp.CloseStatusCode" /> values that indicates the status code for closure.
|
|
</param>
|
|
<param name="reason">
|
|
A <see cref="T:System.String" /> that contains the reason for closure.
|
|
</param>
|
|
<summary>
|
|
Closes the WebSocket connection with the specified <paramref name="code" /> and
|
|
<paramref name="reason" />, and releases all associated resources.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Compression">
|
|
<MemberSignature Language="C#" Value="public WebSocketSharp.CompressionMethod Compression { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance valuetype WebSocketSharp.CompressionMethod Compression" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>WebSocketSharp.CompressionMethod</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets or sets the compression method used to compress the payload data of the WebSocket Data frame.
|
|
</summary>
|
|
<value>
|
|
One of the <see cref="T:WebSocketSharp.CompressionMethod" /> values that indicates the compression method to use.
|
|
The default is <see cref="F:WebSocketSharp.CompressionMethod.NONE" />.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Connect">
|
|
<MemberSignature Language="C#" Value="public void Connect ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Connect() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>
|
|
Establishes a WebSocket connection.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Cookies">
|
|
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<WebSocketSharp.Net.Cookie> Cookies { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1<class WebSocketSharp.Net.Cookie> Cookies" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Collections.Generic.IEnumerable<WebSocketSharp.Net.Cookie></ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets the cookies used in the WebSocket opening handshake.
|
|
</summary>
|
|
<value>
|
|
An IEnumerable<Cookie> interface that provides an enumerator which supports the iteration
|
|
over the collection of cookies.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Dispose">
|
|
<MemberSignature Language="C#" Value="public void Dispose ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>
|
|
Closes the WebSocket connection and releases all associated resources.
|
|
</summary>
|
|
<remarks>
|
|
This method closes the WebSocket connection with the <see cref="F:WebSocketSharp.CloseStatusCode.AWAY" />.
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Extensions">
|
|
<MemberSignature Language="C#" Value="public string Extensions { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance string Extensions" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets the WebSocket extensions selected by the server.
|
|
</summary>
|
|
<value>
|
|
A <see cref="T:System.String" /> that contains the extensions if any. The default is <see cref="F:System.String.Empty" />.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="IsAlive">
|
|
<MemberSignature Language="C#" Value="public bool IsAlive { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool IsAlive" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets a value indicating whether the WebSocket connection is alive.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the connection is alive; otherwise, <c>false</c>.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="IsSecure">
|
|
<MemberSignature Language="C#" Value="public bool IsSecure { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool IsSecure" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets a value indicating whether the WebSocket connection is secure.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the connection is secure; otherwise, <c>false</c>.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnClose">
|
|
<MemberSignature Language="C#" Value="public event EventHandler<WebSocketSharp.CloseEventArgs> OnClose;" />
|
|
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class WebSocketSharp.CloseEventArgs> OnClose" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.EventHandler<WebSocketSharp.CloseEventArgs></ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Occurs when the <see cref="T:WebSocketSharp.WebSocket" /> receives a Close frame or the Close method is called.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnError">
|
|
<MemberSignature Language="C#" Value="public event EventHandler<WebSocketSharp.ErrorEventArgs> OnError;" />
|
|
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class WebSocketSharp.ErrorEventArgs> OnError" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.EventHandler<WebSocketSharp.ErrorEventArgs></ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Occurs when the <see cref="T:WebSocketSharp.WebSocket" /> gets an error.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnMessage">
|
|
<MemberSignature Language="C#" Value="public event EventHandler<WebSocketSharp.MessageEventArgs> OnMessage;" />
|
|
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class WebSocketSharp.MessageEventArgs> OnMessage" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.EventHandler<WebSocketSharp.MessageEventArgs></ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Occurs when the <see cref="T:WebSocketSharp.WebSocket" /> receives a data frame.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnOpen">
|
|
<MemberSignature Language="C#" Value="public event EventHandler OnOpen;" />
|
|
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler OnOpen" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.EventHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Occurs when the WebSocket connection has been established.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Origin">
|
|
<MemberSignature Language="C#" Value="public string Origin { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance string Origin" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets or sets the value of the Origin header used in the WebSocket opening handshake.
|
|
</summary>
|
|
<value>
|
|
<para>
|
|
A <see cref="T:System.String" /> that contains the value of the <see href="http://tools.ietf.org/html/rfc6454#section-7">HTTP Origin header</see> to send.
|
|
The default is <see cref="F:System.String.Empty" />.
|
|
</para>
|
|
<para>
|
|
The value of the Origin header has the following syntax: <c><scheme>://<host>[:<port>]</c></para>
|
|
</value>
|
|
<remarks>
|
|
A <see cref="T:WebSocketSharp.WebSocket" /> instance does not send the Origin header in the WebSocket opening handshake
|
|
if the value of this property is <see cref="F:System.String.Empty" />.
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Ping">
|
|
<MemberSignature Language="C#" Value="public bool Ping ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Ping() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>
|
|
Pings using the WebSocket connection.
|
|
</summary>
|
|
<returns>
|
|
<c>true</c> if the <see cref="T:WebSocketSharp.WebSocket" /> receives a Pong in a time; otherwise, <c>false</c>.
|
|
</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Ping">
|
|
<MemberSignature Language="C#" Value="public bool Ping (string message);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Ping(string message) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="message" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="message">
|
|
A <see cref="T:System.String" /> that contains a message.
|
|
</param>
|
|
<summary>
|
|
Pings with the specified <paramref name="message" /> using the WebSocket connection.
|
|
</summary>
|
|
<returns>
|
|
<c>true</c> if the <see cref="T:WebSocketSharp.WebSocket" /> receives a Pong in a time; otherwise, <c>false</c>.
|
|
</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Protocol">
|
|
<MemberSignature Language="C#" Value="public string Protocol { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance string Protocol" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets the WebSocket subprotocol selected by the server.
|
|
</summary>
|
|
<value>
|
|
A <see cref="T:System.String" /> that contains the subprotocol if any. The default is <see cref="F:System.String.Empty" />.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ReadyState">
|
|
<MemberSignature Language="C#" Value="public WebSocketSharp.WsState ReadyState { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance valuetype WebSocketSharp.WsState ReadyState" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>WebSocketSharp.WsState</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets the state of the WebSocket connection.
|
|
</summary>
|
|
<value>
|
|
One of the <see cref="T:WebSocketSharp.WsState" /> values. The default is <see cref="F:WebSocketSharp.WsState.CONNECTING" />.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Send">
|
|
<MemberSignature Language="C#" Value="public void Send (byte[] data);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Send(unsigned int8[] data) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="data" Type="System.Byte[]" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="data">
|
|
An array of <see cref="T:System.Byte" /> that contains a binary data to send.
|
|
</param>
|
|
<summary>
|
|
Sends a binary <paramref name="data" /> using the WebSocket connection.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Send">
|
|
<MemberSignature Language="C#" Value="public void Send (System.IO.FileInfo file);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Send(class System.IO.FileInfo file) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="file" Type="System.IO.FileInfo" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="file">
|
|
A <see cref="T:System.IO.FileInfo" /> that contains a binary data to send.
|
|
</param>
|
|
<summary>
|
|
Sends a binary data using the WebSocket connection.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Send">
|
|
<MemberSignature Language="C#" Value="public void Send (string data);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Send(string data) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="data" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="data">
|
|
A <see cref="T:System.String" /> that contains a text data to send.
|
|
</param>
|
|
<summary>
|
|
Sends a text <paramref name="data" /> using the WebSocket connection.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SendAsync">
|
|
<MemberSignature Language="C#" Value="public void SendAsync (byte[] data, Action completed);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SendAsync(unsigned int8[] data, class System.Action completed) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="data" Type="System.Byte[]" />
|
|
<Parameter Name="completed" Type="System.Action" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="data">
|
|
An array of <see cref="T:System.Byte" /> that contains a binary data to send.
|
|
</param>
|
|
<param name="completed">
|
|
An <see cref="T:System.Action" /> delegate that references the method(s) called when
|
|
the asynchronous operation completes.
|
|
</param>
|
|
<summary>
|
|
Sends a binary <paramref name="data" /> asynchronously using the WebSocket connection.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SendAsync">
|
|
<MemberSignature Language="C#" Value="public void SendAsync (System.IO.FileInfo file, Action completed);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SendAsync(class System.IO.FileInfo file, class System.Action completed) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="file" Type="System.IO.FileInfo" />
|
|
<Parameter Name="completed" Type="System.Action" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="file">
|
|
A <see cref="T:System.IO.FileInfo" /> that contains a binary data to send.
|
|
</param>
|
|
<param name="completed">
|
|
An <see cref="T:System.Action" /> delegate that references the method(s) called when
|
|
the asynchronous operation completes.
|
|
</param>
|
|
<summary>
|
|
Sends a binary data asynchronously using the WebSocket connection.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SendAsync">
|
|
<MemberSignature Language="C#" Value="public void SendAsync (string data, Action completed);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SendAsync(string data, class System.Action completed) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="data" Type="System.String" />
|
|
<Parameter Name="completed" Type="System.Action" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="data">
|
|
A <see cref="T:System.String" /> that contains a text data to send.
|
|
</param>
|
|
<param name="completed">
|
|
An <see cref="T:System.Action" /> delegate that references the method(s) called when
|
|
the asynchronous operation completes.
|
|
</param>
|
|
<summary>
|
|
Sends a text <paramref name="data" /> asynchronously using the WebSocket connection.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetCookie">
|
|
<MemberSignature Language="C#" Value="public void SetCookie (WebSocketSharp.Net.Cookie cookie);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetCookie(class WebSocketSharp.Net.Cookie cookie) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="cookie" Type="WebSocketSharp.Net.Cookie" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="cookie">
|
|
A <see cref="T:WebSocketSharp.Net.Cookie" /> that contains an HTTP Cookie to set.
|
|
</param>
|
|
<summary>
|
|
Sets a <see cref="T:WebSocketSharp.Net.Cookie" /> used in the WebSocket opening handshake.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Url">
|
|
<MemberSignature Language="C#" Value="public Uri Url { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Uri Url" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Uri</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets the WebSocket URL to connect.
|
|
</summary>
|
|
<value>
|
|
A <see cref="T:System.Uri" /> that contains the WebSocket URL to connect.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type>
|