QMqttClient Class

멤버 함수 문서

[explicit] QMqttClient::QMqttClient(QObject *parent = nullptr)

지정된 parent 를 사용하여 새로운 MQTT 클라이언트 인스턴스를 생성합니다.

[override virtual noexcept] QMqttClient::~QMqttClient()

MQTT 클라이언트를 삭제합니다. MQTT 클라이언트가 아직 MQTT 브로커와 연결된 상태라면, 자동으로 연결이 끊어집니다.

void QMqttClient::authenticate(const QMqttAuthenticationProperties &prop)

브로커에 인증 요청을 보냅니다. ` prop `는 인증 요청을 처리하는 데 필요한 정보를 지정합니다.

이 함수는 QMqttClient::authenticationRequested 신호가 발신된 후에만 호출되어야 합니다.

authenticationRequested() 및 authenticationFinished()도 참조하십시오 .

[signal] void QMqttClient::authenticationFinished(const QMqttAuthenticationProperties &p)

이 신호는 확장 인증이 완료된 후 전송됩니다. p 는 인증 과정에 대한 세부 정보를 제공합니다.

인증에 성공하면 QMqttClient::connected 가 전송됩니다.

authenticationRequested() 및 authenticate()도 참조하십시오 .

[signal] void QMqttClient::authenticationRequested(const QMqttAuthenticationProperties &p)

이 신호는 클라이언트가 QMqttClient::connectToHost 또는 QMqttClient::connectToHostEncrypted 를 호출한 후, 연결이 수립되기 전에 전송됩니다. 확장 인증에서 브로커는 QMqttClient::authenticate 를 호출하여 제공해야 하는 추가 정보를 요청할 수 있습니다. p 는 브로커가 제공하는 속성을 명시합니다.

authenticationFinished() 및 authenticate()도 참조하십시오 .

[signal] void QMqttClient::brokerSessionRestored()

이 신호는 클라이언트가 cleanSession 속성을 false 로 설정하고 브로커에 성공적으로 연결한 후, 브로커가 세션을 복원한 경우에 발생합니다.

클라이언트가 이전에 동일한 clientId 를 사용하여 연결한 적이 있다면 세션을 복원할 수 있습니다.

[invokable] void QMqttClient::connectToHost()

MQTT 브로커와의 연결을 시작합니다.

void QMqttClient::connectToHostEncrypted(const QSslConfiguration &conf)

MQTT 브로커에 대한 암호화된 연결을 시작합니다.

conf 연결에 사용할 SSL 구성을 지정합니다.

[invokable, since 6.10] void QMqttClient::connectToHostWebSocket(QWebSocket *webSocket = nullptr)

웹소켓 전송 유형을 설정하고 MQTT 브로커와의 연결을 시작합니다. 기존 전송 유형은 대체됩니다. webSocket 가 지정되면 호스트명과 포트는 무시되며, 해당 웹소켓을 통해 연결이 이루어집니다. webSocket은 호출하는 코드가 소유하며, QMqttClient 객체의 수명 기간 동안 유효해야 합니다.

이 함수는 Qt 6.10에서 도입되었습니다.

[invokable, since 6.10] void QMqttClient::connectToHostWebSocketEncrypted(QWebSocket *webSocket = nullptr)

보안 웹소켓 전송 유형을 설정하고 MQTT 브로커와의 연결을 시작합니다. 기존 전송 유형은 대체됩니다. webSocket 가 지정된 경우, 호스트명과 포트는 무시되며 해당 웹소켓을 통해 연결이 이루어집니다. webSocket은 호출 코드가 소유하며, QMqttClient 객체의 수명 기간 동안 유효해야 합니다.

이 함수는 Qt 6.10에서 도입되었습니다.

[signal] void QMqttClient::connected()

이 신호는 연결이 설정되었을 때 전송됩니다.

QMqttConnectionProperties QMqttClient::connectionProperties() const

클라이언트가 브로커에 요청한 연결 속성을 반환합니다.

setConnectionProperties()도 참조하십시오 .

[invokable] void QMqttClient::disconnectFromHost()

MQTT 브로커와의 연결을 끊습니다.

[signal] void QMqttClient::disconnected()

이 신호는 연결이 종료되었을 때 발생합니다. 연결은 disconnectFromHost()이 호출되거나 브로커가 연결을 끊을 때 종료될 수 있습니다.

QMqttLastWillProperties QMqttClient::lastWillProperties() const

마지막 유언의 속성을 반환합니다.

setLastWillProperties()도 참조하십시오 .

[signal] void QMqttClient::messageReceived(const QByteArray &message, const QMqttTopicName &topic = QMqttTopicName())

이 신호는 새 메시지가 수신되었을 때 전송됩니다. 메시지의 범주는 ` topic `로 지정되며, 내용은 ` message`입니다.

[signal] void QMqttClient::messageSent(qint32 id)

publish() 함수를 통해 전송된 메시지가 브로커에 수신되었음을 나타냅니다. id 는 메시지 상태 추적을 돕기 위해 publish() 에서 반환되는 값과 동일합니다.

[signal] void QMqttClient::messageStatusChanged(qint32 id, QMqtt::MessageStatus s, const QMqttMessageStatusProperties &properties)

이 신호는 id 로 식별되는 메시지의 상태가 변경될 때 발생합니다. s 는 메시지의 새로운 상태를 나타내며, properties 는 서버에서 제공하는 추가 속성을 나타냅니다.

[signal] void QMqttClient::pingResponseReceived()

이 신호는 브로커가 ` requestPing()` 호출이나 ` keepAlive()` 핑 메시지에 응답한 후, 연결이 여전히 유효한 상태에서 발생합니다.

