HttpListenerContext クラス

定義

HttpListener クラスで使用される要求オブジェクトと応答オブジェクトへのアクセスを提供します。 このクラスは継承できません。

public ref class HttpListenerContext sealed
public sealed class HttpListenerContext
type HttpListenerContext = class
Public NotInheritable Class HttpListenerContext
継承
HttpListenerContext

次のコード例では、クライアント要求のユーザー情報を表示します。

public static string ClientInformation(HttpListenerContext context)
{
    System.Security.Principal.IPrincipal user = context.User;
    System.Security.Principal.IIdentity id = user.Identity;
    if (id == null)
    {
        return "Client authentication is not enabled for this Web server.";
    }

    string display;
    if (id.IsAuthenticated)
    {
        display = String.Format("{0} was authenticated using {1}", id.Name,
            id.AuthenticationType);
    }
    else
    {
       display = String.Format("{0} was not authenticated", id.Name);
    }
    return display;
}
Public Shared Function ClientInformation(ByVal context As HttpListenerContext) As String
    Dim user As System.Security.Principal.IPrincipal = context.User
    Dim id As System.Security.Principal.IIdentity = user.Identity

    If id Is Nothing Then
        Return "Client authentication is not enabled for this Web server."
    End If

    Dim display As String

    If id.IsAuthenticated Then
        display = String.Format("{0} was authenticated using {1}", id.Name, id.AuthenticationType)
    Else
        display = String.Format("{0} was not authenticated", id.Name)
    End If

    Return display
End Function

注釈

このクラスは、オブジェクトによって処理されるクライアントのハイパーテキスト転送プロトコル (HTTP) 要求に関連する情報を HttpListener 提供します。 このクラスには、オブジェクトが WebSocket 接続を HttpListener 受け入れられるメソッドもあります。

メソッドは GetContext 、 クラスのインスタンスを HttpListenerContext 返します。 クライアント要求を表す オブジェクトを取得するには、 プロパティを Request 使用します。 によって HttpListenerクライアントに送信される応答を表す オブジェクトを取得するには、 プロパティを Response 使用します。 ログイン名や認証されているかどうかなど、要求を送信するクライアントに関するユーザー情報を取得するには、 プロパティによって返されるオブジェクトの IPrincipal プロパティに対してクエリを User 実行します。

オブジェクトを HttpListenerContext 閉じると、応答がクライアントに送信され、 によって使用されるすべてのリソースが解放されます HttpListenerContext。 オブジェクトを HttpListenerContext 中止すると、クライアントに対する応答がまだ送信されていない場合は破棄され、 によって使用されるすべてのリソースが HttpListenerContext解放されます。 オブジェクトを HttpListenerContext 閉じたり中止したりすると、そのメソッドまたはプロパティを参照することはできません。 この操作を行うと、例外が ObjectDisposedException 発生します。

プロパティ

Request

クライアントのリソース要求を表す HttpListenerRequest を取得します。

Response

クライアントの要求に応答してクライアントに送信される HttpListenerResponse オブジェクトを取得します。

User

要求が HttpListenerContext オブジェクトによって表されるクライアントの ID、認証情報、セキュリティ ロールを取得するために使用するオブジェクトを取得します。

メソッド

AcceptWebSocketAsync(String)

WebSocket 接続を非同期操作として受け入れます。

AcceptWebSocketAsync(String, Int32, TimeSpan)

サポートされている WebSocket サブプロトコル受信バッファー サイズと WebSocket のキープアライブ間隔を指定する WebSocket 接続を、非同期操作として受け入れます。

AcceptWebSocketAsync(String, Int32, TimeSpan, ArraySegment<Byte>)

サポートされている WebSocket サブプロトコル受信バッファー サイズ、WebSocket のキープアライブ間隔、内部バッファーを指定する WebSocket 接続を、非同期操作として受け入れます。

AcceptWebSocketAsync(String, TimeSpan)

サポートされている WebSocket サブプロトコルと WebSocket キープアライブ間隔を非同期操作として指定する WebSocket 接続を受け入れます。

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
MemberwiseClone()

現在の Object の簡易コピーを作成します。

(継承元 Object)
ToString()

現在のオブジェクトを表す文字列を返します。

(継承元 Object)

適用対象

こちらもご覧ください