QtCraft API C++ classes QML types Handbook

QcClientDebugSubscription Class

The client's subscription to the server's debug data (QcMsg::DebugSubscribe, decision E-225) and what arrived of it. More...

Header: #include <clientcore/session/QcClientDebugSubscription.h>

Public Types

Sender

Public Functions

void closed()
quint8 flags() const
const QcServerDebugMirror &mirror() const
void receive(const QcMsg::ServerDebug &message)
void setBaseFlags(quint8 flags)
void setFlags(quint8 flags)
void setSender(QcClientDebugSubscription::Sender sender)
void welcomed()

Detailed Description

Two sets of flags are asked for together: those the user or the control interface chooses, and base flags that stay subscribed whatever the others ask for (the statistics log of a headless game, which the control command debug off must not cut off). Changes are sent at once while the server has welcomed the client and the connection is open, before the welcome with the welcome, after the connection closed never.

Member Type Documentation

[alias] QcClientDebugSubscription::Sender

Sends a message to the server.

Member Function Documentation

void QcClientDebugSubscription::closed()

The connection closed: nothing goes out any more.

quint8 QcClientDebugSubscription::flags() const

Returns what the server is asked for: both together.

See also setFlags().

const QcServerDebugMirror &QcClientDebugSubscription::mirror() const

Returns what arrived of the server's debug data.

void QcClientDebugSubscription::receive(const QcMsg::ServerDebug &message)

Takes a ServerDebug message into the mirror.

void QcClientDebugSubscription::setBaseFlags(quint8 flags)

Sets the base flags, which stay subscribed whatever setFlags() asks for.

void QcClientDebugSubscription::setFlags(quint8 flags)

Sets the subscription to flags (QcMsg::DebugSubscribe flags, 0 for none).

See also flags().

void QcClientDebugSubscription::setSender(QcClientDebugSubscription::Sender sender)

Sets the way out to the server to sender (the session's connection).

void QcClientDebugSubscription::welcomed()

The server welcomed the client: what is wanted goes out now.