Files
websocket-sharp/websocket-sharp/doc/mdoc/WebSocketSharp.Server/WebSocketService.xml
2013-01-11 22:00:42 +09:00

509 lines
20 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>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</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>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</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>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<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">To be added.</param>
<param name="sessions">To be added.</param>
<summary>To be added.</summary>
<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>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</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>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnClose">
<MemberSignature Language="C#" Value="protected virtual void OnClose (object sender, WebSocketSharp.CloseEventArgs e);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnClose(object sender, class WebSocketSharp.CloseEventArgs e) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="e" Type="WebSocketSharp.CloseEventArgs" />
</Parameters>
<Docs>
<param name="sender">To be added.</param>
<param name="e">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnError">
<MemberSignature Language="C#" Value="protected virtual void OnError (object sender, WebSocketSharp.ErrorEventArgs e);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnError(object sender, class WebSocketSharp.ErrorEventArgs e) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="e" Type="WebSocketSharp.ErrorEventArgs" />
</Parameters>
<Docs>
<param name="sender">To be added.</param>
<param name="e">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnMessage">
<MemberSignature Language="C#" Value="protected virtual void OnMessage (object sender, WebSocketSharp.MessageEventArgs e);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnMessage(object sender, class WebSocketSharp.MessageEventArgs e) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="e" Type="WebSocketSharp.MessageEventArgs" />
</Parameters>
<Docs>
<param name="sender">To be added.</param>
<param name="e">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnOpen">
<MemberSignature Language="C#" Value="protected virtual void OnOpen (object sender, EventArgs e);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnOpen(object sender, class System.EventArgs e) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="e" Type="System.EventArgs" />
</Parameters>
<Docs>
<param name="sender">To be added.</param>
<param name="e">To be added.</param>
<summary>To be added.</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>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</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>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<param name="message">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PingAround">
<MemberSignature Language="C#" Value="public System.Collections.Generic.Dictionary&lt;string,bool&gt; PingAround ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.Dictionary`2&lt;string, bool&gt; PingAround() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.Dictionary&lt;System.String,System.Boolean&gt;</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PingAround">
<MemberSignature Language="C#" Value="public System.Collections.Generic.Dictionary&lt;string,bool&gt; PingAround (string message);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.Dictionary`2&lt;string, bool&gt; PingAround(string message) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.Dictionary&lt;System.String,System.Boolean&gt;</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<param name="message">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</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>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.String" />
</Parameters>
<Docs>
<param name="id">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</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>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.String" />
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<param name="id">To be added.</param>
<param name="message">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Publish">
<MemberSignature Language="C#" Value="public void Publish (byte[] data);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Publish(unsigned int8[] data) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="data">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Publish">
<MemberSignature Language="C#" Value="public void Publish (string data);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Publish(string data) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.String" />
</Parameters>
<Docs>
<param name="data">To be added.</param>
<summary>To be added.</summary>
<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>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Specialized.NameValueCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</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>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="data">To be added.</param>
<summary>To be added.</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>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.String" />
</Parameters>
<Docs>
<param name="data">To be added.</param>
<summary>To be added.</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>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.String" />
<Parameter Name="data" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="id">To be added.</param>
<param name="data">To be added.</param>
<summary>To be added.</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>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.String" />
<Parameter Name="data" Type="System.String" />
</Parameters>
<Docs>
<param name="id">To be added.</param>
<param name="data">To be added.</param>
<summary>To be added.</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>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>WebSocketSharp.Server.SessionManager</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</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>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</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>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</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>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="code" Type="System.UInt16" />
<Parameter Name="reason" Type="System.String" />
</Parameters>
<Docs>
<param name="code">To be added.</param>
<param name="reason">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Stop">
<MemberSignature Language="C#" Value="public void Stop (WebSocketSharp.Frame.CloseStatusCode code, string reason);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Stop(valuetype WebSocketSharp.Frame.CloseStatusCode code, string reason) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.2.39341</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="code" Type="WebSocketSharp.Frame.CloseStatusCode" />
<Parameter Name="reason" Type="System.String" />
</Parameters>
<Docs>
<param name="code">To be added.</param>
<param name="reason">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>