[invokable] qint32 QMqttClient::publish(const QMqttTopicName &topic, const QByteArray &message = QByteArray(), quint8 qos = 0, bool retain = false)

지정된 topic 를 사용하여 브로커에 message 를 게시합니다. qos 는 메시지 전송에 필요한 QoS 수준을 지정합니다.

retain 가 true 로 설정된 경우, 메시지는 브로커에 남아 다른 클라이언트가 연결하여 메시지를 수신할 수 있게 됩니다.

메시지를 식별하는 데 내부적으로 사용되는 ID를 반환합니다.

[invokable] qint32 QMqttClient::publish(const QMqttTopicName &topic, const QMqttPublishProperties &properties, const QByteArray &message = QByteArray(), quint8 qos = 0, bool retain = false)

지정된 properties 및 topic 를 사용하여 브로커에 message 를 게시합니다. qos 는 메시지 전송에 필요한 QoS 수준을 지정합니다.

retain 가 true 로 설정된 경우, 메시지는 브로커에 남아 다른 클라이언트가 연결하여 메시지를 수신할 수 있게 됩니다.

메시지를 식별하는 데 내부적으로 사용되는 ID를 반환합니다.

bool QMqttClient::requestPing()

브로커에 핑 메시지를 전송하고 응답을 기다립니다.

연결이 활성 상태이고 ` autoKeepAlive `가 ` true`인 경우, 이 프로세스를 관리하는 것은 클라이언트의 책임이므로 이 함수를 호출하면 실패합니다.

requestPing() 를 수동으로 사용하려면, 연결이 활성화된 동안 keepAlive 간격마다 호출해야 합니다.

핑이 성공했는지 확인하려면 pingResponseReceived() 신호에 연결하십시오.

핑 요청을 보낼 수 있다면 true 를 반환합니다.

pingResponseReceived(), autoKeepAlive(), keepAlive()도 참조하십시오 .

QMqttServerConnectionProperties QMqttClient::serverConnectionProperties() const

브로커가 연결 시도 후 반환한 QMqttServerConnectionProperties 를 반환합니다.

이를 통해 QMqttClient::setConnectionProperties 로 설정된 클라이언트 측 연결 속성이 브로커에 의해 수락되었는지 확인할 수 있습니다. 또한, 연결 시도가 실패한 경우 연결 진단에 활용할 수 있습니다.

connectionProperties()도 참조하십시오 .

void QMqttClient::setConnectionProperties(const QMqttConnectionProperties &prop)

연결 속성을 ‘ prop ’로 설정합니다. ‘ QMqttConnectionProperties ’를 사용하여 서버에 특정 기능 세트를 사용하도록 요청할 수 있습니다. 연결 요청 후, ‘ QMqttClient::serverConnectionProperties ’를 호출하여 서버의 응답을 받을 수 있습니다.

connectionProperties()도 참조하십시오 .

void QMqttClient::setLastWillProperties(const QMqttLastWillProperties &prop)

last will 속성을 ‘ prop ’로 설정합니다. ‘ QMqttLastWillProperties ’를 사용하면 브로커에 저장된 last will 메시지에 대한 추가 기능을 설정할 수 있습니다.

참조: lastWillProperties().

void QMqttClient::setTransport(QIODevice *device, QMqttClient::TransportType transport)

트랜스포트를 ‘ device ’로 설정합니다. 트랜스포트는 소켓 유형이거나 ‘ QIODevice ’에서 파생된 유형일 수 있으며, ‘ transport ’로 지정됩니다.

transport()도 참조하십시오 .

QMqttSubscription *QMqttClient::subscribe(const QMqttTopicFilter &topic, quint8 qos = 0)

topic 에서 알림을 수신하기 위한 새로운 구독을 추가합니다. 매개변수 qos 는 보안 메시지를 수신할 QoS 수준을 지정합니다. 사용 가능한 QoS 수준에 대한 자세한 내용은 ‘서비스 품질(Quality of Service)’을 참조하십시오.

이 함수는 QMqttSubscription 에 대한 포인터를 반환합니다. 동일한 토픽에 두 번 구독한 경우, 반환 값은 동일한 구독 인스턴스를 가리킵니다. MQTT 클라이언트가 구독의 소유자입니다.

QMqttSubscription *QMqttClient::subscribe(const QMqttTopicFilter &topic, const QMqttSubscriptionProperties &properties, quint8 qos = 0)

topic 에서 알림을 수신하기 위한 새로운 구독을 추가합니다. properties 매개변수는 브로커가 유효성을 검사할 추가 구독 속성을 지정합니다. qos 매개변수는 보안 메시지를 수신할 수준을 지정합니다. 사용 가능한 QoS 수준에 대한 자세한 내용은 ‘서비스 품질(Quality of Service)’을 참조하십시오.

이 함수는 QMqttSubscription 에 대한 포인터를 반환합니다. 동일한 토픽을 두 번 구독한 경우, 반환 값은 동일한 구독 인스턴스를 가리킵니다. MQTT 클라이언트는 해당 구독의 소유자입니다.

QIODevice *QMqttClient::transport() const

브로커와의 통신에 사용되는 전송 방식을 반환합니다.

setTransport()도 참조하십시오 .

void QMqttClient::unsubscribe(const QMqttTopicFilter &topic)

topic 의 구독을 해지합니다. subscribe()를 호출하여 생성된 모든 구독에 대해서는 알림이 전송되지 않습니다.

void QMqttClient::unsubscribe(const QMqttTopicFilter &topic, const QMqttUnsubscriptionProperties &properties)

topic 에서 구독을 취소합니다. subscribe()를 호출하여 등록한 구독에 대해서는 어떠한 알림도 전송되지 않습니다. properties 는 브로커에 전달할 추가 사용자 속성을 지정합니다.