Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【PHP8.x】getservbyname()関数の使い方

getservbyname関数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

getservbyname関数は、指定されたサービス名とプロトコルに対応するポート番号とプロトコルに関する情報を取得する関数です。この関数は、/etc/servicesファイルまたは同等のシステムサービスデータベースを参照し、サービス名に基づいてポート番号やプロトコルなどの関連情報を検索します。

具体的には、第1引数にサービス名(例えば"http"、"ftp"など)を文字列で指定し、第2引数にプロトコル名(例えば"tcp"、"udp"など)を文字列で指定します。関数は、これらの引数に合致するサービス情報が見つかった場合、そのサービスに関する連想配列を返します。連想配列には、ポート番号(portキー)、プロトコル名(protoキー)、サービス名(nameキー)、エイリアス(aliasesキー、文字列の配列)などの情報が含まれます。

もし指定されたサービス名とプロトコルの組み合わせが見つからない場合、この関数はfalseを返します。この関数は、ネットワークプログラミングにおいて、サービス名から対応するポート番号を動的に取得する必要がある場合に役立ちます。例えば、特定のサービスに接続する際に、ポート番号をハードコードするのではなく、サービス名から解決することで、設定の柔軟性を高めることができます。また、セキュリティ上の理由から、特定のサービスがどのポートを使用しているかを確認する目的でも使用できます。

構文(syntax)

1getservbyname(string $service, string $protocol): int|false

引数(parameters)

string $service, string $protocol

  • string $service: サービス名(例: "ftp", "http")を指定する文字列
  • string $protocol: プロトコル名(例: "tcp", "udp")を指定する文字列

戻り値(return)

int|false

指定されたサービス名に対応するポート番号を整数で返します。サービスが見つからない場合はfalseを返します。

サンプルコード

PHPでサービス名からポート番号を取得する

1<?php
2
3/**
4 * 指定されたサービス名とプロトコルからポート番号を取得し、表示します。
5 *
6 * @param string $serviceName サービス名 (例: 'http', 'ftp')
7 * @param string $protocol プロトコル (例: 'tcp', 'udp')
8 * @return void
9 */
10function displayServicePort(string $serviceName, string $protocol): void
11{
12    // getservbyname() 関数を使用してサービス名からポート番号を取得します。
13    // 成功した場合はポート番号 (int)、失敗した場合は false を返します。
14    $portNumber = getservbyname($serviceName, $protocol);
15
16    if ($portNumber !== false) {
17        echo "サービス '{$serviceName}' ({$protocol}) のポート番号は: {$portNumber}\n";
18    } else {
19        echo "サービス '{$serviceName}' ({$protocol}) のポート番号を見つけることができませんでした。\n";
20    }
21}
22
23// サンプルとして、一般的なサービスとプロトコルでポート番号を取得します。
24displayServicePort('http', 'tcp');
25displayServicePort('ftp', 'tcp');
26displayServicePort('smtp', 'tcp');
27displayServicePort('unknown-service', 'tcp'); // 存在しないサービスの例
28
29?>

PHPのgetservbyname関数は、指定されたサービス名とプロトコルに対応するポート番号を取得するために使用します。この関数は、インターネット上でデータ通信を行う際に、特定のサービスがどの番号(ポート番号)を使って通信しているかを調べたい場合に役立ちます。

引数としては、最初に$serviceとしてサービス名(例: 'http', 'ftp')を文字列で渡します。次に$protocolとしてプロトコル名(例: 'tcp', 'udp')を文字列で渡します。これらの情報をもとに、getservbyname関数はシステムが認識しているポート番号のリストを検索します。

関数がポート番号を見つけることに成功した場合、そのポート番号を整数値(int)で返します。例えば、'http'と'tcp'を指定すれば、通常はポート番号の80が返されます。しかし、指定されたサービス名とプロトコルの組み合わせが見つからない場合は、falseを返します。

サンプルコードでは、displayServicePortという関数を定義し、その中でgetservbyname関数を呼び出しています。この関数は、'http'や'ftp'といった具体的なサービス名と'tcp'プロトコルを渡してポート番号を取得し、結果を表示しています。ポート番号が取得できた場合はその値を、取得できなかった(falseが返された)場合は「見つけることができませんでした」というメッセージを表示することで、エラー時の処理も適切に行われていることがわかります。このように、関数の戻り値がfalseであるかをチェックすることは、プログラムの安定性を保つ上で非常に重要です。

このサンプルコードでは、getservbyname関数の戻り値がintまたはfalseである点に注意が必要です。ポート番号は0である可能性もあるため、if ($portNumber !== false)のようにfalseと厳密に比較し、エラーを適切に処理することが重要です。

