project-iris / iris

Decentralized cloud messaging
iris.karalabe.com
Other
570 stars 32 forks source link

Relay protocol docs #21

Open karalabe opened 10 years ago

karalabe commented 10 years ago

Although the protocol between a client lib and Iris is simple, it would be essential to document it properly to allow third party binding implementations (or even official binding contributions).

karalabe commented 10 years ago

In the mean time I've reworked the relay protocol, fixing quite a few issues that cropped up in the previous preview version. I'm sure there will be still things to fix after this one too, but its a much stabler specification.

The protocol itself has not yet been updated in Iris/bindings according to the new specs, but I'll start working on it soon. In the mean time, if you have any feedback on it, please share.

Iris relay protocol - v1.0-draft 2

catwell commented 9 years ago

Note: there is a mistake in the v1.0 draft 2 (or in the implementation). The draft says the protocol version is v1-draft2 but the server expects v1.0-draft2.

karalabe commented 9 years ago

This was fixed a while in an officially published protocol spec. The corrected version was published here: http://iris.karalabe.com/downloads, specifically at http://iris.karalabe.com/specs/relay-protocol-v1.0-draft2.pdf :) Though I should have updated this thread too, so thanks for pointing it out :)

catwell commented 9 years ago

Oh, awesome, I didn't know you updated the spec. Thanks!

karalabe commented 9 years ago

Just some minor fixes, like the version miasmatch you pointed out :) Nothing serious.