ExternalVendorCode/serval-dna
1
0
Fork 0
mirror of https://github.com/servalproject/serval-dna.git synced 2025-02-06 19:19:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Spruce up MeshMS REST API tech doc a bit

Browse Source
This commit is contained in:
Andrew Bettison 2017-10-20 17:04:27 +10:30
parent f53be7c6a6
commit 58573a4345
2 changed files with 24 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -195,8 +195,8 @@ This document is available under the [Creative Commons Attribution 4.0 Internati
[Serval Keyring]: ./doc/REST-API-Keyring.md [Serval Keyring]: ./doc/REST-API-Keyring.md
[MDP]: ./doc/Mesh-Datagram-Protocol.md [MDP]: ./doc/Mesh-Datagram-Protocol.md
[VoMP]: http://developer.servalproject.org/dokuwiki/doku.php?id=content:tech:vomp [VoMP]: http://developer.servalproject.org/dokuwiki/doku.php?id=content:tech:vomp
[MeshMS]: http://developer.servalproject.org/dokuwiki/doku.php?id=content:tech:meshms
[Rhizome]: ./doc/REST-API-Rhizome.md [Rhizome]: ./doc/REST-API-Rhizome.md
[MeshMS]: ./doc/REST-API-MeshMS.md
[Serval Infrastructure]: ./doc/Serval-Infrastructure.md [Serval Infrastructure]: ./doc/Serval-Infrastructure.md
[JNI]: http://en.wikipedia.org/wiki/Java_Native_Interface [JNI]: http://en.wikipedia.org/wiki/Java_Native_Interface
[Bash]: http://en.wikipedia.org/wiki/Bash_(Unix_shell) [Bash]: http://en.wikipedia.org/wiki/Bash_(Unix_shell)

40
doc/REST-API-MeshMS.md
View File

@ -11,35 +11,40 @@ distributed one-to-one messaging using [Rhizome][] as transport.
The [Serval DNA][] daemon that runs on every node gives applications access to The [Serval DNA][] daemon that runs on every node gives applications access to
the [MeshMS][] service via the **MeshMS REST API** described in this document. the [MeshMS][] service via the **MeshMS REST API** described in this document.
### Basic concepts Basic concepts
--------------
#### Ply #### Ply
In rhizome, each author can only update rhizome bundles that they first created. In rhizome, each author can only update rhizome bundles that they first
A ply is a rhizome journal bundle where each participant records their outgoing messages, created. A ply is a rhizome journal bundle where each participant records
and any other changes to the conversation. their outgoing messages, and any other changes to the conversation.
A ply can contain the following types of records; A ply can contain the following types of records;
* ACK - A pointer to a range of content within another ply. * ACK - A pointer to a range of content within another ply
* MESSAGE - A plain text message encoded in UTF-8. * MESSAGE - A plain text message encoded in UTF-8
* TIME - A timestamp related to the previous record. * TIME - A timestamp related to the previous record
#### Conversation #### Conversation
A MeshMS conversation consists of one or two message ply's. Each participant sets A MeshMS conversation consists of one or two message [plys](#ply). Each
the sender and recipient manifest fields to the identities of the two parties in the participant sets the sender and recipient manifest fields to the identities of
conversation. the two parties in the conversation.
Both ply's are encrypted such that only the sender and recipient can read their contents. Both ply's are encrypted such that only the sender and recipient can read their
contents.
Whenever a new MESSAGE is detected on an incoming ply, a new ACK record is written to the Whenever a new MESSAGE is detected on an incoming ply, a new ACK record is
end of the outgoing ply. This is used to indicate successful delivery, and to thread the written to the end of the outgoing ply. This is used to indicate successful
display of messages in the conversation. delivery, and to thread the display of messages in the conversation.
There is no central server to assign a common ordering to messages in a conversation, There is no central server to assign a common ordering to messages in a
both parties will see their outgoing messages threaded with received messages in the order conversation, both parties will see their outgoing messages threaded with
they arrived locally. received messages in the order they arrived locally.
MeshMS REST API operations
--------------------------
### GET /restful/meshms/SENDERSID/conversationlist.json ### GET /restful/meshms/SENDERSID/conversationlist.json
@ -60,6 +65,7 @@ Send a new message from SENDERSID to RECIPIENTSID.
----- -----
**Copyright 2015 Serval Project Inc.** **Copyright 2015 Serval Project Inc.**
**Copyright 2016 Flinders University**
![CC-BY-4.0](./cc-by-4.0.png) ![CC-BY-4.0](./cc-by-4.0.png)
Available under the [Creative Commons Attribution 4.0 International licence][CC BY 4.0]. Available under the [Creative Commons Attribution 4.0 International licence][CC BY 4.0].