指定するサービス名とプロトコルは、実行環境のシステムに登録されている必要があります。登録されていない場合や、不正な組み合わせの場合はポート番号を取得できません。また、この関数が参照するサービス情報はシステム環境に依存するため、実行するサーバーによって結果が異なる場合があります。意図しない動作を防ぐため、常にエラーハンドリングを実装してください。

PHPでサービス名からポート番号を取得する

1<?php
2
3/**
4 * getservbyname() 関数を使用して、指定されたサービス名とプロトコル名に対応する
5 * ポート番号を取得し表示するPHPスクリプトです。
6 *
7 * この関数は、システムに登録されているサービス情報 (例: /etc/services ファイル) を検索し、
8 * サービス名とプロトコル名からポート番号を特定します。
9 * システムエンジニアを目指す方にとって、ネットワークサービスの基本を理解するのに役立ちます。
10 */
11
12// 検索したいサービス名とプロトコル名を定義します。
13// 例: "http" はウェブサービス (HTTP) を指し、"tcp" は伝送制御プロトコルです。
14$service_name = "http";
15$protocol_name = "tcp";
16
17// getservbyname() 関数を呼び出し、指定されたサービスとプロトコルに対応するポート番号を取得します。
18// 成功した場合、ポート番号 (整数) を返します。見つからない場合やエラーが発生した場合は false を返します。
19$port_number = getservbyname($service_name, $protocol_name);
20
21// 取得結果を確認し、ユーザーに分かりやすいメッセージを表示します。
22if ($port_number !== false) {
23    echo "サービス '{$service_name}' ({$protocol_name}) のポート番号は {$port_number} です。" . PHP_EOL;
24} else {
25    echo "エラー: サービス '{$service_name}' ({$protocol_name}) のポート番号を見つけられませんでした。" . PHP_EOL;
26    echo "指定されたサービス名やプロトコル名が正しいか、システムに登録されているか確認してください。" . PHP_EOL;
27}
28
29// 別の例: SSH (Secure Shell) サービスのポート番号を取得
30$service_name_ssh = "ssh";
31$protocol_name_ssh = "tcp";
32
33$port_number_ssh = getservbyname($service_name_ssh, $protocol_name_ssh);
34
35if ($port_number_ssh !== false) {
36    echo "サービス '{$service_name_ssh}' ({$protocol_name_ssh}) のポート番号は {$port_number_ssh} です。" . PHP_EOL;
37} else {
38    echo "エラー: サービス '{$service_name_ssh}' ({$protocol_name_ssh}) のポート番号を見つけられませんでした。" . PHP_EOL;
39}
40
41?>

このPHPサンプルコードは、getservbyname()関数を用いて、指定されたサービス名とプロトコル名に対応するポート番号を取得し表示する方法を示しています。getservbyname()関数は、システムに登録されているサービス情報(例えば、Linuxの/etc/servicesファイルなど)を検索し、サービス名とプロトコル名からポート番号を特定します。

この関数は、一つ目に検索したいサービス名(文字列型)、二つ目に使用するプロトコル名(文字列型)の二つの引数を取ります。例えば、「http」サービスと「tcp」プロトコルの組み合わせを指定することで、ウェブサービスが一般的に使用するポート番号を取得できます。

getservbyname()関数が正常にポート番号を見つけられた場合、そのポート番号を整数値として返します。しかし、指定されたサービス名とプロトコルの組み合わせがシステム上で見つからなかったり、その他のエラーが発生した場合には、falseを返します。サンプルコードでは、httpとtcp、そしてsshとtcpの組み合わせでポート番号を取得する例が示されており、取得結果に応じて成功メッセージまたはエラーメッセージを表示しています。この関数は、プログラム内で特定のネットワークサービスのポート番号を動的に取得したい場合に利用でき、システムエンジニアがネットワークサービスの基本的な仕組みを理解する上で役立ちます。

getservbyname関数は、指定されたサービス名とプロトコル名に対応するポート番号を取得しますが、その結果はPHPスクリプトが実行されるオペレーティングシステムに依存します。そのため、開発環境と本番環境で異なる結果になる可能性がある点に注意が必要です。

この関数は、ポート番号が見つからない場合やエラーが発生した場合にfalseを返します。取得したポート番号は0番も有効な場合があるため、戻り値の確認はif ($port_number !== false)のように厳密な比較で行うことが重要です。単にif ($port_number)とすると、0番ポートが正しく取得された場合でもエラーと判断されてしまう可能性があります。サービス名やプロトコル名がシステムに正しく登録されているか、タイプミスがないかを確認することも大切です。

関連コンテンツ

関連IT用語

関連プログラミング言語