RetroShare/libresapi/src/api
2017-05-24 19:40:01 +02:00
..
ApiPluginHandler.cpp added missing null check libresapi ApiPluginHandler 2015-12-18 19:05:18 +01:00
ApiPluginHandler.h allow plugins to integrate into the JSON API 2015-12-15 19:56:49 +01:00
ApiServer.cpp Fix Warnings: this ‘if’ clause does not guard... 2017-05-08 12:18:51 +02:00
ApiServer.h libresapi: add basic forum read api (patch from Chozabu) close #32 2015-08-31 19:44:15 +02:00
ApiServerLocal.cpp Simplify QML to work better on both Desktop and Phone 2016-10-26 20:37:28 +02:00
ApiServerLocal.h Advances on trusted node addings 2016-09-22 12:48:08 +02:00
ApiServerMHD.cpp Advances on trusted node addings 2016-09-22 12:48:08 +02:00
ApiServerMHD.h added web interface to retroshare-gui 2015-04-24 14:31:13 +00:00
ApiTypes.h Added name of requests to be used by GUI 2017-03-25 18:23:28 +01:00
ChannelsHandler.cpp libresapi: added channels/create_post 2016-02-19 19:23:55 +01:00
ChannelsHandler.h libresapi: added channels/create_post 2016-02-19 19:23:55 +01:00
ChatHandler.cpp Added: Handling requests to create lobby 2017-04-14 17:44:17 +02:00
ChatHandler.h Added: Handling requests to create lobby 2017-04-14 17:44:17 +02:00
FileSearchHandler.cpp Fix Clang warnings: unused private field 2017-04-17 21:35:29 +02:00
FileSearchHandler.h Fix Clang warnings: unused private field 2017-04-17 21:35:29 +02:00
ForumHandler.cpp fixed problem in ID creation code. 2017-02-07 20:15:55 +01:00
ForumHandler.h libresapi: add basic forum read api (patch from Chozabu) close #32 2015-08-31 19:44:15 +02:00
GetPluginInterfaces.cpp allow plugins to integrate into the JSON API 2015-12-15 19:56:49 +01:00
GetPluginInterfaces.h libresapi: added statetoken to identity handler responses 2016-02-07 14:28:45 +01:00
GxsMetaOperators.h added resource_api and rs-nogui-webui (requires libmicrohttpd, Html files are not included) 2015-03-18 18:48:43 +00:00
GxsResponseTask.cpp libresapi: added chat/receive_status 2016-02-14 14:57:41 +01:00
GxsResponseTask.h libresapi: added chat/receive_status 2016-02-14 14:57:41 +01:00
IdentityHandler.cpp Fix Warnings: unused parameter ‘resp’, 'req' & 'resp' 2017-05-08 12:21:08 +02:00
IdentityHandler.h Added: Handling requests to set opinion about identity 2017-04-18 23:00:59 +02:00
json.cpp Fixed a bunch of warnings in safe ways 2016-10-13 00:01:33 +02:00
json.h updated SuperEasyJSON 2015-03-27 18:43:07 +00:00
JsonStream.cpp webui: allow to set peer flags when adding friends (whitelist flag is set to false) 2015-06-04 12:57:09 +00:00
JsonStream.h - added support for multiple client threads to ApiServer 2015-03-31 18:00:40 +00:00
LivereloadHandler.cpp webui: 2015-04-29 11:57:56 +00:00
LivereloadHandler.h webui: 2015-04-29 11:57:56 +00:00
Operators.cpp libresapi: fixed bug in JSON serialisation of uint32_t, decimal digits had inverse order 2015-10-13 20:35:24 +02:00
Operators.h added resource_api and rs-nogui-webui (requires libmicrohttpd, Html files are not included) 2015-03-18 18:48:43 +00:00
Pagination.h Add a Clear button on WebUI 2016-04-08 01:31:36 +02:00
PeersHandler.cpp Merge pull request #781 from Sonetio/libresapi_requests 2017-04-24 18:43:17 +02:00
PeersHandler.h Added: Notification about changed peer status 2017-04-20 19:09:57 +02:00
README.md added resource_api and rs-nogui-webui (requires libmicrohttpd, Html files are not included) 2015-03-18 18:48:43 +00:00
ResourceRouter.cpp Added name of requests to be used by GUI 2017-03-25 18:23:28 +01:00
ResourceRouter.h allow plugins to integrate into the JSON API 2015-12-15 19:56:49 +01:00
RsControlModule.cpp Add I2P BOB support to libretroashare and RetroShare GUI 2017-05-24 19:40:01 +02:00
RsControlModule.h Add override and final placeolders for old GCC compatibility 2017-05-08 16:57:37 +02:00
ServiceControlHandler.cpp webui: view / change rights per user 2016-03-22 16:33:05 +01:00
ServiceControlHandler.h webui: view / change rights per user 2016-03-22 16:33:05 +01:00
SettingsHandler.cpp Added SettingsHandler to handle response to settings requests 2017-03-25 18:20:53 +01:00
SettingsHandler.h Added SettingsHandler to handle response to settings requests 2017-03-25 18:20:53 +01:00
StateTokenServer.cpp mark empty list as list in libresapi statetokenserver 2016-01-03 16:33:09 +01:00
StateTokenServer.h added resource_api and rs-nogui-webui (requires libmicrohttpd, Html files are not included) 2015-03-18 18:48:43 +00:00
StatsHandler.cpp add dht/nat to librespai stats 2016-08-30 21:58:07 +02:00
StatsHandler.h add stats to libresapi 2016-08-30 21:50:20 +02:00
TmpBlobStore.cpp webui: 2015-06-16 12:35:07 +00:00
TmpBlobStore.h removed unused variable in TmpBlobStore 2015-06-19 14:43:04 +00:00
TransfersHandler.cpp pass over compiler warnings 2016-06-05 10:43:57 -04:00
TransfersHandler.h added resource_api and rs-nogui-webui (requires libmicrohttpd, Html files are not included) 2015-03-18 18:48:43 +00:00

