WebSocketHandler Class

.NET Framework 4.5

Represents an instance that manages SignalR web sockets.

Inheritance Hierarchy


Namespace:  Microsoft.AspNet.SignalR.WebSockets
Assemblies:   Microsoft.AspNet.SignalR.Core (in Microsoft.AspNet.SignalR.Core.dll)
  Microsoft.AspNet.SignalR.Client (in Microsoft.AspNet.SignalR.Client.dll)


Public Class WebSocketHandler
Dim instance As WebSocketHandler
public class WebSocketHandler
public ref class WebSocketHandler
type WebSocketHandler =  class end
public class WebSocketHandler

The WebSocketHandler type exposes the following members.


  Name Description
Public method WebSocketHandler



  Name Description
Public property Error Gets or sets the error during handling the web socket.
Public property MaxIncomingMessageSize Gets the maximum incoming message size.



  Name Description
Public method CloseAsync
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method OnClose
Public method OnError Raises an event when an error occurred during handler operation.
Public method OnMessage(Byte[]) Raises an event when a message is received.
Public method OnMessage(String) Raises an event when a message is received.
Public method OnOpen Raises an event when this instance is opened.
Public method ProcessWebSocketRequestAsync Asynchronously processes the request received by the handler.
Public method Send Sends a message associated with the handler.
Public method ToString (Inherited from Object.)


Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also


Microsoft.AspNet.SignalR.WebSockets Namespace