17.2.1 socket オブジェクト

ソケットオブジェクトは以下のメソッドを持ちます。makefile()以外のメソッドは、Unixのソケット用システムコールに対応しています。

accept( ): 接続を受け付けます。ソケットはアドレスにbind済みで、listen中である必要があります。戻り値は(conn, address)のペアで、conn は接続を通じてデータの送受信を行うための新しいソケットオブジェクト、addressは接続先でソケットにbindしているアドレスを示します。

bind( address): ソケットをaddressにbindします。bind済みのソケットを再バインドする事はできません。addressのフォーマットはアドレスファミリによって異なります(前述)。 注意: 本来、このメソッドは単一のタプルのみを引数として受け付けますが、以前はAF_INETアドレスを示す二つの値を指定する事ができました。これは本来の仕様ではなく、Python 2.0以降では使用することはできません。

close( ): ソケットをクローズします。以降、このソケットでは全ての操作が失敗します。リモート端点ではキューに溜まったデータがフラッシュされた後はそれ以上のデータを受信しません。ソケットはガベージコレクション時に自動的にクローズされます。

connect( address): addressで示されるリモートソケットに接続します。addressのフォーマットはアドレスファミリによって異なります(前述)。 注意: 本来、このメソッドは単一のタプルのみを引数として受け付けますが、以前はAF_INETアドレスを示す二つの値を指定する事ができました。これは本来の仕様ではなく、Python 2.0以降では使用することはできません。

connect_ex( address): connect(address)と同様ですが、C言語のconnect() 関数の呼び出しでエラーが発生した場合には例外を送出せずにエラーを戻り値として返します。(これ以外の、``host not found,''等のエラーの場合には例外が発生します。)処理が正常に終了した場合には0を返し、エラー時には errnoの値を返します。この関数は、非同期接続をサポートする場合などに使用することができます。 注意: 本来、このメソッドは単一のタプルのみを引数として受け付けますが、以前はAF_INETアドレスを示す二つの値を指定する事ができました。これは本来の仕様ではなく、Python 2.0以降では使用することはできません。

fileno( ): ソケットのファイルディスクリプタを整数型で返します。ファイルディスクリプタは、select.select()などで使用します。
Windowsではこのメソッドで返された小整数をファイルディスクリプタを扱う箇所(os.fdopen()など)で利用できません。 Unix にはこの制限はありません。

getpeername( ): ソケットが接続しているリモートアドレスを返します。この関数は、リモート IPv4/v6ソケットのポート番号を調べる場合などに使用します。addressのフォーマットはアドレスファミリによって異なります(前述)。この関数をサポートしていないシステムも存在します。

getsockname( ): ソケット自身のアドレスを返します。この関数は、IPv4/v6ソケットのポート番号を調べる場合などに使用します。addressのフォーマットはアドレスファミリによって異なります(前述)。

getsockopt( level, optname[, buflen]): ソケットに指定されたオプションを返します(Unixのマニュアルページ getsockopt(2)を参照)。SO_*等のシンボルは、このモジュールで定義しています。buflenを省略した場合、取得するオブションは整数とみなし、整数型の値を戻り値とします。buflenを指定した場合、長さbuflenのバッファでオプションを受け取り、このバッファを文字列として返します。このバッファは、呼び出し元プログラムでstruct モジュール等を利用して内容を読み取ることができます。

listen( backlog): ソケットをListenし、接続を待ちます。引数backlogには接続キューの最大の長さ(1以上)を指定します。backlogの最大数はシステムに依存します (通常は5)。

makefile( [mode[, bufsize]]): ソケットに関連付けられたファイルオブジェクトを返します(ファイルオブジェクトについては3.9の``ファイルオブジェクト''を参照)。ファイルオブジェクトはソケットをdup()したファイルディスクリプタを使用しており、ソケットオブジェクトとファイルオブジェクトは別々にクローズしたりガベージコレクションで破棄したりする事ができます。ソケットはブロッキングモードでなければなりません。オプション引数のmodeとbufsize には、file()組み込み関数と同じ値を指定します。 2.1の``組み込み関数''を参照してください。

recv( bufsize[, flags]): ソケットからデータを受信し、文字列として返します。受信する最大バイト数は、bufsizeで指定します。flagsのデフォルト値は0です。値の意味についてはUnixマニュアルページのrecv(2)を参照してください。 注意: ハードウェアおよびネットワークの現実に最大限マッチするように、 bufsizeの値は比較的小さい2の累乗、たとえば 4096、にすべきです。

recvfrom( bufsize[, flags]): ソケットからデータを受信し、結果をタプル(string, address)として返します。stringは受信データの文字列で、 addressは送信元のアドレスを示します。オプション引数flagsの意味は、上記recv()と同じです。addressのフォーマットはアドレスファミリによって異なります(前述)。

