QUdpSocket で送信元ポートを取得する方法：peerPort() との違い【Qt】

2025-05-27

QAbstractSocket::peerPort()

QAbstractSocket クラス（およびそのサブクラスである QTcpSocket や QUdpSocket など）における peerPort() 関数は、接続されたリモートホストのポート番号を返すためのものです。

より具体的に説明すると以下のようになります。

利用場面
- サーバーアプリケーションで、接続してきたクライアントのポート番号をログに記録したり、特定のクライアントからの接続であることを識別したりする場合。
- クライアントアプリケーションで、接続先のサーバーがどのポートで応答しているかを確認する場合（通常は事前にわかっていることが多いですが、何らかの理由で確認が必要な場合など）。
- ネットワーク通信の状態を監視したり、デバッグしたりする際。
戻り値
quint16 型（符号なし16ビット整数）で、リモートホストのポート番号を返します。もしソケットが接続されていない場合や、ピアの情報がまだ利用できない場合は、通常は 0 を返します。
役割
確立されたソケット接続において、相手側（ピア）のアプリケーションが使用しているネットワークポートの番号を取得します。

ソケットが接続されていない状態で peerPort() を呼び出す

トラブルシューティング
- state() 関数でソケットの状態を確認し、QAbstractSocket::ConnectedState になってから peerPort() を呼び出すようにしてください。
- シグナル connected() が発行された後で peerPort() を呼び出すのが安全です（QTcpSocket の場合）。
- サーバー側では、newConnection() シグナルを受け取ったスロット内で、接続された QTcpSocket オブジェクトに対して peerPort() を呼び出すようにします。
現象
ソケットがまだ接続を確立していない状態（例えば、connectToHost() を呼び出した直後や、サーバーソケットでまだ接続を受け付けていない状態）で peerPort() を呼び出すと、通常は 0 が返ります。これはエラーではありませんが、期待するピアのポート番号が得られないため、混乱の原因となります。

UDPソケットの場合の注意点

トラブルシューティング
- UDP の場合は、受信したデータグラムと一緒に送信元の IP アドレスとポート番号が提供されるため、そちらの情報 (QHostAddress とポート番号) を利用するようにしてください。readDatagram() 関数の戻り値や引数から取得できます。
- 特定のピアと継続的に通信する場合は、必要に応じて送信先の情報を保持・管理する必要があります。
現象
QUdpSocket はコネクションレスなプロトコルであるため、「接続」という概念が TCP ソケットとは異なります。QUdpSocket で peerPort() を呼び出すと、最後に通信したピアのポート番号が返されることが多いですが、保証されるものではありません。

ネットワークの問題

トラブルシューティング
- ネットワーク接続の状態を確認してください（ping コマンドなどで疎通確認）。
- ファイアウォールの設定を確認し、必要なポートが開いているか確認してください。
- サーバーとクライアントの IP アドレスとポート番号の設定が正しいか確認してください。
現象
ファイアウォールやネットワーク設定の問題により、接続が確立しない場合があります。この場合、peerPort() を呼び出しても意味のある値は得られません。

タイミングの問題

トラブルシューティング
- 適切なシグナル（connected(), readyRead() など）のスロット内で処理を行うようにしてください。
- 必要に応じて、処理の順序を制御するために排他制御（mutex など）や状態管理を導入することを検討してください。
現象
非同期処理を行っている場合、peerPort() を呼び出すタイミングによっては、まだピアの情報が利用可能になっていないことがあります。

エラー処理の不足

トラブルシューティング
- error() シグナルを監視し、エラー発生時の処理を実装してください。
- connectToHost() の戻り値を確認し、接続が成功したか確認してください。
現象
ソケットの接続試行が失敗した場合など、エラーが発生した際に適切な処理を行っていないと、誤ったタイミングで peerPort() を呼び出してしまう可能性があります。

QAbstractSocket::peerPort() を使用する際は、以下の点に注意してトラブルシューティングを行うと良いでしょう。

エラー処理を適切に行う
接続失敗などのエラー発生時の処理を実装する。
非同期処理のタイミングを考慮する
適切なシグナルを利用して、ピアの情報が利用可能になったタイミングで peerPort() を呼び出す。
ネットワーク環境を確認する
ファイアウォールやネットワーク設定が通信を妨げていないか確認する。
UDP ソケットの特性を理解する
TCP とは異なる動作をする点に注意し、受信したデータグラムから送信元の情報を取得する。
ソケットの状態を常に意識する
接続が確立しているかを確認してから peerPort() を呼び出す。

例1: TCPサーバーで接続されたクライアントのポート番号を取得する

この例では、TCPサーバーがクライアントからの新しい接続を受け付けた際に、そのクライアントの IP アドレスとポート番号を取得してコンソールに出力します。

#include <QTcpServer>
#include <QTcpSocket>
#include <QDebug>
#include <QCoreApplication>

