HttpListener クラス
アセンブリ: System (system.dll 内)
構文Public NotInheritable Class HttpListener Implements IDisposable
public sealed class HttpListener : IDisposable
public final class HttpListener implements IDisposable
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 に用意されているソース コードからビルドすることもできます。 |
|---|
.gif)
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(); }
継承階層System.Net.HttpListener
スレッド セーフプラットフォームWindows 98, Windows Server 2003, Windows XP Media Center Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。
バージョン情報参照HttpListener コンストラクタ
アセンブリ: System (system.dll 内)
構文例外| 例外の種類 | 条件 |
|---|---|
PlatformNotSupportedException | このクラスは、現在のオペレーティング システムでは使用できません。このクラスのインスタンスを使用するには、Windows Server 2003 または Windows XP SP2 以降が必要です。 |
解説このコンストラクタから返されたインスタンスを使用する前に、その Start メソッドを呼び出す必要があります。
呼び出し時の注意 メモ : このメンバは、アプリケーションでネットワーク トレースが有効にされている場合にトレース情報を出力します。詳細については、「ネットワークのトレース」を参照してください。使用例HttpListener コンストラクタを使用して新しい HttpListener オブジェクトを作成するコード例を次に示します。詳細については、HttpListener クラスのトピックを参照してください。
プラットフォームWindows 98, Windows Server 2003, Windows XP Media Center Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。
バージョン情報参照HttpListener プロパティ
パブリック プロパティ| 名前 | 説明 | |
|---|---|---|
.gif) | Prefixes | この HttpListener オブジェクトによって処理される URI (Uniform Resource Identifier) プレフィックスを取得します。 |
| | Realm | この HttpListener オブジェクトに関連付けられているレルム (リソース パーティション) を取得または設定します。 |
| | UnsafeConnectionNtlmAuthentication | NTLM が使用されているときに、同じ TCP (Transmission Control Protocol) 接続を使用した別の要求を認証する必要があるかどうかを制御する Boolean 値を取得または設定します。 |
参照HttpListener メソッド
パブリック メソッド| 名前 | 説明 | |
|---|---|---|
.gif) | Abort | すぐに HttpListener オブジェクトをシャットダウンし、現在キューに置かれているすべての要求を破棄します。 |
| | BeginGetContext | 受信要求の非同期の取得を開始します。 |
| | Close | 現在キューに置かれているすべての要求を処理した後で HttpListener をシャットダウンします。 |
| | EndGetContext | 受信クライアント要求を取得する非同期操作を完了します。 |
| | Equals | オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。) |
| | GetContext | 受信要求を待機し、受信するとその要求を返します。 |
| | GetHashCode | 特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。) |
| | GetType | 現在のインスタンスの Type を取得します。 ( Object から継承されます。) |
.gif) | ReferenceEquals | 指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。) |
| | Start | このインスタンスが受信要求を受信できるようにします。 |
| | Stop | このインスタンスの受信要求の受信を停止します。 |
| | ToString | 現在の Object を表す String を返します。 ( Object から継承されます。) |
プロテクト メソッド| 名前 | 説明 | |
|---|---|---|
.gif) | Finalize | Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。) |
| | MemberwiseClone | 現在の Object の簡易コピーを作成します。 ( Object から継承されます。) |
明示的インターフェイスの実装参照HttpListener メンバ
単純で、プログラムによって制御できる HTTP プロトコル リスナを提供します。このクラスは継承できません。
HttpListener データ型で公開されるメンバを以下の表に示します。
パブリック コンストラクタパブリック プロパティ| 名前 | 説明 | |
|---|---|---|
| | Prefixes | この HttpListener オブジェクトによって処理される URI (Uniform Resource Identifier) プレフィックスを取得します。 |
| | Realm | この HttpListener オブジェクトに関連付けられているレルム (リソース パーティション) を取得または設定します。 |
| | UnsafeConnectionNtlmAuthentication | NTLM が使用されているときに、同じ TCP (Transmission Control Protocol) 接続を使用した別の要求を認証する必要があるかどうかを制御する Boolean 値を取得または設定します。 |
パブリック メソッド| 名前 | 説明 | |
|---|---|---|
| | Abort | すぐに HttpListener オブジェクトをシャットダウンし、現在キューに置かれているすべての要求を破棄します。 |
| | BeginGetContext | 受信要求の非同期の取得を開始します。 |
| | Close | 現在キューに置かれているすべての要求を処理した後で HttpListener をシャットダウンします。 |
| | EndGetContext | 受信クライアント要求を取得する非同期操作を完了します。 |
| | Equals | オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。) |
| | GetContext | 受信要求を待機し、受信するとその要求を返します。 |
| | GetHashCode | 特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。) |
| | GetType | 現在のインスタンスの Type を取得します。 (Object から継承されます。) |
| | ReferenceEquals | 指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。) |
| | Start | このインスタンスが受信要求を受信できるようにします。 |
| | Stop | このインスタンスの受信要求の受信を停止します。 |
| | ToString | 現在の Object を表す String を返します。 (Object から継承されます。) |
プロテクト メソッド| 名前 | 説明 | |
|---|---|---|
| | Finalize | Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。) |
| | MemberwiseClone | 現在の Object の簡易コピーを作成します。 (Object から継承されます。) |
明示的インターフェイスの実装参照- HttpListenerのページへのリンク
