HttpListener.Realm Property

Definition

Namespace:

System.Net

Assembly:

System.Net.HttpListener.dll

Source:

HttpListener.cs

Gets or sets the realm, or resource partition, associated with this HttpListener object.

public:
 property System::String ^ Realm { System::String ^ get(); void set(System::String ^ value); };

public string? Realm { get; set; }

member this.Realm : string with get, set

Public Property Realm As String

Property Value

String

A String value that contains the name of the realm associated with the HttpListener object.

Exceptions

ObjectDisposedException

This object has been closed.

Examples

The following code example demonstrates setting the Realm property.

public static void ConfigureListener1(HttpListener listener)
{
    // Specify an authentication realm.
    listener.Realm = "ExampleRealm";
}

Public Shared Sub ConfigureListener1(ByVal listener As HttpListener)
    ' Specify an authentication realm.
    listener.Realm = "ExampleRealm"
End Sub

Remarks

Servers use realms to partition protected resources; each partition can have its own authentication scheme and/or authorization database. Realms are used only for basic and digest authentication. After a client successfully authenticates, the authentication is valid for all resources in a given realm. For a detailed description of realms, see RFC 2617 at https://www.ietf.org/.

An instance of HttpListener has only one associated realm.