diff options
| author | Sébastien Helleu <flashcode@flashtux.org> | 2024-01-06 10:42:22 +0100 |
|---|---|---|
| committer | Sébastien Helleu <flashcode@flashtux.org> | 2024-02-01 21:38:49 +0100 |
| commit | 8971fc069a1c1a9e8c3f6fa1f83e64a50b2876c1 (patch) | |
| tree | 55ee948cd5bdb0ec24dfedc6db7a8b7cdc841eec /doc/en | |
| parent | 179d53a12e45f316902fd83c6d00bd2272a8dc17 (diff) | |
| download | weechat-8971fc069a1c1a9e8c3f6fa1f83e64a50b2876c1.zip | |
relay: add "api" protocol (HTTP REST API) (issue #2066)
Diffstat (limited to 'doc/en')
| -rw-r--r-- | doc/en/weechat_dev.en.adoc | 8 | ||||
| -rw-r--r-- | doc/en/weechat_user.en.adoc | 6 |
2 files changed, 13 insertions, 1 deletions
diff --git a/doc/en/weechat_dev.en.adoc b/doc/en/weechat_dev.en.adoc index b86822afd..24833ee65 100644 --- a/doc/en/weechat_dev.en.adoc +++ b/doc/en/weechat_dev.en.adoc @@ -331,15 +331,20 @@ WeeChat "core" is located in following directories: | relay-command.c | Relay commands. | relay-completion.c | Relay completions. | relay-config.c | Relay config options (file relay.conf). +| relay-http.c | HTTP functions. | relay-info.c | Relay info/infolists/hdata. | relay-network.c | Network functions for relay. | relay-raw.c | Relay raw buffer. | relay-server.c | Relay server. | relay-upgrade.c | Save/restore of relay data when upgrading WeeChat. | relay-websocket.c | WebSocket server functions (RFC 6455). +| api/ | Relay for remote interfaces (using HTTP REST API). +| relay-api.c | Main API functions for HTTP REST API. +| relay-api-msg.c | Send JSON messages to clients. +| relay-api-protocol.c | HTTP REST API protocol. | irc/ | IRC proxy. | relay-irc.c | Main IRC proxy functions. -| weechat/ | Relay for remote interfaces. +| weechat/ | Relay for remote interfaces (using "weechat" binary protocol). | relay-weechat.c | Relay for remote interfaces (main functions). | relay-weechat-msg.c | Send binary messages to clients. | relay-weechat-nicklist.c | Nicklist functions. @@ -469,6 +474,7 @@ WeeChat "core" is located in following directories: | test-typing-status.cpp | Tests: typing status. | relay/ | Root of unit tests for Relay plugin. | test-relay-auth.cpp | Tests: clients authentication. +| test-relay-http.cpp | Tests: HTTP functions for Relay plugin. | irc/ | Root of unit tests for Relay "irc" protocol. | test-relay-irc.cpp | Tests: Relay "irc" protocol. | xfer/ | Root of unit tests for Xfer plugin. diff --git a/doc/en/weechat_user.en.adoc b/doc/en/weechat_user.en.adoc index 63aa02fb5..b3d13aac0 100644 --- a/doc/en/weechat_user.en.adoc +++ b/doc/en/weechat_user.en.adoc @@ -154,6 +154,9 @@ WeeChat: | ca-certificates | | Certificates for TLS connections. +| libcjson-dev | +| Relay plugin: protocol "api" (HTTP REST API). + | libzstd-dev | ≥ 0.8.1 | Logger plugin: compression of rotated log files (zstandard). + Relay plugin: compression of messages (WeeChat -> client) with https://facebook.github.io/zstd/[Zstandard ^↗^^] (weechat protocol). @@ -273,6 +276,9 @@ List of available options: | ENABLE_CHARSET | `ON`, `OFF` | ON | Compile <<charset,Charset plugin>>. +| ENABLE_CJSON | `ON`, `OFF` | ON +| Support of JSON with https://github.com/DaveGamble/cJSON[cJSON ^↗^^] library. + | ENABLE_MAN | `ON`, `OFF` | OFF | Build man page. |