.NET API Documentation

HttpListener Class

Properties

• AuthenticationSchemes public System.Net.AuthenticationSchemes AuthenticationSchemes { get; set; }

  Gets or sets the authentication schemes that are supported by this listener.

• ClientCertificateAuthentication public System.Net.Security.AuthenticationSchemes ClientCertificateAuthentication { get; set; }

  Gets or sets the client certificate authentication settings used by the listener. This property is only relevant when using the Negotiate or Kerberos authentication schemes.

• IgnorePrefixWithFallback public bool IgnorePrefixWithFallback { get; set; }

  Gets or sets a value that indicates whether the listener should ignore specified URI prefixes and listen for all requests that are not handled by other HttpListener instances.

• IsListening public bool IsListening { get; }

  Gets a value that indicates whether the HttpListener is currently listening for incoming HTTP requests.

• Prefixes public System.Net.Http.HttpListenerPrefixCollection Prefixes { get; }

  Gets a collection of the URI prefixes that the HttpListener object listens for.

• SecurityPolicy public System.Net.Http.HttpListenerSecurityPolicy SecurityPolicy { get; set; }

  Gets or sets the security policy for the HttpListener.

• ServiceAccount public System.Net.Http.HttpListenerServiceAccount ServiceAccount { get; set; }

  Gets or sets the service account that the HttpListener uses when registering URI prefixes.

• SslConfiguration public System.Net.Security.SslConfiguration SslConfiguration { get; }

  Gets or sets the SSL configuration for the HttpListener.

Methods

• Close public void Close()

  Shuts down the HttpListener immediately. This is done by stopping the listener from receiving new requests and clearing the queue of waiting requests.

• GetContext public System.Net.Http.HttpListenerContext GetContext()

  Waits for an incoming request on the listener and returns a.

• GetContextAsync public System.Threading.Tasks.Task<System.Net.Http.HttpListenerContext> GetContextAsync()

  Asynchronously waits for an incoming request on the listener and returns a.

• OnPrefixChanged protected virtual void OnPrefixChanged()

  Raises the PrefixChanged event.

• Start public void Start()

  Starts the HttpListener, enabling it to accept incoming requests.

• Stop public void Stop()

  Stops the HttpListener from receiving incoming requests.

Events

• PrefixChanged public event System.EventHandler PrefixChanged

  Occurs when the collection of prefixes that the HttpListener is listening for changes.