sobani-tracker

Introduction

Aim to set up a tracker server for sobani service and clients

Setup

Clone to your instance

git clone https://github.com/BlueCocoa/sobani-tracker-rust.git

Compile

cd sobani-tracker-rust
cargo build --release

Start server

cargo run --release

API Documentation

Actions

announce

Announce action relates to the first connection from peer to server, within this action, a client send three parameters to tracker server in order to record and make the share action possible.

If sending is successful, an announced object will be returned.

Expected response from server:

{
  "action": "announced",
  "data": {
    "shareId": "1AbhoECj"
  }
}

alive

alive action meant to make maintaining the connection and the sharing session valid and possible by rapidly sending a packet to server to report the Alive state of the client. By doing this, server will store the session and shareId while the clients are alive, if a client stopped to send a packet, server will delete the related shareId and multiaddr it announced before. (Default expiration time will be 5 minutes)

push

Push action tells the server the unique shareId of the target client the peers shared. Tracker server respond with the IP:Port back to the requesting client, so on, the client can try to establish the connection between.

If sending is successful, a pushed message is returned.

pushed data is demostrated below

Expected response from server:

{
  "action": "pushed",
  "data": {
    "peeraddr": "1.2.3.4:23333",
    "peerShareId": "1AbhoECj"
  }
}

Also, the tracker will send an income message to the requestee

income data is demostrated below

Expected income message from server:

{
  "action": "income",
  "data": {
    "peeraddr": "1.2.3.4:23333",
    "peerShareId": "1AbhoECj"
  }
}

Types

announced

announced data

pushed

pushed data

income

income data