class MyServer : public QTcpServer
{
public:
    MyServer(QObject *parent = nullptr) : QTcpServer(parent) {}

protected:
    void incomingConnection(qintptr socketDescriptor) override
    {
        QTcpSocket *clientSocket = new QTcpSocket(this);
        clientSocket->setSocketDescriptor(socketDescriptor);
        connect(clientSocket, &QTcpSocket::disconnected, clientSocket, &QTcpSocket::deleteLater);
        connect(clientSocket, &QTcpSocket::readyRead, this, &MyServer::readClient);

        QHostAddress clientAddress = clientSocket->peerAddress();
        quint16 clientPort = clientSocket->peerPort();
        qDebug() << "新しいクライアントが接続しました: " << clientAddress.toString() << ":" << clientPort;
    }

private slots:
    void readClient()
    {
        QTcpSocket *clientSocket = qobject_cast<QTcpSocket*>(sender());
        if (clientSocket) {
            QByteArray data = clientSocket->readAll();
            qDebug() << "受信データ:" << data;
            clientSocket->write("サーバーからの応答");
            clientSocket->flush();
        }
    }
};

int main(int argc, char *argv[])
{
    QCoreApplication a(argc, argv);

    MyServer server;
    if (!server.listen(QHostAddress::Any, 12345)) {
        qDebug() << "サーバーの起動に失敗しました:" << server.errorString();
        return 1;
    }
    qDebug() << "TCPサーバーがポート 12345 で起動しました。";

    return a.exec();
}

解説

これらの情報は qDebug() でコンソールに出力されます。
clientSocket->peerAddress() でクライアントの IP アドレスを、clientSocket->peerPort() でクライアントのポート番号を取得しています。
incomingConnection() 内で、新しい QTcpSocket オブジェクトが作成され、接続されたソケットのファイル記述子が設定されます。
MyServer クラスは QTcpServer を継承し、新しい接続を受け付けるための incomingConnection() 関数をオーバーライドしています。

例2: TCPクライアントで接続先のサーバーのポート番号を確認する

この例では、TCPクライアントがサーバーに接続した後、接続先のサーバーのポート番号を取得してコンソールに出力します。

#include <QTcpSocket>
#include <QDebug>
#include <QCoreApplication>

int main(int argc, char *argv[])
{
    QCoreApplication a(argc, argv);

    QTcpSocket socket;
    socket.connectToHost("localhost", 12345); // サーバーのアドレスとポート

    if (socket.waitForConnected(5000)) {
        QHostAddress serverAddress = socket.peerAddress();
        quint16 serverPort = socket.peerPort();
        qDebug() << "サーバーに接続しました: " << serverAddress.toString() << ":" << serverPort;

        socket.write("クライアントからのメッセージ");
        socket.flush();
        socket.waitForBytesWritten();

        socket.disconnectFromHost();
        socket.waitForDisconnected();
    } else {
        qDebug() << "サーバーへの接続に失敗しました:" << socket.errorString();
    }

    return a.exec();
}

解説

これらの情報は qDebug() でコンソールに出力されます。
接続が成功した場合、socket.peerAddress() でサーバーの IP アドレスを、socket.peerPort() でサーバーのポート番号を取得しています。
waitForConnected() で接続が成功するまで待機します。
QTcpSocket オブジェクトを作成し、connectToHost() で指定されたホストとポートに接続を試みます。

例3: UDPソケットで最後に通信したピアのポート番号を取得する (注意点あり)

UDP はコネクションレスなプロトコルなので、peerPort() の挙動は TCP と異なります。この例では、UDP ソケットでデータを受信した後に、最後に通信したピアのポート番号を取得しています。ただし、これは最後に通信した相手の情報であり、特定の接続を表すものではないことに注意してください。

#include <QUdpSocket>
#include <QDebug>
#include <QCoreApplication>
#include <QNetworkDatagram>

class UdpReceiver : public QObject
{
    Q_OBJECT
public:
    UdpReceiver(QObject *parent = nullptr) : QObject(parent)
    {
        socket.bind(12346); // 受信ポート
        connect(&socket, &QUdpSocket::readyRead, this, &UdpReceiver::processPendingDatagrams);
    }

private slots:
    void processPendingDatagrams()
    {
        while (socket.hasPendingDatagrams()) {
            QNetworkDatagram datagram = socket.receiveDatagram();
            QByteArray data = datagram.data();
            QHostAddress senderAddress = datagram.senderAddress();
            quint16 senderPort = datagram.senderPort();

            qDebug() << "受信データ:" << data << " 送信元:" << senderAddress.toString() << ":" << senderPort;

            // QUdpSocket::peerAddress() と peerPort() は最後に通信した相手を返す
            qDebug() << "最後に通信したピア (peerAddress/peerPort):"
                     << socket.peerAddress().toString() << ":" << socket.peerPort();
        }
    }

private:
    QUdpSocket socket;
};

int main(int argc, char *argv[])
{
    QCoreApplication a(argc, argv);

    UdpReceiver receiver;
    qDebug() << "UDP レシーバーがポート 12346 で起動しました。";

    return a.exec();
}

