socket_shutdownとは何？わかりやすく解説 Weblio辞書

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

socket_shutdown

(PHP 4 >= 4.0.7, PHP 5)
socket_shutdown — 受信、送信、または送受信用のソケットをシャットダウンする

説明

bool socket_shutdown ( resource socket [, int how] )
socket_shutdown() 関数は、socket から送られてくる受信、送信あるいはすべて（デフォルト）のデータを停止します。
how の値は以下のうちのひとつです。 表 290. how のとりうる値

`0`	ソケットの読み込みを停止します。
`1`	ソケットの書き込みを停止します。
`2`	ソケットの読み込み・書き込みを停止します。

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

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

Socket.Shutdown メソッド

Socket での送受信を無効にします。

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

Visual Basic (宣言)

Public Sub Shutdown ( _
    how As SocketShutdown _
)

Visual Basic (使用法)

Dim instance As Socket
Dim how As SocketShutdown

instance.Shutdown(how)

public void Shutdown (
    SocketShutdown how
)

C++

public:
void Shutdown (
    SocketShutdown how
)

public void Shutdown (
    SocketShutdown how
)

JScript

public function Shutdown (
    how : SocketShutdown
)

パラメータ

how: 許可されなくなる操作を指定する SocketShutdown 値の 1 つ。

例外

例外の種類	条件
SocketException	ソケットへのアクセスを試みているときにエラーが発生しました。詳細については「解説」を参照してください。
ObjectDisposedException	Socket は閉じられています。

解説

コネクション指向の Socket を使用している場合は、Socket を閉じる前に必ず Shutdown メソッドを呼び出します。これにより、閉じる前の接続ソケットですべてのデータが送受信されるようになります。

Close メソッドを呼び出して、Socket に関連付けられたすべてのマネージリソースとアンマネージリソースを解放します。閉じた後は Socket の再利用はできません。

how パラメータに有効な SocketShutdown 列挙値を次の表に示します。

値	説明
Send	この Socket での送信を無効にします。
Receive	この Socket での受信を無効にします。
Both	この Socket での送受信を無効にします。

how を Send に設定すると、後続の Send への呼び出しの禁止が指定されます。コネクションレスの Socket を使用している場合は、Send を指定しても無効です。

how を Receive に設定すると、後続の Receive への呼び出しの禁止が指定されます。下位のプロトコル層には影響を与えません。コネクション指向のプロトコルを使用している場合は、Shutdown を呼び出した後に次の条件のいずれかが存在すると、接続が終了します。

データが受信ネットワークバッファにあり受信待ちである。
他のデータが到達している。

コネクションレスのプロトコルを使用している場合、データグラムは受け入れられ、キューに置かれます。ただし、追加の受信データグラム用のバッファ領域がない場合は、そのデータグラムは破棄されます。このとき送信者側にはエラーが返されません。コネクションレスの Socket で Shutdown を使用することはお勧めできません。

how を Both に設定すると、上記のように送信および受信の両方が無効になります。

メモ
Shutdown メソッドを呼び出したときに SocketException が発生した場合は、SocketException.ErrorCode プロパティを使用して具体的なエラーコードを取得してください。このコードを取得したら、Windows Socket Version 2 API エラーコードのドキュメントでエラーの詳細情報を確認してください。これは MSDN ライブラリから入手できます。

メモ

Shutdown メソッドを呼び出したときに SocketException が発生した場合は、SocketException.ErrorCode プロパティを使用して具体的なエラーコードを取得してください。このコードを取得したら、Windows Socket Version 2 API エラーコードのドキュメントでエラーの詳細情報を確認してください。これは MSDN ライブラリから入手できます。

メモ
このメンバは、アプリケーションでネットワークトレースが有効にされている場合にトレース情報を出力します。詳細については、「ネットワークのトレース」を参照してください。

使用例

Shutdown を使用して Socket を無効にするコード例を次に示します。

Visual Basic

    aSocket.Shutdown(SocketShutdown.Both)
    aSocket.Close()

End Sub 'SocketClose

aSocket.Shutdown(SocketShutdown.Both);
aSocket.Close();

C++

aSocket->Shutdown( SocketShutdown::Both );
aSocket->Close();
if ( aSocket->Connected )
{
   Console::WriteLine( "Winsock error: {0}", Convert::ToString(
      System::Runtime::InteropServices::Marshal::GetLastWin32Error() ) );
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
Socket クラス
Socket メンバ
System.Net.Sockets 名前空間
Close
SocketShutdown

SocketShutdown 列挙体

Socket.Shutdown メソッドが使用する定数を定義します。

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

Visual Basic (宣言)

Public Enumeration SocketShutdown

Visual Basic (使用法)

Dim instance As SocketShutdown

public enum SocketShutdown

C++

public enum class SocketShutdown

public enum SocketShutdown

JScript

public enum SocketShutdown

メンバ

	メンバ名	説明
	Both	送信と受信の両方の Socket を無効にします。このフィールドは定数です。
	Receive	受信の Socket を無効にします。このフィールドは定数です。
	Send	送信の Socket を無効にします。このフィールドは定数です。