DemoWebsocket/websocket-sharp/doc/mdoc/WebSocketSharp.Server/IServiceHost.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 properties for the WebSocket service host.
            </summary>
    <remarks />
  </Docs>
  <Members>
    <Member MemberName="BindWebSocket">
      <MemberSignature Language="C#" Value="public void BindWebSocket (WebSocketSharp.Net.WebSockets.WebSocketContext context);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void BindWebSocket(class WebSocketSharp.Net.WebSockets.WebSocketContext context) cil managed" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="context" Type="WebSocketSharp.Net.WebSockets.WebSocketContext" />
      </Parameters>
      <Docs>
        <param name="context">
            A <see cref="T:WebSocketSharp.Net.WebSockets.WebSocketContext" /> that contains the WebSocket connection request objects to bind.
            </param>
        <summary>
            Binds the specified <see cref="T:WebSocketSharp.Net.WebSockets.WebSocketContext" /> 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 (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="Sweeping">
      <MemberSignature Language="C#" Value="public bool Sweeping { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool Sweeping" />
      <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
            instances periodically.
            </summary>
        <value>
          <c>true</c> if the WebSocket service host cleans up the inactive service instances periodically;
            otherwise, <c>false</c>.
            </value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>