WebSocketProtocol.xml

<Type Name="WebSocketProtocol" FullName="System.Net.WebSockets.WebSocketProtocol">
  <TypeSignature Language="C#" Value="public static class WebSocketProtocol" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit WebSocketProtocol extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.Net.WebSockets.WebSocketProtocol" />
  <TypeSignature Language="VB.NET" Value="Public Class WebSocketProtocol" />
  <TypeSignature Language="F#" Value="type WebSocketProtocol = class" />
  <TypeSignature Language="C++ CLI" Value="public ref class WebSocketProtocol abstract sealed" />
  <AssemblyInfo>
    <AssemblyName>System.Net.WebSockets.WebSocketProtocol</AssemblyName>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.1</AssemblyVersion>
    <AssemblyVersion>4.0.1.0</AssemblyVersion>
    <AssemblyVersion>4.0.2.0</AssemblyVersion>
    <AssemblyVersion>5.0.0.0</AssemblyVersion>
    <AssemblyVersion>6.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>The WebSocket class allows applications to send and receive data after the WebSocket upgrade has completed.</summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="CreateFromStream">
      <MemberSignature Language="C#" Value="public static System.Net.WebSockets.WebSocket CreateFromStream (System.IO.Stream stream, bool isServer, string? subProtocol, TimeSpan keepAliveInterval);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Net.WebSockets.WebSocket CreateFromStream(class System.IO.Stream stream, bool isServer, string subProtocol, valuetype System.TimeSpan keepAliveInterval) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Net.WebSockets.WebSocketProtocol.CreateFromStream(System.IO.Stream,System.Boolean,System.String,System.TimeSpan)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function CreateFromStream (stream As Stream, isServer As Boolean, subProtocol As String, keepAliveInterval As TimeSpan) As WebSocket" />
      <MemberSignature Language="F#" Value="static member CreateFromStream : System.IO.Stream * bool * string * TimeSpan -&gt; System.Net.WebSockets.WebSocket" Usage="System.Net.WebSockets.WebSocketProtocol.CreateFromStream (stream, isServer, subProtocol, keepAliveInterval)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; static System::Net::WebSockets::WebSocket ^ CreateFromStream(System::IO::Stream ^ stream, bool isServer, System::String ^ subProtocol, TimeSpan keepAliveInterval);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Net.WebSockets.WebSocketProtocol</AssemblyName>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Net.WebSockets.WebSocket</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="stream" Type="System.IO.Stream" />
        <Parameter Name="isServer" Type="System.Boolean" />
        <Parameter Name="subProtocol" Type="System.String" />
        <Parameter Name="keepAliveInterval" Type="System.TimeSpan" />
      </Parameters>
      <Docs>
        <param name="stream">The stream for the connection.</param>
        <param name="isServer">
          <see langword="true" /> to indicate it's the server-side of the connection; <see langword="false" /> if it's the client-side.</param>
        <param name="subProtocol">The agreed upon sub-protocol that was used when creating the connection.</param>
        <param name="keepAliveInterval">The keep-alive interval to use, or <see cref="F:System.Threading.Timeout.InfiniteTimeSpan" /> to disable keep-alives.</param>
        <summary>Creates a new WebSocket connection that operates on the specified stream.</summary>
        <returns>The new WebSocket connection.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>