QNetworkInterface Class

メンバ関数のドキュメント

QNetworkInterface::QNetworkInterface()

空のネットワークインターフェースオブジェクトを生成します。

QNetworkInterface::QNetworkInterface(const QNetworkInterface &other)

other に含まれるQNetworkInterfaceオブジェクトのコピーを作成します。

[noexcept] QNetworkInterface::~QNetworkInterface()

QNetworkInterface オブジェクトに関連付けられたリソースを解放します。

QList<QNetworkAddressEntry> QNetworkInterface::addressEntries() const

このインターフェースが持つ IP アドレスの一覧と、それに関連付けられたネットマスクおよびブロードキャストアドレスを返します。

ネットマスクやブロードキャストアドレス、その他の情報が不要な場合は、allAddresses() 関数を呼び出すことで、アクティブなインターフェースの IP アドレスのみを取得できます。

[static] QList<QHostAddress> QNetworkInterface::allAddresses()

この便利関数は、ホストマシン上で検出されたすべてのIPアドレスを返します。これは、allInterfaces()によって返されたオブジェクトのうち、QNetworkInterface::IsUp 状態にあるものすべてに対してaddressEntries()を呼び出し、QNetworkAddressEntry オブジェクトのリストを取得した後、それらの各オブジェクトに対してQNetworkAddressEntry::ip()を呼び出すのと同じ効果があります。

[static] QList<QNetworkInterface> QNetworkInterface::allInterfaces()

ホストマシン上で検出されたすべてのネットワークインターフェースの一覧を返します。失敗した場合は、要素数が0のリストを返します。

QNetworkInterface::InterfaceFlags QNetworkInterface::flags() const

このネットワークインターフェースに関連付けられたフラグを返します。

QString QNetworkInterface::hardwareAddress() const

このインターフェースの低レベルハードウェアアドレスを返します。イーサネットインターフェースの場合、これはコロンで区切られた文字列形式のMACアドレスとなります。

その他のインターフェースタイプでは、異なる形式のハードウェアアドレスが返される場合があります。実装では、この関数が有効なMACアドレスを返すことを前提にしてはなりません。

type()も参照してください 。

QString QNetworkInterface::humanReadableName() const

Windows 上で、このネットワークインターフェイスの「人間が読みやすい名前」（「ローカルエリア接続」など）を、その名前を特定できた場合に返します。特定できなかった場合、この関数は `name()` と同じ値を返します。 人間が読みやすい名前とは、ユーザーが Windows のコントロールパネルで変更できる名前であるため、プログラムの実行中に変更される可能性があります。

Unix では、Unix システムは人間が読みやすい名前の設定を保存していないため、この関数は現在、常にname() と同じ値を返します。

int QNetworkInterface::index() const

インターフェースのシステムインデックスが判明している場合は、それを返します。これは、このインターフェースを識別するためにオペレーティングシステムによって割り当てられた整数であり、通常は変化しません。これは、IPv6アドレスのスコープIDフィールドと一致します。

インデックスが不明な場合、この関数は 0 を返します。

[static] QNetworkInterface QNetworkInterface::interfaceFromIndex(int index)

内部IDがindex であるインターフェースに対するQNetworkInterface オブジェクトを返します。ネットワークインターフェースには、システム上の他のインターフェースと区別するために「インターフェースインデックス」と呼ばれる一意の識別子があります。多くの場合、この値は連番で割り当てられ、一度削除されてから再度追加されたインターフェースには、その都度異なる値が割り当てられます。

このインデックスは、IPv6アドレスのスコープIDフィールドにも含まれています。

[static] QNetworkInterface QNetworkInterface::interfaceFromName(const QString &name)

name という名前のインターフェースに対するQNetworkInterface オブジェクトを返します。そのようなインターフェースが存在しない場合、この関数は無効なQNetworkInterface オブジェクトを返します。

文字列name は、実際のインターフェース名（「eth0」や「en1」など）か、文字列形式のインターフェースインデックス（「1」、「2」など）のいずれかです。

name() およびisValid()も参照してください 。

[static] int QNetworkInterface::interfaceIndexFromName(const QString &name)

name という名前のインターフェースのインデックスを返します。その名前のインターフェースが存在しない場合は 0 を返します。この関数は、以下のコードと同じ結果を生成するはずですが、おそらく実行速度は速いでしょう。

    QNetworkInterface::interfaceFromName(name).index()

interfaceFromName()、interfaceNameFromIndex()、およびQNetworkDatagram::interfaceIndex()も参照してください 。

[static] QString QNetworkInterface::interfaceNameFromIndex(int index)

インデックスが `index ` のインターフェース名を返します。そのインデックスを持つインターフェースが存在しない場合は、空の文字列を返します。この関数は、以下のコードと同じ結果を生成するはずですが、おそらく実行速度は速いでしょう。

    QNetworkInterface::interfaceFromIndex(index).name()

interfaceFromIndex()、interfaceIndexFromName()、およびQNetworkDatagram::interfaceIndex()も参照してください 。

bool QNetworkInterface::isValid() const

この `QNetworkInterface ` オブジェクトにネットワークインターフェースに関する有効な情報が含まれている場合、true を返します。

int QNetworkInterface::maximumTransmissionUnit() const

このインターフェースの最大伝送単位（MTU）がわかっている場合はそれを返し、そうでない場合は0を返します。

最大伝送単位（MTU）とは、リンクレベルでのフラグメンテーションを引き起こすことなく、このインターフェース上で送信可能な最大のパケットのことです。アプリケーションは、この値を使用して、フラグメンテーションされていないUDPデータグラムに収まるペイロードのサイズを計算することができます。 送信可能なペイロードのサイズを計算する際は、そのインターフェースを介した通信で使用されるヘッダーのサイズ（例：TCP（20バイト）やUDP（12バイト）、IPv4（20バイト）やIPv6（40バイト、何らかのヘッダー圧縮がない場合））を差し引くことを忘れないでください。 また、宛先までの全経路におけるMTU（パスMTU）は、インターフェースのMTUよりも小さい場合がある点にも注意してください。

QUdpSocketも参照してください 。

QString QNetworkInterface::name() const

このネットワークインターフェースの名前を返します。Unix システムでは、これはインターフェースの種類と、場合によっては連番を含む文字列（例：「eth0」、「lo」、「pcn0」など）となります。Windows では、ユーザーが変更できない内部 ID となります。

[noexcept] void QNetworkInterface::swap(QNetworkInterface &other)

このネットワークインターフェースのインスタンスを、other と入れ替えます。この操作は非常に高速で、失敗することはありません。

QNetworkInterface::InterfaceType QNetworkInterface::type() const

このインターフェースの型を特定できる場合は、その型を返します。特定できない場合、この関数はQNetworkInterface::Unknown を返します。

hardwareAddress()も参照してください 。

QNetworkInterface &QNetworkInterface::operator=(const QNetworkInterface &other)

other に含まれるQNetworkInterface オブジェクトの内容を、このオブジェクトにコピーします。