HttpListener クラスとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

HttpListener クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

単純で、プログラムによって制御できる HTTP プロトコルリスナを提供します。このクラスは継承できません。

名前空間: System.Net
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public NotInheritable Class
 HttpListener
    Implements IDisposable

Visual Basic (使用法)

Dim instance As HttpListener

public sealed class HttpListener : IDisposable

C++

public ref class HttpListener sealed : IDisposable

public final class HttpListener implements
 IDisposable

JScript

public final class HttpListener implements
 IDisposable

解説

HttpListener クラスを使用して、HTTP 要求に応答する単純な HTTP プロトコルリスナを作成できます。このリスナは、HttpListener オブジェクトの有効期間中はアクティブで、アプリケーション内でアプリケーションのアクセス許可を使用して実行されます。

<img alt="メモ" src="https://cdn.weblio.jp/e7/img/dict/msdnc/http/http/httpcfg_exe.asp を参照してください。この実行可能ファイルは、Windows Server 2003 に付属しています。また、プラットフォーム SDK に用意されているソースコードからビルドすることもできます。

メモ
HttpListener に複数の認証方式を指定した場合、リスナは Negotiate、NTLM、Digest、Basic の順に認証方式を使用して、クライアントの認証を試みます。

Windows Server 2003 プラットフォームメモ : このクラスを使用するために必要です。

Windows XP Home Edition, Windows XP Professional x64 Edition, Windows Server 2003 プラットフォームメモ : このクラスを使用するには、Service Pack 2 以降が必要です。

使用例

HttpListener を使用するコード例を次に示します。

// This example requires the System and System.Net namespaces.
public static void SimpleListenerExample(string[]
 prefixes)
{
    if (!HttpListener.IsSupported)
    {
        Console.WriteLine ("Windows XP SP2 or Server 2003 is required to use
 the HttpListener class.");
        return;
    }
    // URI prefixes are required,
    // for example "http://contoso.com:8080/index/".
    if (prefixes == null || prefixes.Length
 == 0)
      throw new ArgumentException("prefixes");
    
    // Create a listener.
    HttpListener listener = new HttpListener();
    // Add the prefixes.
    foreach (string s in
 prefixes)
    {
        listener.Prefixes.Add(s);
    }
    listener.Start();
    Console.WriteLine("Listening...");
    // Note: The GetContext method blocks while waiting for a request.
 
    HttpListenerContext context = listener.GetContext();
    HttpListenerRequest request = context.Request;
    // Obtain a response object.
    HttpListenerResponse response = context.Response;
    // Construct a response.
    string responseString = "<HTML><BODY> Hello
 world!</BODY></HTML>";
    byte[] buffer = System.Text.Encoding.UTF8.GetBytes(responseString);
    // Get a response stream and write the response to it.
    response.ContentLength64 = buffer.Length;
    System.IO.Stream output = response.OutputStream;
    output.Write(buffer,0,buffer.Length);
    // You must close the output stream.
    output.Close();
    listener.Stop();
}