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.
104 lines
4.0 KiB
XML
104 lines
4.0 KiB
XML
<Type Name="IServiceHost" FullName="WebSocketSharp.Server.IServiceHost">
|
|
<TypeSignature Language="C#" Value="public interface IServiceHost" />
|
|
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IServiceHost" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>websocket-sharp</AssemblyName>
|
|
</AssemblyInfo>
|
|
<Interfaces />
|
|
<Docs>
|
|
<summary>
|
|
Exposes the methods and property for the WebSocket service host.
|
|
</summary>
|
|
<remarks />
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName="BindWebSocket">
|
|
<MemberSignature Language="C#" Value="public void BindWebSocket (WebSocketSharp.WebSocket socket);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void 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" /> to the WebSocket service instance.
|
|
</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 service clients.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Start">
|
|
<MemberSignature Language="C#" Value="public void Start ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Start() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>
|
|
Starts the WebSocket service host.
|
|
</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 newslot virtual instance void Stop() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>
|
|
Stops the WebSocket service host.
|
|
</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 WebSocket service host cleans up the inactive service clients periodically.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the WebSocket service host cleans up the inactive service clients periodically; otherwise, <c>false</c>.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type>
|