From d5cf1f4442f4786662c7221a308679397c92173b Mon Sep 17 00:00:00 2001 From: akwizgran Date: Wed, 20 Jan 2016 17:24:05 +0000 Subject: [PATCH] s/channel/group/g --- MessagingClient.markdown | 31 ------------------------------- MessagingClient.md | 31 +++++++++++++++++++++++++++++++ 2 files changed, 31 insertions(+), 31 deletions(-) delete mode 100644 MessagingClient.markdown create mode 100644 MessagingClient.md diff --git a/MessagingClient.markdown b/MessagingClient.markdown deleted file mode 100644 index 536e400..0000000 --- a/MessagingClient.markdown +++ /dev/null @@ -1,31 +0,0 @@ -MessagingClient is a [BSP client](BSP) that synchronises private messages between pairs of devices. - -### Channel identifiers - -MessagingClient uses the following client identifier: -`6bcd c006 c091 0b0f 44e4 0644 c3b3 1f1a 8bf9 a6d6 021d 40d2 19c8 6b73 1b90 3070` - -The client uses a single channel for all messages. The [channel descriptor](BSP#channel-identifiers) is an empty [BDF list](BDF). - -### Message types - -**0: PRIVATE_MESSAGE** - The content is a list with four elements: `parent_id` (raw or null), `subject` (string), `body` (string), and `attachments` (dictionary or null). `parent_id` is the identifier of a private message to which this is a response. Each key in `attachments` is the name of an attachment, and the value is a list with two elements: `mime_type` (string) and `message_id` (raw). - -**1: ATTACHMENT** - The content is raw data. - -### Validity policy - -* A private message is valid if it is well-formed. -* An attachment is always valid. - -Note that a private message can be validated before its attachments have been received, and an attachment can be validated before it has been completely received. - -### Storage policy - -* All local messages are stored. -* All remote messages are stored. - -### Sharing policy - -* Each local message is shared with one remote peer. -* Each remote message is shared with the remote peer that created it. diff --git a/MessagingClient.md b/MessagingClient.md new file mode 100644 index 0000000..35c548c --- /dev/null +++ b/MessagingClient.md @@ -0,0 +1,31 @@ +MessagingClient is a [BSP client](BSP) that synchronises private messages between pairs of devices. + +### Group identifiers + +MessagingClient uses the following client identifier: +`6bcd c006 c091 0b0f 44e4 0644 c3b3 1f1a 8bf9 a6d6 021d 40d2 19c8 6b73 1b90 3070` + +The client uses a separate group for each pair of contacts. The [group descriptor](BSP#group-identifiers) is a [BDF list](BDF) containing the unique IDs of the contacts' identities, sorted in ascending order as byte strings. + +### Message types + +**0: PRIVATE_MESSAGE** - The content is a BDF list with four elements: `parent_id` (raw or null), `content_type` (string), `body` (raw), and `attachments` (dictionary or null). `parent_id` is the identifier of a private message to which this is a response. Each key in `attachments` is the name of an attachment, and the value is a list with two elements: `content_type` (string) and `message_id` (raw). + +**1: ATTACHMENT** - The content is raw data. + +### Validity policy + +* A private message is valid if it is well-formed. +* An attachment is always valid. + +Note that a private message can be validated before its attachments have been received, and an attachment can be validated before it has been completely received. + +### Storage policy + +* All local messages are stored. +* All remote messages are stored. + +### Sharing policy + +* All local messages are shared. +* All remote messages are shared.