send( string[, flags]): ソケットにデータを送信します。ソケットはリモートソケットに接続済みでなければなりません。オプション引数flagsの意味は、上記recv()と同じです。戻り値として、送信したバイト数を返します。アプリケーションでは、必ず戻り値をチェックし、全てのデータが送られた事を確認する必要があります。データの一部だけが送信された場合、アプリケーションで残りのデータを再送信してください。

sendall( string[, flags]): ソケットにデータを送信します。ソケットはリモートソケットに接続済みでなければなりません。オプション引数flagsの意味は、上記recv()と同じです。send()と異なり、このメソッドはstringの全データを送信するか、エラーが発生するまで処理を継続します。正常終了の場合は Noneを返し、エラー発生時には例外が発生します。エラー発生時、送信されたバイト数を調べる事はできません。

sendto( string[, flags], address): ソケットにデータを送信します。このメソッドでは接続先をaddressで指定するので、接続済みではいけません。オプション引数flagsの意味は、上記recv()と同じです。戻り値として、送信したバイト数を返します。addressのフォーマットはアドレスファミリによって異なります(前述)。

setblocking( flag): ソケットのブロッキング・非ブロッキングモードを指定します。flagが0 の場合は非ブロッキングモード、0以外の場合はブロッキングモードとなります。全てのソケットは、初期状態ではブロッキングモードです。非ブロッキングモードでは、recv()メソッド呼び出し時に読み込みデータが無かったりsend()メソッド呼び出し時にデータを処理する事ができないような場合にerror例外が発生します。しかし、ブロッキングモードでは呼び出しは処理が行われるまでブロックされます。s.setblocking(0)は s.settimeout(0)と、s.setblocking(1)は s.settimeout(None)とそれぞれ同じ意味を持ちます。

settimeout( value): ソケットのブロッキング処理のタイムアウト値を指定します。valueには、正の浮動小数点で秒数を指定するか、もしくはNoneを指定します。浮動小数点値を指定した場合、操作が完了する前にvalueで指定した秒数が経過するとtimeoutが発生します。タイムアウト値にNoneを指定すると、ソケットのタイムアウトを無効にします。 s.settimeout(0.0)はs.setblocking(0)と、 s.settimeout(None)はs.setblocking(1)とそれぞれ同じ意味を持ちます。バージョン 2.3 で新たに追加された仕様です。

gettimeout( ): ソケットに指定されたタイムアウト値を取得します。タイムアウト値が設定されている場合には浮動小数点型で秒数が、設定されていなければNoneが返ります。この値は、最後に呼び出されたsetblocking()または settimeout()によって設定されます。バージョン 2.3 で新たに追加された仕様です。

ソケットのブロッキングとタイムアウトについて:ソケットオブジェクトのモードは、ブロッキング・非ブロッキング・タイムアウトの何れかとなります。初期状態では常にブロッキングモードです。ブロッキングモードでは、処理が完了するまでブロックされます。非ブロッキングモードでは、処理を行う事ができなければ(不幸にもシステムによって異なる値の)エラーとなります。タイムアウトモードでは、ソケットに指定したタイムアウトまでに完了しなければ処理は失敗となります。setblocking()メソッドは、settimeout()の省略形式です。

内部的には、タイムアウトモードではソケットを非ブロッキングモードに設定します。ブロッキングとタイムアウトの設定は、ソケットと同じネットワーク端点へ接続するファイルディスクリプタにも反映されます。この結果、 makefile()で作成したファイルオブジェクトはブロッキングモードでのみ使用することができます。これは非ブロッキングモードとタイムアウトモードでは、即座に完了しないファイル操作はエラーとなるためです。

註: connect()はタイムアウト設定に従います。一般的に、 settimeout()をconnect()の前に呼ぶことをおすすめします。

setsockopt( level, optname, value): ソケットのオプションを設定します(Unixのマニュアルページ setsockopt(2)を参照)。SO_*等のシンボルは、このモジュールで定義しています。valueには、整数または文字列をバッファとして指定する事ができます。文字列を指定する場合、文字列には適切なビットを設定するようにします。(structモジュールを利用すれば、Cの構造体を文字列にエンコードする事ができます。)

shutdown( how): 接続の片方向、または両方向を切断します。howがSHUT_RDの場合、以降は受信を行えません。howがSHUT_WRの場合、以降は送信を行えません。 howがSHUT_RDWRの場合、以降は送受信を行えません。

read()メソッドとwrite()メソッドは存在しませんので注意してください。代わりにflagsを省略したrecv()と send()を使うことができます。

ソケットオブジェクトには以下の socket コンストラクタに渡された値に対応した(読み出し専用)属性があります。

family: ソケットファミリー。バージョン 2.5 で新たに追加された仕様です。

type: ソケットタイプ。バージョン 2.5 で新たに追加された仕様です。

proto: ソケットプロトコル。バージョン 2.5 で新たに追加された仕様です。

ご意見やご指摘をお寄せになりたい方は、 このドキュメントについて... をご覧ください。