stv0g/spectrum2
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

protocol

Browse source
This commit is contained in:
HanzZ 2013-01-26 12:53:36 +01:00
parent e6d2c5c602
commit c41d01883e
1 changed files with 14 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
developer/backends/protocol.md
View file

@ -18,6 +18,14 @@ When XMPP user wants to login to legacy network, Spectrum 2 executes particular
As the first thing after start, backed should connect Spectrum 2 main instance according to `--host` and `--port` argument. `--service.backend_id` is ID of backend and the last argument is always path to config file. Note that Spectrum 2 can pass more
arguments to backend and backend should ignore them.
When Spectrum 2 starts the backend, you should see this in spectrum.login
INFO NetworkPluginServer: Backend should now connect to Spectrum2 instance. Spectrum2 won't accept any connection before backend connects
When you establish the connection between your backend and Spectrum 2, it shows this in log:
NetworkPluginServer: New backend 0x84ad60 connected. Current backend count=1
### The protocol
When connection betwen backend and Spectrum 2 is establish, Spectrum 2 starts communicating with the backend.
@ -34,6 +42,10 @@ Once you serialize particular Protocol Buffer structure, you can send it in foll
First message sent by Spectrum 2 is always PING. Backend has to response this message with PONG.
You will see this event also in Spectrum 2 log:
NetworkPluginServer: PING to 0x84ad60 (ID=)
Your backend will receive 4 bytes in network encoding. You should parse those 4 bytes to number representation and store it into variable N. Then you should read N bytes from the socket to receive serialized Protobuf message called WrapperMessage. Use the
module generated from protocol.proto to parse it.
@ -48,5 +60,6 @@ In our case, the type is TYPE_PING and the payload is not defined. You should no
PING message has to be answered with PONG. To Answer this message, just generate WrapperMessage using the module generated from protocol.proto and set the type to TYPE_PONG. Now serialie the message, prepend it with its size as defined above and send it to Spectrum 2.
Once you answer the PING request properly, Spectrum 2 will show following message in log:
Component: Connecting XMPP server 127.0.0.1 port 5347