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.
543 lines
24 KiB
XML
543 lines
24 KiB
XML
<Type Name="WebSocketService" FullName="WebSocketSharp.Server.WebSocketService">
|
|
<TypeSignature Language="C#" Value="public abstract class WebSocketService" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit WebSocketService extends System.Object" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>websocket-sharp</AssemblyName>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.Object</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Docs>
|
|
<summary>
|
|
Provides the basic functions of the WebSocket service.
|
|
</summary>
|
|
<remarks>
|
|
The WebSocketService class is an abstract class.
|
|
</remarks>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public WebSocketService ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketService" /> class.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Bind">
|
|
<MemberSignature Language="C#" Value="public void Bind (WebSocketSharp.WebSocket socket, WebSocketSharp.Server.SessionManager sessions);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Bind(class WebSocketSharp.WebSocket socket, class WebSocketSharp.Server.SessionManager sessions) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="socket" Type="WebSocketSharp.WebSocket" />
|
|
<Parameter Name="sessions" Type="WebSocketSharp.Server.SessionManager" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="socket">
|
|
A <see cref="T:WebSocketSharp.WebSocket" /> to bind to the WebSocketService.
|
|
</param>
|
|
<param name="sessions">
|
|
A <see cref="T:WebSocketSharp.Server.SessionManager" /> to bind to the WebSocketService.
|
|
</param>
|
|
<summary>
|
|
Binds the specified <see cref="T:WebSocketSharp.WebSocket" /> and <see cref="T:WebSocketSharp.Server.SessionManager" />
|
|
to a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Broadcast">
|
|
<MemberSignature Language="C#" Value="public void Broadcast (byte[] data);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Broadcast(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" /> to broadcast.
|
|
</param>
|
|
<summary>
|
|
Broadcasts the specified array of <see cref="T:System.Byte" /> to all clients of the WebSocket service.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Broadcast">
|
|
<MemberSignature Language="C#" Value="public void Broadcast (string data);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Broadcast(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" /> to broadcast.
|
|
</param>
|
|
<summary>
|
|
Broadcasts the specified <see cref="T:System.String" /> to all clients of the WebSocket service.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Broadping">
|
|
<MemberSignature Language="C#" Value="public System.Collections.Generic.Dictionary<string,bool> Broadping ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.Dictionary`2<string, bool> Broadping() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Collections.Generic.Dictionary<System.String,System.Boolean></ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>
|
|
Pings to all clients of the WebSocket service.
|
|
</summary>
|
|
<returns>
|
|
A Dictionary<string, bool> that contains the collection of the ID and value
|
|
indicating whether the WebSocket service received a Pong in a time.
|
|
</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Broadping">
|
|
<MemberSignature Language="C#" Value="public System.Collections.Generic.Dictionary<string,bool> Broadping (string message);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.Dictionary`2<string, bool> Broadping(string message) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Collections.Generic.Dictionary<System.String,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 <see cref="T:System.String" /> to all clients of the WebSocket service.
|
|
</summary>
|
|
<returns>
|
|
A Dictionary<string, bool> that contains the collection of the ID and value
|
|
indicating whether the WebSocket service received a Pong in a time.
|
|
</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ID">
|
|
<MemberSignature Language="C#" Value="public string ID { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance string ID" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets the ID of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
|
|
</summary>
|
|
<value>
|
|
A <see cref="T:System.String" /> that contains a ID.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="IsBound">
|
|
<MemberSignature Language="C#" Value="public bool IsBound { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool IsBound" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets a value indicating whether a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance is bound to a <see cref="T:WebSocketSharp.WebSocket" />.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the WebSocketService is bound to a WebSocket; otherwise, <c>false</c>.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnClose">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnClose (WebSocketSharp.CloseEventArgs e);" />
|
|
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnClose(class WebSocketSharp.CloseEventArgs e) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="e" Type="WebSocketSharp.CloseEventArgs" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="e">
|
|
A <see cref="T:WebSocketSharp.CloseEventArgs" /> that contains the event data associated with a <see cref="E:WebSocketSharp.WebSocket.OnClose" /> event.
|
|
</param>
|
|
<summary>
|
|
Occurs when a inner <see cref="T:WebSocketSharp.WebSocket" /> receives a Close frame or the Stop method is called.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnError">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnError (WebSocketSharp.ErrorEventArgs e);" />
|
|
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnError(class WebSocketSharp.ErrorEventArgs e) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="e" Type="WebSocketSharp.ErrorEventArgs" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="e">
|
|
An <see cref="T:WebSocketSharp.ErrorEventArgs" /> that contains the event data associated with a <see cref="E:WebSocketSharp.WebSocket.OnError" /> event.
|
|
</param>
|
|
<summary>
|
|
Occurs when a inner <see cref="T:WebSocketSharp.WebSocket" /> gets an error.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnMessage">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnMessage (WebSocketSharp.MessageEventArgs e);" />
|
|
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnMessage(class WebSocketSharp.MessageEventArgs e) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="e" Type="WebSocketSharp.MessageEventArgs" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="e">
|
|
A <see cref="T:WebSocketSharp.MessageEventArgs" /> that contains the event data associated with a <see cref="E:WebSocketSharp.WebSocket.OnMessage" /> event.
|
|
</param>
|
|
<summary>
|
|
Occurs when a inner <see cref="T:WebSocketSharp.WebSocket" /> receives a data frame.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnOpen">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnOpen ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnOpen() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>
|
|
Occurs when the WebSocket connection has been established.
|
|
</summary>
|
|
<remarks>To be added.</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 to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
|
|
</summary>
|
|
<returns>
|
|
<c>true</c> if the WebSocketService 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 <see cref="T:System.String" /> to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
|
|
</summary>
|
|
<returns>
|
|
<c>true</c> if the WebSocketService receives a Pong in a time; otherwise, <c>false</c>.
|
|
</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="PingTo">
|
|
<MemberSignature Language="C#" Value="public bool PingTo (string id);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool PingTo(string id) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="id" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="id">
|
|
A <see cref="T:System.String" /> that contains a ID that represents the destination for the Ping.
|
|
</param>
|
|
<summary>
|
|
Pings to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance associated with the specified ID.
|
|
</summary>
|
|
<returns>
|
|
<c>true</c> if the WebSocket service receives a Pong in a time; otherwise, <c>false</c>.
|
|
</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="PingTo">
|
|
<MemberSignature Language="C#" Value="public bool PingTo (string id, string message);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool PingTo(string id, string message) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="id" Type="System.String" />
|
|
<Parameter Name="message" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="id">
|
|
A <see cref="T:System.String" /> that contains a ID that represents the destination for the Ping.
|
|
</param>
|
|
<param name="message">
|
|
A <see cref="T:System.String" /> that contains a message.
|
|
</param>
|
|
<summary>
|
|
Pings with the specified <see cref="T:System.String" /> to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance
|
|
associated with the specified ID.
|
|
</summary>
|
|
<returns>
|
|
<c>true</c> if the WebSocketService receives a Pong in a time; otherwise, <c>false</c>.
|
|
</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="QueryString">
|
|
<MemberSignature Language="C#" Value="protected System.Collections.Specialized.NameValueCollection QueryString { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Specialized.NameValueCollection QueryString" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Collections.Specialized.NameValueCollection</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets the HTTP query string variables used in the WebSocket opening handshake.
|
|
</summary>
|
|
<value>
|
|
A <see cref="T:System.Collections.Specialized.NameValueCollection" /> that contains the query string variables.
|
|
</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 data to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
|
|
</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 data to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SendTo">
|
|
<MemberSignature Language="C#" Value="public void SendTo (string id, byte[] data);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SendTo(string id, unsigned int8[] data) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="id" Type="System.String" />
|
|
<Parameter Name="data" Type="System.Byte[]" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="id">
|
|
A <see cref="T:System.String" /> that contains a ID that represents the destination for the data.
|
|
</param>
|
|
<param name="data">
|
|
An array of <see cref="T:System.Byte" /> that contains a binary data to send.
|
|
</param>
|
|
<summary>
|
|
Sends a binary data to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance associated with the specified ID.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SendTo">
|
|
<MemberSignature Language="C#" Value="public void SendTo (string id, string data);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SendTo(string id, string data) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="id" Type="System.String" />
|
|
<Parameter Name="data" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="id">
|
|
A <see cref="T:System.String" /> that contains a ID that represents the destination for the data.
|
|
</param>
|
|
<param name="data">
|
|
A <see cref="T:System.String" /> that contains a text data to send.
|
|
</param>
|
|
<summary>
|
|
Sends a text data to the client of a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance associated with the specified ID.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Sessions">
|
|
<MemberSignature Language="C#" Value="protected WebSocketSharp.Server.SessionManager Sessions { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class WebSocketSharp.Server.SessionManager Sessions" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>WebSocketSharp.Server.SessionManager</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets the sessions to the WebSocket service.
|
|
</summary>
|
|
<value>
|
|
A <see cref="T:WebSocketSharp.Server.SessionManager" /> that contains the sessions to the WebSocket service.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Start">
|
|
<MemberSignature Language="C#" Value="public void Start ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Start() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>
|
|
Starts a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Stop">
|
|
<MemberSignature Language="C#" Value="public void Stop ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Stop() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>
|
|
Stops a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Stop">
|
|
<MemberSignature Language="C#" Value="public void Stop (ushort code, string reason);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Stop(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 contains a status code indicating the reason for stop.
|
|
</param>
|
|
<param name="reason">
|
|
A <see cref="T:System.String" /> that contains a reason for stop.
|
|
</param>
|
|
<summary>
|
|
Stops a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance with the specified <see cref="T:System.UInt16" /> and <see cref="T:System.String" />.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Stop">
|
|
<MemberSignature Language="C#" Value="public void Stop (WebSocketSharp.CloseStatusCode code, string reason);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Stop(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 contains a status code indicating the reason for stop.
|
|
</param>
|
|
<param name="reason">
|
|
A <see cref="T:System.String" /> that contains a reason for stop.
|
|
</param>
|
|
<summary>
|
|
Stops a <see cref="T:WebSocketSharp.Server.WebSocketService" /> instance with the specified <see cref="T:WebSocketSharp.CloseStatusCode" /> and <see cref="T:System.String" />.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type>
|