commit c3b21295355c7d9e6d8f1e5c927f05df502120ab parent 37eee492d0ce0f7cbfc97aa9df554d6469fbec4b Author: Jacki <jacki@thejackimonster.de> Date: Sun, 9 Jun 2024 20:32:00 +0200 messenger: update information regarding message kinds Signed-off-by: Jacki <jacki@thejackimonster.de> Diffstat:
| M | developers/apis/messenger.rst | | | 43 | ++++++++++++++++++++++++++++++++++++------- |
1 file changed, 36 insertions(+), 7 deletions(-)
diff --git a/developers/apis/messenger.rst b/developers/apis/messenger.rst @@ -156,13 +156,10 @@ information. TICKET-message ^^^^^^^^^^^^^^ -TICKET-messages can be send via the separate function -``GNUNET_MESSENGER_send_ticket`` which will verify whether the selected -private key of your identity matches the key used to issue the ticket. -A ticket contained in such a TICKET-message will be sent privately to -its regarding audience. That audience will be able to consume the -received ticket via ``GNUNET_RECLAIM_ticket_consume`` to gain access to -selected attributes and their stored values. +TICKET-messages can be send privately to other members in the room. The +member will be able to consume the received ticket via +``GNUNET_RECLAIM_ticket_consume`` to gain access to selected attributes +and their stored values. TICKET-messages require the usage of the RECLAIM service of GNUnet to issue, revoke and consume tickets. Revoking tickets is independant of @@ -197,6 +194,38 @@ JOIN-message will be interpreted as block of the contact. Unblocking or untagging can be done via deletion of the selected TAG-message. +.. _SUBSCRIBE_002dmessage: + +SUBSCRIBE-message +^^^^^^^^^^^^^^^^^ + +SUBSCRIBE-messages can be used to subscribe to a selected discourse in +a room. With the ``GNUNET_MESSENGER_FLAG_SUBSCRIPTION_KEEP_ALIVE`` flag +this subscription will be extended automatically by the client API of +the MESSENGER service. + +A subscription can be ended manually via SUBSCRIBE-message with the flag +``GNUNET_MESSENGER_FLAG_SUBSCRIPTION_UNSUBSCRIBE`` or it will end +automatically when closing the room or disconnecting the client, letting +the subscription run out. + +Such an active subscription is necessary to receive TALK-messages from +a discourse. SUBSCRIBE-messages will not be stored locally. + +.. _TALK_002dmessage: + +TALK-message +^^^^^^^^^^^^ + +TALK-messages can be send while subscribed to a selected discourse. The +messages can contain any sort of binary data. Applications need to work +out format compatibility on their own. It is possible to link formats +to the discourse id used to identify a given discourse inside a room. + +Only members that have an active subscription to the given discourse +will receive the TALK-messages. These messages will not be stored +locally. + .. _Member-sessions: Member sessions