aboutsummaryrefslogtreecommitdiffstats
path: root/docs/qafbwebsocketclient.md
blob: 5a6a3da32e4b20f20adda639fd4661974e3a52f9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# A WebSocket client to an Application Framework Binder

## QAfbWebsocketClient(QObject* parent = nullptr)

Default constructor.

* `parent`: Parent object.

## QAbstractSocket::SocketError error()

Get and return the last error code.

## QString errorString()

Get and return the last error as a string.

## bool isValid()

Check if connection is ready or not.

Returns `true` if the connected is ready to read and write, `false` otherwise.

## void call(const QString& api, const QString& verb, const QJsonValue& arg = QJsonValue(), closure_t closure = nullptr)

Call an api's verb with an argument.

* `api`: Api to call.
* `verb`: Verb to call.
* `arg`: Argument to pass.
* `closure`: callback function to call at the verb reply

## void QAfbWebsocketClient::sendTextMessage(QString msg)

Send a text message over the websocket.

This is use for test only, you should not use this method because it sent text
**as-is**, so you have to follow the binder's protocol by your self.

* `msg`: Message to send.