QCoapClient Class

QCoapClient *client = new QCoapClient(this);
connect(client, &QCoapClient::finished, this, &TestClass::slotFinished);
client->get(QCoapRequest(Qurl("coap://coap.me/test")));

QCoapRequest request = QCoapRequest(Qurl("coap://coap.me/obs"));
QCoapReply *reply = client->observe(request);
connect(reply, &QCoapReply::notified, this, &TestClass::slotNotified);

client->cancelObserve(reply);

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

[explicit] QCoapClient::QCoapClient(QtCoap::SecurityMode securityMode = QtCoap::SecurityMode::NoSecurity, QObject *parent = nullptr)

指定されたsecurityMode に対応するQCoapClientオブジェクトを構築し、parent を親オブジェクトとして設定します。

securityMode のデフォルト値はQtCoap::NoSecurity であり、これによりセキュリティが無効化されます。

[virtual noexcept] QCoapClient::~QCoapClient()

QCoapClient オブジェクトを破棄し、関連するリソースを解放します。なお、このクラスから返されるQCoapReply オブジェクトには、QCoapClient が親として設定されているため、このオブジェクトが削除されると、それとともに オブジェクトも削除されることに注意してください。

void QCoapClient::cancelObserve(QCoapReply *notifiedReply)

observe() メソッドによって返される応答「notifiedReply 」を使用して、リソースの監視を解除します。

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

void QCoapClient::cancelObserve(const QUrl &url)

url で指定されたリソースの監視を解除します。

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

QCoapReply *QCoapClient::deleteResource(const QCoapRequest &request)

DELETEメソッドを使用してrequest を送信し、新しいQCoapReply オブジェクトを返します。

get()、put()、post()、observe()、およびdiscover()も参照してください 。

QCoapReply *QCoapClient::deleteResource(const QUrl &url)

対象のurl に対して DELETE リクエストを送信します。

get()、put()、post()、observe()、およびdiscover()も参照してください 。

void QCoapClient::disconnect()

開いているソケットと接続を閉じ、トランスポートを解放します。

関連項目： setSecurityConfiguration()。

QCoapResourceDiscoveryReply *QCoapClient::discover(const QUrl &url, const QString &discoveryPath = QLatin1String("/.well-known/core"))

指定されたurl で利用可能なリソースを検出し、レスポンスが届くたびにQCoapResourceDiscoveryReply::discovered() シグナルを発行する新しいQCoapResourceDiscoveryReply オブジェクトを返します。

検出パスはデフォルトで「/.well-known/core」ですが、discoveryPath に別のパスを指定することで変更できます。検出に関する仕様はRFC 6690 に記載されています。

get()、post()、put()、deleteResource()、およびobserve()も参照してください 。

QCoapResourceDiscoveryReply *QCoapClient::discover(QtCoap::MulticastGroup group = QtCoap::MulticastGroup::AllCoapNodesIPv4, int port = QtCoap::DefaultPort, const QString &discoveryPath = QLatin1String("/.well-known/core"))

指定されたport でgroup に参加しているエンドポイントで利用可能なリソースを検出します。レスポンスが届くたびにQCoapResourceDiscoveryReply::discovered()シグナルを発行する新しいQCoapResourceDiscoveryReply オブジェクトを返します。group はCoAPマルチキャストグループアドレスの1つであり、デフォルトはQtCoap::AllCoapNodesIPv4 です。

ディスカバリパスはデフォルトで「/.well-known/core」ですが、discoveryPath に別のパスを渡すことで変更できます。ディスカバリについてはRFC 6690で規定されています。

get()、post()、put()、deleteResource()、およびobserve()も参照してください 。

[signal] void QCoapClient::error(QCoapReply *reply, QtCoap::Error error)

このシグナルは、エラーが発生するたびに発信されます。エラーが特定のQCoapReply に関連していない場合、reply パラメータにはnullptr を指定できます。error パラメータにはエラーコードが含まれます。

finished()、QCoapReply::error()、およびQCoapReply::finished()も参照してください 。

[signal] void QCoapClient::finished(QCoapReply *reply)

このシグナルは、CoAPの応答が受信された際（成功時またはエラー時を問わず）、QCoapReply::finished() シグナルとともに発火します。reply パラメータには、受信されたばかりの応答へのポインタが格納されます。

error()、QCoapReply::finished()、およびQCoapReply::error()も参照してください 。

QCoapReply *QCoapClient::get(const QCoapRequest &request)

GETメソッドを使用してrequest を送信し、新しいQCoapReply オブジェクトを返します。

post()、put()、deleteResource()、observe()、およびdiscover()も参照してください 。

QCoapReply *QCoapClient::get(const QUrl &url)

url に対して GET リクエストを送信し、新しいQCoapReply オブジェクトを返します。

post()、put()、deleteResource()、observe()、およびdiscover()も参照してください 。

QCoapReply *QCoapClient::observe(const QCoapRequest &request)

ターゲットrequest を監視するリクエストを送信し、新しい通知が届くたびにQCoapReply::notified() シグナルを発行する新しいQCoapReply オブジェクトを返します。

cancelObserve()、get()、post()、put()、deleteResource()、およびdiscover()も参照してください 。

QCoapReply *QCoapClient::observe(const QUrl &url)

ターゲットのurl を監視するリクエストを送信し、新しい通知が届くたびにQCoapReply::notified()シグナルを発火する新しいQCoapReply オブジェクトを返します。

