C-DEngine 5.105

WebSocketServer Members

The WebSocketServer type exposes the following members.

Constructors


  Name Description
Public method WebSocketServer()()()()
Initializes a new instance of the WebSocketServer class.
Public method WebSocketServer(Int32)
Initializes a new instance of the WebSocketServer class with the specified port.
Public method WebSocketServer(String)
Initializes a new instance of the WebSocketServer class with the specified WebSocket URL.
Public method WebSocketServer(Int32, Boolean)
Initializes a new instance of the WebSocketServer class with the specified port and secure.
Public method WebSocketServer(IPAddress, Int32)
Initializes a new instance of the WebSocketServer class with the specified address and port.
Public method WebSocketServer(IPAddress, Int32, Boolean)
Initializes a new instance of the WebSocketServer class with the specified address, port, and secure.

Methods


  Name Description
Public method AddWebSocketService<(Of <<'(TBehavior>)>>)(String, Func<(Of <<'(TBehavior>)>>))
Adds a WebSocket service with the specified behavior, path, and initializer.
Public method AddWebSocketService<(Of <<'(TBehaviorWithNew>)>>)(String)
Adds a WebSocket service with the specified behavior and path.
Public method Equals(System.Object) (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 RemoveWebSocketService
Removes the WebSocket service with the specified path.
Public method Start
Starts receiving the WebSocket connection requests.
Public method Stop()()()()
Stops receiving the WebSocket connection requests.
Public method Stop(UInt16, String)
Stops receiving the WebSocket connection requests with the specified UInt16 and String.
Public method Stop(CloseStatusCode, String)
Stops receiving the WebSocket connection requests with the specified CloseStatusCode and String.
Public method ToString (Inherited from Object.)

Properties


  Name Description
Public property Address
Gets the local IP address of the server.
Public property AuthenticationSchemes
Gets or sets the scheme used to authenticate the clients.
Public property IsListening
Gets a value indicating whether the server has started.
Public property IsSecure
Gets a value indicating whether the server provides a secure connection.
Public property KeepClean
Gets or sets a value indicating whether the server cleans up the inactive sessions periodically.
Public property Log
Gets the logging functions.
Public property Port
Gets the port on which to listen for incoming connection requests.
Public property Realm
Gets or sets the name of the realm associated with the server.
Public property ReuseAddress
Gets or sets a value indicating whether the server is allowed to be bound to an address that is already in use.
Public property SslConfiguration
Gets or sets the SSL configuration used to authenticate the server and optionally the client for secure connection.
Public property UserCredentialsFinder
Gets or sets the delegate called to find the credentials for an identity used to authenticate a client.
Public property WaitTime
Gets or sets the wait time for the response to the WebSocket Ping or Close.
Public property WebSocketServices
Gets the access to the WebSocket services provided by the server.