C-DEngine 5.105

HttpServer Members

The HttpServer type exposes the following members.

Constructors


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

Methods


  Name Description
Public method AddWebSocketService<(Of <<'(TBehavior>)>>)(String, Func<(Of <<'(TBehavior>)>>))
Adds the 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 GetFile
Gets the contents of the file with the specified path.
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 HTTP requests.
Public method Stop()()()()
Stops receiving the HTTP requests.
Public method Stop(UInt16, String)
Stops receiving the HTTP requests with the specified UInt16 and String used to stop the WebSocket services.
Public method Stop(CloseStatusCode, String)
Stops receiving the HTTP requests with the specified CloseStatusCode and String used to stop the WebSocket services.
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 in the WebSocket services periodically.
Public property Log
Gets the logging functions.
Public property Port
Gets the port on which to listen for incoming 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 RootPath
Gets or sets the document root path of the server.
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.

Events


  Name Description
Public event OnConnect
Occurs when the server receives an HTTP CONNECT request.
Public event OnDelete
Occurs when the server receives an HTTP DELETE request.
Public event OnGet
Occurs when the server receives an HTTP GET request.
Public event OnHead
Occurs when the server receives an HTTP HEAD request.
Public event OnOptions
Occurs when the server receives an HTTP OPTIONS request.
Public event OnPatch
Occurs when the server receives an HTTP PATCH request.
Public event OnPost
Occurs when the server receives an HTTP POST request.
Public event OnPut
Occurs when the server receives an HTTP PUT request.
Public event OnTrace
Occurs when the server receives an HTTP TRACE request.