cancelObserve()、get()、post()、put()、deleteResource()、およびdiscover()も参照してください 。

QCoapReply *QCoapClient::post(const QCoapRequest &request, const QByteArray &data = QByteArray())

POSTメソッドを使用してrequest を送信し、新しいQCoapReply オブジェクトを返します。このリクエストのペイロードとしてdata を使用します。data が空の場合、request のペイロードが使用されます。

get()、put()、deleteResource()、observe()、およびdiscover()も参照してください 。

QCoapReply *QCoapClient::post(const QCoapRequest &request, QIODevice *device)

POSTメソッドを使用してrequest を送信し、新しいQCoapReply オブジェクトを返します。このリクエストのペイロードとして、device のコンテンツを使用します。nullのデバイスは空のコンテンツとして扱われ、その場合はrequest のペイロードが使用されます。

関連項目： get()、put()、deleteResource()、observe()、およびdiscover()。

QCoapReply *QCoapClient::post(const QUrl &url, const QByteArray &data = QByteArray())

url に対して POST リクエストを送信し、新しいQCoapReply オブジェクトを返します。このリクエストのペイロードとしてdata を使用します。

get()、put()、deleteResource()、observe()、およびdiscover()も参照してください 。

QCoapReply *QCoapClient::put(const QCoapRequest &request, const QByteArray &data = QByteArray())

PUTメソッドを使用してrequest を送信し、新しいQCoapReply オブジェクトを返します。このリクエストのペイロードとしてdata を使用します。data が空の場合、request のペイロードが使用されます。

get()、post()、deleteResource()、observe()、およびdiscover()も参照してください 。

QCoapReply *QCoapClient::put(const QCoapRequest &request, QIODevice *device)

PUTメソッドを使用してrequest を送信し、新しいQCoapReply オブジェクトを返します。このリクエストのペイロードとして、device のコンテンツを使用します。nullのデバイスは空のコンテンツとして扱われ、その場合はrequest のペイロードが使用されます。

関連項目： get()、post()、deleteResource()、observe()、およびdiscover()。

QCoapReply *QCoapClient::put(const QUrl &url, const QByteArray &data = QByteArray())

url に対して PUT リクエストを送信し、新しいQCoapReply オブジェクトを返します。このリクエストのペイロードとしてdata を使用します。

get()、post()、deleteResource()、observe()、およびdiscover()も参照してください 。

[signal] void QCoapClient::responseToMulticastReceived(QCoapReply *reply, const QCoapMessage &message, const QHostAddress &sender)

このシグナルは、マルチキャスト要求に対するユニキャスト応答が到着した際に発信されます。reply パラメータには、受信したばかりの応答へのポインタが含まれ、message にはペイロードとメッセージの詳細が含まれ、sender には送信元アドレスが含まれます。

関連項目： error()、QCoapReply::finished()、およびQCoapReply::error()も参照してください 。

void QCoapClient::setAckRandomFactor(double ackRandomFactor)

RFC 7252 のセクション 4.2 で定義されている「ACK_RANDOM_FACTOR 」の値を、ackRandomFactor に設定します。この値は 1 以上である必要があります。デフォルトは 1.5 です。

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

void QCoapClient::setAckTimeout(uint ackTimeout)

RFC 7252 - セクション 4.2で定義されている「ACK_TIMEOUT 」の値を、ackTimeout （ミリ秒単位）に設定します。デフォルトは 2000 ms です。

このタイムアウトは、確認可能なメッセージにのみ適用されます。信頼性のある送信における実際のタイムアウトは、ACK_TIMEOUT からACK_TIMEOUT * ACK_RANDOM_FACTOR までの間のランダムな値となります。

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

void QCoapClient::setBlockSize(quint16 blockSize)

リクエストの送信および応答の受信時に、プロトコルが使用する最大ブロックサイズをblockSize に設定します。ブロックサイズは2の冪でなければなりません。

void QCoapClient::setMaximumRetransmitCount(uint maximumRetransmitCount)

RFC 7252 のセクション 4.2で定義されている「MAX_RETRANSMIT 」の値を「maximumRetransmitCount 」に設定します。この値は 25 以下である必要があります。デフォルト値は 4 です。

void QCoapClient::setMaximumServerResponseDelay(uint responseDelay)

MAX_SERVER_RESPONSE_DELAY の値をresponseDelay （ミリ秒単位）に設定します。デフォルトは250秒です。

RFC 7390 のセクション 2.5 で定義されているように、 MAX_SERVER_RESPONSE_DELAY は、クライアントがマルチキャストリクエストを送信できるすべてのサーバーにおける、予想される最大応答遅延です。

void QCoapClient::setMinimumTokenSize(int tokenSize)

トークンの最小サイズをtokenSize バイトに設定します。セキュリティ上の理由から、長さが少なくとも4バイトのトークンを使用することをお勧めします。このパラメータのデフォルト値は4バイトです。

void QCoapClient::setSecurityConfiguration(const QCoapSecurityConfiguration &configuration)

configuration からセキュリティ設定パラメータを設定します。QtCoap::NoSecurity モードが使用されている場合、この設定は無視されます。

関連項目： disconnect()。

void QCoapClient::setSocketOption(QAbstractSocket::SocketOption option, const QVariant &value)

QUdpSocket のソケットoption をvalue に設定します。