socket_getsockname
(PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8)
socket_getsockname — 指定したソケットのローカル側に問い合わせ、その型に応じてホスト/ポート、あるいは Unix ファイルシステムのパスを返す
説明
注意: socket_getsockname() は、 socket_accept() で作成した
AF_UNIX
ソケットとともに使用することはできません。意味のある値が返されるのは、 socket_accept() で作成したソケットか socket_bind() に続くプライマリサーバーソケットのみです。
パラメータ
socket
-
socket_create() あるいは socket_accept() で作成した Socket クラスのインスタンス。
address
-
指定されたソケットの型が
AF_INET
あるいはAF_INET6
であった場合、socket_getsockname() はローカルの IP アドレス を適切な書式(例:127.0.0.1
あるいはfe80::1
)に したものをaddress
パラメータに、そしてもし オプションのport
パラメータが指定されていれば そこにポートを格納します。指定されたソケットの型が
AF_UNIX
であった場合、 socket_getpeername() は Unix ファイルシステムのパス (例:/var/run/daemon.sock
)をaddress
パラメータに格納します。 port
-
指定した場合は、関連付けるポートを保持します。
戻り値
成功した場合に true
を、失敗した場合に false
を返します。 socket_getsockname() は、
ソケットの型が AF_INET
、
AF_INET6
あるいは AF_UNIX
のいずれでもない場合にも false
を返します。この場合には、
直近のソケットエラーコードは更新されません。
変更履歴
バージョン | 説明 |
---|---|
8.0.0 |
socket は、Socket クラスのインスタンスになりました。
これより前のバージョンでは、リソース型でした。
|
参考
- socket_getpeername() - 指定したソケットのリモート側に問い合わせる
- socket_last_error() - ソケットの直近のエラーを返す
- socket_strerror() - ソケットエラーの内容を文字列として返す
User Contributed Notes 1 note
Curiously, getsockname() works for socket_create() and socket_create_pair() Unix-domain (AF_UNIX) sockets if one calls socket_bind() after creation to name the formerly anonymous socket(s).
Using a socket_bind() call also results in a file system "file" (socket, first character 's' in an "ls -l" listing) being created with the given name. Such a "file" will need to be removed explicitly, as closing the socket will not remove it.