332 lines
16 KiB
XML
332 lines
16 KiB
XML
<Type Name="WebSocketServiceHost<T>" FullName="WebSocketSharp.Server.WebSocketServiceHost<T>">
|
|
<TypeSignature Language="C#" Value="public class WebSocketServiceHost<T> : WebSocketSharp.Server.WebSocketServerBase, WebSocketSharp.Server.IServiceHost where T : WebSocketServicenew()" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit WebSocketServiceHost`1<.ctor (class WebSocketSharp.Server.WebSocketService) T> extends WebSocketSharp.Server.WebSocketServerBase implements class WebSocketSharp.Server.IServiceHost" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>websocket-sharp</AssemblyName>
|
|
</AssemblyInfo>
|
|
<TypeParameters>
|
|
<TypeParameter Name="T">
|
|
<Constraints>
|
|
<ParameterAttribute>DefaultConstructorConstraint</ParameterAttribute>
|
|
<BaseTypeName>WebSocketSharp.Server.WebSocketService</BaseTypeName>
|
|
</Constraints>
|
|
</TypeParameter>
|
|
</TypeParameters>
|
|
<Base>
|
|
<BaseTypeName>WebSocketSharp.Server.WebSocketServerBase</BaseTypeName>
|
|
</Base>
|
|
<Interfaces>
|
|
<Interface>
|
|
<InterfaceName>WebSocketSharp.Server.IServiceHost</InterfaceName>
|
|
</Interface>
|
|
</Interfaces>
|
|
<Docs>
|
|
<typeparam name="T">
|
|
The type of the WebSocket service that the server provides. The T must inherit the <see cref="T:WebSocketSharp.Server.WebSocketService" /> class.
|
|
</typeparam>
|
|
<summary>
|
|
Provides the functions of the server that receives the WebSocket connection requests.
|
|
</summary>
|
|
<remarks>
|
|
The WebSocketServiceHost<T> class provides the single WebSocket service.
|
|
</remarks>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public WebSocketServiceHost (int port);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 port) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="port" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="port">
|
|
An <see cref="T:System.Int32" /> that contains a port number.
|
|
</param>
|
|
<summary>
|
|
Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts
|
|
on the specified <paramref name="port" />.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public WebSocketServiceHost (string url);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string url) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="url" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="url">
|
|
A <see cref="T:System.String" /> that contains a WebSocket URL.
|
|
</param>
|
|
<summary>
|
|
Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts
|
|
on the specified WebSocket URL.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public WebSocketServiceHost (int port, bool secure);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 port, bool secure) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="port" Type="System.Int32" />
|
|
<Parameter Name="secure" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="port">
|
|
An <see cref="T:System.Int32" /> that contains a port number.
|
|
</param>
|
|
<param name="secure">
|
|
A <see cref="T:System.Boolean" /> that indicates providing a secure connection or not. (<c>true</c> indicates providing a secure connection.)
|
|
</param>
|
|
<summary>
|
|
Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts
|
|
on the specified <paramref name="port" /> and <paramref name="secure" />.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public WebSocketServiceHost (int port, string absPath);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 port, string absPath) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="port" Type="System.Int32" />
|
|
<Parameter Name="absPath" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="port">
|
|
An <see cref="T:System.Int32" /> that contains a port number.
|
|
</param>
|
|
<param name="absPath">
|
|
A <see cref="T:System.String" /> that contains an absolute path.
|
|
</param>
|
|
<summary>
|
|
Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts
|
|
on the specified <paramref name="port" /> and <paramref name="absPath" />.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public WebSocketServiceHost (int port, string absPath, bool secure);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 port, string absPath, bool secure) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="port" Type="System.Int32" />
|
|
<Parameter Name="absPath" Type="System.String" />
|
|
<Parameter Name="secure" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="port">
|
|
An <see cref="T:System.Int32" /> that contains a port number.
|
|
</param>
|
|
<param name="absPath">
|
|
A <see cref="T:System.String" /> that contains an absolute path.
|
|
</param>
|
|
<param name="secure">
|
|
A <see cref="T:System.Boolean" /> that indicates providing a secure connection or not. (<c>true</c> indicates providing a secure connection.)
|
|
</param>
|
|
<summary>
|
|
Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts
|
|
on the specified <paramref name="port" />, <paramref name="absPath" /> and <paramref name="secure" />.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public WebSocketServiceHost (System.Net.IPAddress address, int port, string absPath);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Net.IPAddress address, int32 port, string absPath) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="address" Type="System.Net.IPAddress" />
|
|
<Parameter Name="port" Type="System.Int32" />
|
|
<Parameter Name="absPath" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="address">
|
|
A <see cref="T:System.Net.IPAddress" /> that contains an IP address.
|
|
</param>
|
|
<param name="port">
|
|
An <see cref="T:System.Int32" /> that contains a port number.
|
|
</param>
|
|
<param name="absPath">
|
|
A <see cref="T:System.String" /> that contains an absolute path.
|
|
</param>
|
|
<summary>
|
|
Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts
|
|
on the specified <paramref name="address" />, <paramref name="port" /> and <paramref name="absPath" />.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public WebSocketServiceHost (System.Net.IPAddress address, int port, string absPath, bool secure);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Net.IPAddress address, int32 port, string absPath, bool secure) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="address" Type="System.Net.IPAddress" />
|
|
<Parameter Name="port" Type="System.Int32" />
|
|
<Parameter Name="absPath" Type="System.String" />
|
|
<Parameter Name="secure" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="address">
|
|
A <see cref="T:System.Net.IPAddress" /> that contains an IP address.
|
|
</param>
|
|
<param name="port">
|
|
An <see cref="T:System.Int32" /> that contains a port number.
|
|
</param>
|
|
<param name="absPath">
|
|
A <see cref="T:System.String" /> that contains an absolute path.
|
|
</param>
|
|
<param name="secure">
|
|
A <see cref="T:System.Boolean" /> that indicates providing a secure connection or not. (<c>true</c> indicates providing a secure connection.)
|
|
</param>
|
|
<summary>
|
|
Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts
|
|
on the specified <paramref name="address" />, <paramref name="port" />, <paramref name="absPath" /> and <paramref name="secure" />.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="AcceptWebSocket">
|
|
<MemberSignature Language="C#" Value="protected override void AcceptWebSocket (WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext context);" />
|
|
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void AcceptWebSocket(class WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext context) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="context" Type="WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="context">
|
|
A <see cref="T:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext" /> that contains a WebSocket connection.
|
|
</param>
|
|
<summary>
|
|
Accepts a WebSocket connection.
|
|
</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 newslot virtual 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.
|
|
</summary>
|
|
<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.
|
|
</summary>
|
|
<returns>
|
|
A Dictionary<string, bool> that contains the collection of the session ID and value
|
|
indicating whether the server received a Pong in a time.
|
|
</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Stop">
|
|
<MemberSignature Language="C#" Value="public override void Stop ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Stop() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>
|
|
Stops receiving the WebSocket connection requests.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Sweeped">
|
|
<MemberSignature Language="C#" Value="public bool Sweeped { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool Sweeped" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets or sets a value indicating whether the server cleans up the inactive client.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the server cleans up the inactive client; otherwise, <c>false</c>.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Uri">
|
|
<MemberSignature Language="C#" Value="public Uri Uri { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Uri Uri" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Uri</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets the WebSocket URL on which to listen for incoming connection attempts.
|
|
</summary>
|
|
<value>
|
|
A <see cref="T:System.Uri" /> that contains a WebSocket URL.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="WebSocketSharp.Server.IServiceHost.BindWebSocket">
|
|
<MemberSignature Language="C#" Value="void IServiceHost.BindWebSocket (WebSocketSharp.WebSocket socket);" />
|
|
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance void WebSocketSharp.Server.IServiceHost.BindWebSocket(class WebSocketSharp.WebSocket socket) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="socket" Type="WebSocketSharp.WebSocket" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="socket">
|
|
A <see cref="T:WebSocketSharp.WebSocket" /> to bind.
|
|
</param>
|
|
<summary>
|
|
Binds the specified <see cref="T:WebSocketSharp.WebSocket" /> instance to the WebSocket service.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type>
|