#include "main.moc"

socket.peerAddress() と socket.peerPort() は、最後にデータグラムを送信してきたピアの情報を返します。UDP はコネクションレスなので、これは特定の接続を表すものではないことに注意が必要です。
processPendingDatagrams() スロットで受信したデータグラムの送信元アドレスとポート番号 (datagram.senderAddress(), datagram.senderPort()) を取得しています。
UdpReceiver クラスは QUdpSocket を使用して特定のポートでデータグラムをリッスンします。

UDPソケットでの送信元ポートの取得

QUdpSocket の場合、peerPort() は最後に通信したピアのポートを返しますが、これは必ずしも意図した送信元のポートとは限りません。UDP 通信では、受信したデータグラムから送信元の IP アドレスとポート番号を直接取得する方が一般的で信頼性があります。

void UdpReceiver::processPendingDatagrams()
{
    while (socket.hasPendingDatagrams()) {
        QNetworkDatagram datagram = socket.receiveDatagram();
        QHostAddress senderAddress = datagram.senderAddress();
        quint16 senderPort = datagram.senderPort();

        qDebug() << "受信データ:" << datagram.data()
                 << " 送信元:" << senderAddress.toString() << ":" << senderPort;

        // peerPort() の代替として、datagram.senderPort() を使用する
    }
}

この例では、QNetworkDatagram オブジェクトの senderPort() メソッドを使用して、データグラムの送信元のポート番号を正確に取得しています。

サーバー側での接続情報の管理

TCP サーバーアプリケーションでは、接続されたクライアントのソケットオブジェクトを管理する際に、そのピアのアドレスとポート番号を紐付けて保存することがあります。例えば、QMap や QHash を使用して、ソケットディスクリプタやソケットオブジェクトをキーとして、接続元の peerAddress() と peerPort() の情報を格納できます。

#include <QTcpServer>
#include <QTcpSocket>
#include <QDebug>
#include <QMap>

class MyServer : public QTcpServer
{
    Q_OBJECT
public:
    MyServer(QObject *parent = nullptr) : QTcpServer(parent) {}

private:
    QMap<QTcpSocket*, QPair<QHostAddress, quint16>> clientInfo;

protected:
    void incomingConnection(qintptr socketDescriptor) override
    {
        QTcpSocket *clientSocket = new QTcpSocket(this);
        clientSocket->setSocketDescriptor(socketDescriptor);
        connect(clientSocket, &QTcpSocket::disconnected, this, &MyServer::clientDisconnected);

        QHostAddress clientAddress = clientSocket->peerAddress();
        quint16 clientPort = clientSocket->peerPort();
        clientInfo.insert(clientSocket, qMakePair(clientAddress, clientPort));

        qDebug() << "新しいクライアントが接続しました: " << clientAddress.toString() << ":" << clientPort;
    }

private slots:
    void clientDisconnected()
    {
        QTcpSocket *clientSocket = qobject_cast<QTcpSocket*>(sender());
        if (clientSocket) {
            qDebug() << "クライアントが切断しました: " << clientInfo.value(clientSocket).first.toString()
                     << ":" << clientInfo.value(clientSocket).second;
            clientInfo.remove(clientSocket);
            clientSocket->deleteLater();
        }
    }
};

// ... (main 関数は省略)

#include "myserver.moc"

この例では、新しいクライアントが接続されるたびに、その peerAddress() と peerPort() を clientInfo マップに保存しています。クライアントが切断された際にも、保存された情報を使用してログを出力できます。

ネットワークプロトコル固有の情報

場合によっては、アプリケーションレベルのプロトコルでポート番号に関する情報がやり取りされることがあります。例えば、HTTP のリダイレクトレスポンスには、新しいサーバーのホスト名とポート番号が含まれることがあります。このような場合は、peerPort() を直接使用するのではなく、プロトコルの仕様に従って情報を解析する必要があります。

ソケットオプションの利用 (高度なケース)

QAbstractSocket::socketOption() や QAbstractSocket::setSocketOption() を使用して、ソケットレベルのオプションにアクセスしたり設定したりできますが、ピアのポート番号を直接取得する代替手段としては一般的ではありません。これらのオプションは、ソケットの振る舞いをより細かく制御するために使用されます。

外部設定ファイルや環境変数

アプリケーションによっては、接続先のホスト名やポート番号が設定ファイルや環境変数から読み込まれる場合があります。この場合、peerPort() を呼び出すまでもなく、これらの設定値を直接利用できます。ただし、これは実行時に動的にピアのポート番号を知る方法ではありません。

QAbstractSocket::peerPort() の代替となる方法は、主に以下の状況で検討されます。

アプリケーションレベルのプロトコルでポート情報が提供される場合
プロトコルの仕様に従って情報を解析する。
サーバー側で接続情報を管理する場合
接続時に peerAddress() と peerPort() を取得し、必要に応じて保存・管理する。
UDP 通信の場合
QNetworkDatagram::senderPort() を使用して、個々のデータグラムの送信元ポートを取得する。