HttpListenerContext HttpListenerContext HttpListenerContext HttpListenerContext Class

定義

HttpListener クラスで使用される要求オブジェクトと応答オブジェクトへのアクセスを提供します。Provides access to the request and response objects used by the HttpListener class. このクラスは継承できません。This class cannot be inherited.

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

次のコード例では、クライアント要求のユーザー情報を表示します。The following code example displays the user information for a client request.

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

注釈

このクラスは、 HttpListenerオブジェクトによって処理されるクライアントのハイパーテキスト転送プロトコル (HTTP) 要求に関連する情報を提供します。This class provides the information related to a client's Hypertext Transfer Protocol (HTTP) request being processed by an HttpListener object. このクラスには、 HttpListenerオブジェクトが WebSocket 接続を受け入れることを許可するメソッドもあります。This class also has methods that allow an HttpListener object to accept a WebSocket connection.

メソッドGetContextは、 HttpListenerContextクラスのインスタンスを返します。The GetContext method returns instances of the HttpListenerContext class. クライアント要求を表すオブジェクトを取得するには、 Requestプロパティを使用します。To get the object that represents the client request, use the Request property. によってHttpListenerクライアントに送信される応答を表すオブジェクトを取得するには、 Responseプロパティを使用します。To get the object that represents the response that will be sent to the client by the HttpListener, use the Response property. 要求を送信するクライアントに関するユーザー情報 (ログイン名、認証されているかどうかなど) を取得するには、 IPrincipal Userプロパティによって返されたオブジェクトのプロパティに対してクエリを実行します。To get user information about the client sending the request, such as its login name and whether it has been authenticated, you can query the properties in the IPrincipal object returned by the User property.

オブジェクトを閉じると、クライアントに応答を送信し、によって使用HttpListenerContextされているすべてのリソースを解放します。 HttpListenerContextClosing an HttpListenerContext object sends the response to the client and frees any resources used by the HttpListenerContext. オブジェクトがまだ送信されていない場合は、クライアントへの応答を破棄し、にHttpListenerContextよって使用されているリソースを解放します。 HttpListenerContextAborting an HttpListenerContext object discards the response to the client if it has not already been sent, and frees any resources used by the HttpListenerContext. HttpListenerContextオブジェクトを閉じたり中止したりしても、そのメソッドまたはプロパティを参照することはできません。After closing or aborting an HttpListenerContext object, you cannot reference its methods or properties. そうすると、例外が発生ObjectDisposedExceptionします。If you do so, you will receive an ObjectDisposedException exception.

プロパティ

Request Request Request Request

クライアントのリソース要求を表す HttpListenerRequest を取得します。Gets the HttpListenerRequest that represents a client's request for a resource.

Response Response Response Response

クライアントの要求に応答してクライアントに送信される HttpListenerResponse オブジェクトを取得します。Gets the HttpListenerResponse object that will be sent to the client in response to the client's request.

User User User User

要求が HttpListenerContext オブジェクトによって表されるクライアントの ID、認証情報、セキュリティ ロールを取得するために使用するオブジェクトを取得します。Gets an object used to obtain identity, authentication information, and security roles for the client whose request is represented by this HttpListenerContext object.

メソッド

AcceptWebSocketAsync(String) AcceptWebSocketAsync(String) AcceptWebSocketAsync(String) AcceptWebSocketAsync(String)

WebSocket 接続を非同期操作として受け入れます。Accept a WebSocket connection as an asynchronous operation.

AcceptWebSocketAsync(String, Int32, TimeSpan) AcceptWebSocketAsync(String, Int32, TimeSpan) AcceptWebSocketAsync(String, Int32, TimeSpan) AcceptWebSocketAsync(String, Int32, TimeSpan)

サポートされている WebSocket サブプロトコル受信バッファー サイズと WebSocket のキープアライブ間隔を指定する WebSocket 接続を、非同期操作として受け入れます。Accept a WebSocket connection specifying the supported WebSocket sub-protocol, receive buffer size, and WebSocket keep-alive interval as an asynchronous operation.

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

サポートされている WebSocket サブプロトコル受信バッファー サイズ、WebSocket のキープアライブ間隔、内部バッファーを指定する WebSocket 接続を、非同期操作として受け入れます。Accept a WebSocket connection specifying the supported WebSocket sub-protocol, receive buffer size, WebSocket keep-alive interval, and the internal buffer as an asynchronous operation.

AcceptWebSocketAsync(String, TimeSpan) AcceptWebSocketAsync(String, TimeSpan) AcceptWebSocketAsync(String, TimeSpan) AcceptWebSocketAsync(String, TimeSpan)

サポートされている WebSocket サブプロトコルと WebSocket のキープアライブ間隔を指定する WebSocket 接続を、非同期操作として受け入れます。Accept a WebSocket connection specifying the supported WebSocket sub-protocol and WebSocket keep-alive interval as an asynchronous operation.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)

適用対象

こちらもご覧ください