Kaladaran/briar
0
0
Fork 0
mirror of https://code.briarproject.org/briar/briar.git synced 2026-02-11 18:29:05 +01:00
Code Issues Projects Releases Wiki Activity

Update Forum Sharing Client

akwizgran
2018-03-22 14:45:49 +00:00
parent 0548d76af2
commit 98541ac38f
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
Forum-Sharing-Client.md

@@ -10,19 +10,19 @@ The client uses a separate BSP group for each pair of contacts. The [group descr
The sharing protocol uses five message types. All communication happens between two contacts, who have symmetrical roles. The messages referring to each forum constitute a session.
**0: INVITE** - Sent by the inviter to the invitee. The message body is a BDF list with four elements: `messageType` (int), `previousMessageId` (unique ID or null), `descriptor` (list), and `message` (string or null).
**0: INVITE** - Sent by either party to start or restart a session. The message body is a BDF list with four elements: `messageType` (int), `previousMessageId` (unique ID or null), `descriptor` (list), and `message` (string or null).
`previousMessageId` is the ID of the previous message in this session, if any. `descriptor` is the [descriptor of the forum](Forum-Client#group-identifiers) being shared. `message` is an optional message from the inviter to the invitee. The forum ID must be calculated from the descriptor, as it is used by subsequent messages in the session.
The inviter sets the forum's visibility to VISIBLE when sending an invite message.
The sender sets the forum's visibility to VISIBLE when sending an invite message.
**1: ACCEPT** - Sent by the invitee to the inviter in response to an invite. The message body is a BDF list with three elements: `messageType` (int), `forumId` (unique ID), and `previousMessageId` (unique ID).
**1: ACCEPT** - Sent in response to an invite. The message body is a BDF list with three elements: `messageType` (int), `forumId` (unique ID), and `previousMessageId` (unique ID).
The invitee sets the forum's visibility to SHARED when sending an accept message. The inviter sets the forum's visibility to SHARED when receiving an accept message.
The sender sets the forum's visibility to SHARED when sending an accept message. The recipient sets the forum's visibility to SHARED when receiving an accept message.
**2: DECLINE** - Sent by the invitee to the inviter in response to an invite. The message body is a BDF list with three elements: `messageType` (int), `forumId` (unique ID), and `previousMessageId` (unique ID).
**2: DECLINE** - Sent in response to an invite. The message body is a BDF list with three elements: `messageType` (int), `forumId` (unique ID), and `previousMessageId` (unique ID).
The inviter sets the forum's visibility to INVISIBLE when receiving a decline message.
The recipient sets the forum's visibility to INVISIBLE when receiving a decline message.
**3: LEAVE** - Sent by either party when unsubscribing from the forum, if the forum's visibility is VISIBLE or SHARED. The message body is a BDF list with three elements: `messageType` (int), `forumId` (unique ID), and `previousMessageId` (unique ID).