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.
221 lines
11 KiB
XML
221 lines
11 KiB
XML
<Type Name="WebSocketServiceManager" FullName="WebSocketSharp.Server.WebSocketServiceManager">
|
|
<TypeSignature Language="C#" Value="public class WebSocketServiceManager" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit WebSocketServiceManager extends System.Object" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>websocket-sharp</AssemblyName>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.Object</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Docs>
|
|
<summary>
|
|
Manages the collection of <see cref="T:WebSocketSharp.Server.WebSocketService" /> objects.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName="ActiveIDs">
|
|
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<string> ActiveIDs { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1<string> ActiveIDs" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Collections.Generic.IEnumerable<System.String></ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets the collection of IDs of active <see cref="T:WebSocketSharp.Server.WebSocketService" /> objects
|
|
managed by the <see cref="T:WebSocketSharp.Server.WebSocketServiceManager" />.
|
|
</summary>
|
|
<value>
|
|
An IEnumerable<string> that contains the collection of IDs of active <see cref="T:WebSocketSharp.Server.WebSocketService" /> objects.
|
|
</value>
|
|
<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 the clients of every <see cref="T:WebSocketSharp.Server.WebSocketService" />
|
|
managed by the <see cref="T:WebSocketSharp.Server.WebSocketServiceManager" />.
|
|
</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 the clients of every <see cref="T:WebSocketSharp.Server.WebSocketService" />
|
|
managed by the <see cref="T:WebSocketSharp.Server.WebSocketServiceManager" />.
|
|
</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 the clients of every <see cref="T:WebSocketSharp.Server.WebSocketService" />
|
|
managed by the <see cref="T:WebSocketSharp.Server.WebSocketServiceManager" />.
|
|
</summary>
|
|
<returns>
|
|
A Dictionary<string, bool> that contains the collection of IDs and values
|
|
indicating whether each <see cref="T:WebSocketSharp.Server.WebSocketService" /> received a Pong in a time.
|
|
</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Count">
|
|
<MemberSignature Language="C#" Value="public int Count { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance int32 Count" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets the number of <see cref="T:WebSocketSharp.Server.WebSocketService" /> objects
|
|
managed by the <see cref="T:WebSocketSharp.Server.WebSocketServiceManager" />.
|
|
</summary>
|
|
<value>
|
|
An <see cref="T:System.Int32" /> that contains the number of <see cref="T:WebSocketSharp.Server.WebSocketService" /> objects
|
|
managed by the <see cref="T:WebSocketSharp.Server.WebSocketServiceManager" />.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="IDs">
|
|
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<string> IDs { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1<string> IDs" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Collections.Generic.IEnumerable<System.String></ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets the collection of IDs of <see cref="T:WebSocketSharp.Server.WebSocketService" /> objects
|
|
managed by the <see cref="T:WebSocketSharp.Server.WebSocketServiceManager" />.
|
|
</summary>
|
|
<value>
|
|
An IEnumerable<string> that contains the collection of IDs of <see cref="T:WebSocketSharp.Server.WebSocketService" /> objects.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="InactiveIDs">
|
|
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<string> InactiveIDs { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1<string> InactiveIDs" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Collections.Generic.IEnumerable<System.String></ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets the collection of IDs of inactive <see cref="T:WebSocketSharp.Server.WebSocketService" /> objects
|
|
managed by the <see cref="T:WebSocketSharp.Server.WebSocketServiceManager" />.
|
|
</summary>
|
|
<value>
|
|
An IEnumerable<string> that contains the collection of IDs of inactive <see cref="T:WebSocketSharp.Server.WebSocketService" /> objects.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Sweep">
|
|
<MemberSignature Language="C#" Value="public void Sweep ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Sweep() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>
|
|
Cleans up the inactive <see cref="T:WebSocketSharp.Server.WebSocketService" /> objects.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Sweeping">
|
|
<MemberSignature Language="C#" Value="public bool Sweeping { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool Sweeping" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets a value indicating whether the <see cref="T:WebSocketSharp.Server.WebSocketServiceManager" /> cleans up
|
|
the inactive <see cref="T:WebSocketSharp.Server.WebSocketService" /> objects periodically.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the <see cref="T:WebSocketSharp.Server.WebSocketServiceManager" /> cleans up the inactive <see cref="T:WebSocketSharp.Server.WebSocketService" /> objects
|
|
every 60 seconds; otherwise, <c>false</c>.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="TryGetWebSocketService">
|
|
<MemberSignature Language="C#" Value="public bool TryGetWebSocketService (string id, out WebSocketSharp.Server.WebSocketService service);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetWebSocketService(string id, class WebSocketSharp.Server.WebSocketService service) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="id" Type="System.String" />
|
|
<Parameter Name="service" Type="WebSocketSharp.Server.WebSocketService&" RefType="out" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="id">
|
|
A <see cref="T:System.String" /> that contains the ID to find.
|
|
</param>
|
|
<param name="service">
|
|
When this method returns, contains the <see cref="T:WebSocketSharp.Server.WebSocketService" /> with the specified <paramref name="id" />, if the <paramref name="id" /> is found; otherwise, <see langword="null" />.
|
|
</param>
|
|
<summary>
|
|
Tries to get the <see cref="T:WebSocketSharp.Server.WebSocketService" /> associated with the specified <paramref name="id" />.
|
|
</summary>
|
|
<returns>
|
|
<c>true</c> if the <see cref="T:WebSocketSharp.Server.WebSocketServiceManager" /> manages the <see cref="T:WebSocketSharp.Server.WebSocketService" /> with the specified <paramref name="id" />; otherwise, <c>false</c>.
|
|
</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type>
|