New programming interface for Retroshare

  • access to libretroshare for webinterfaces, QML and scripting
  • client - server architecture.
  • network friendly: transport messages over high latency and low bandwidth networks
  • multiple clients: can use scripting and webinterface at the same time
  • simple packet format: no special serialiser required
  • simple protocol: one request creates one response. A requets does not depend on a previous request.
  • automatic state change propagation: if a resource on the server changes, the clients will get notified
  • no shared state: Client and server don't have to track what they send each other.
  • works with all programming languages

How does it work?

- Client sends a request: adress of a resource and optional parameters encoded as JSON
{
	"method": "get",
	"resource": ["peers"],
}
- Server sends a Response:
{
	"returncode": "ok",
	"statetoken": "ASDF",
	"data": [...]
}

- Client asks if data is still valid
{
	"method": "exec",
	"resource": "statetokenservice"
	"data": ["ASDF", "GHJK"]
}
- Server answers Client that statetoken "ASDF" expired
{
	"returncode": "ok",
	"data": ["ASDF"]
}

Transport

A transport protocol transports requests and responses between client and server.

  • tracks message boundaries, so messages don't get merged
  • may be able to handle concurrent requests with out of order delivery of responses
  • knows to which request a response belongs to

Transport could do encryption and authentication with a standardized protocol like SSH or TLS.

Ideas:

  • request id + length + request data -> SSH -> TCP -> ...
  • Websockets
  • Retroshare Items
  • Unix domain sockets

Currently only unencrypted http is implemented. libmicrohttpd (short MHD) is used as http server. Can use a proxy to add TLS encryption.

Message encoding

Currently JSON, because it is already available in JavaScript and QML. Other key-value encodings could be used as well. Read more about basic data types of different languages (JavaScript, QML, Lua, C++) in ./ApiServer.cpp.