73 lines
1.8 KiB
Raw Normal View History

/* This software was written by Dirk Engling <>
It is considered beerware. Prost. Skol. Cheers or whatever.
2008-10-28 01:27:21 +00:00
$id$ */
#ifndef __OT_LIVESYNC_H__
#define __OT_LIVESYNC_H__
#include "io.h"
#include "trackerlogic.h"
2008-12-10 14:19:37 +00:00
Syncing is done as udp packets in the multicast domain port 9696
Each tracker should join the multicast group and send its live sync packets
to that group, using a ttl of 1
2008-12-10 14:19:37 +00:00
Format of all sync packets is straight forward, packet type determines
which kind of packet this is:
0x0000 0x04 id of tracker instance
2008-12-10 14:19:37 +00:00
0x0004 0x04 packet type
######## PEER SYNC PROTOCOL ########
Each tracker instance accumulates announce requests until its buffer is
full or a timeout is reached. Then it broadcasts its live sync packer:
packet type SYNC_LIVE
[ 0x0008 0x14 info_hash
0x001c 0x04 peer's ipv4 address
0x0020 0x02 peer's port
0x0024 0x02 peer flags v1 ( SEEDING = 0x80, COMPLETE = 0x40, STOPPED = 0x20 )
2008-10-28 01:27:21 +00:00
2008-12-10 14:19:37 +00:00
#define LIVESYNC_PORT 9696
void livesync_init();
void livesync_deinit();
/* Join multicast group for listening and create sending socket */
void livesync_bind_mcast( char *ip, uint16_t port );
/* Inform live sync about whats going on. */
** struct ot_workstruct gets ritcher (and will become even ritcher soon). This is where we encapsulate all per-request data from peer to hash to peer_id, so that it is available everywhere without passing hundreds of pointers down the stack. Most functions that do work down the stack now accept an ot_workstruct and some flags. So it can end up in the stats/event-handler where it will be the default parameter in the future. ** peer_id is now being copied by default and moved to ot_workstruct So it is available in stats and subsequent functions. ** sync scrape madness is gone SYNC_SCRAPE was intended to sync tracker state that would normally be lost on restarts i.e. downloaded counts per torrent. The way was to push it in the tracker cloud after finding all neighbouring trackers. This is madness. It never was tested and can be done per tracker by fetching stats/mode=statedump from time to time and starting opentracker with the -l option later. ** livesync thread has its own ot_workstruct now So it can behave like ot_udp and ot_http against trackerlogic.c and get rid of the first half of the embarrassing global variables. The sending half will be fixed soon [tm]. ** stats can log completed events The author recognizes the needs of original content distributors to keep track of the amount of times a work has been downloaded. While not feasible and used on openbittorrent and other open and anonymous tracker installations, a tracker user can now choose to send those events to syslog.
2010-04-22 22:08:42 +00:00
void livesync_tell( struct ot_workstruct *ws );
/* Tickle the live sync module from time to time, so no events get
stuck when there's not enough traffic to fill udp packets fast
enough */
void livesync_ticker( );
/* Handle an incoming live sync packet */
void handle_livesync( const int64 sock );
2008-10-28 01:27:21 +00:00
/* If no syncing is required, save calling code from #ifdef
constructions */
2008-12-07 03:50:47 +00:00
#define livesync_deinit()
#define livesync_init()
#define livesync_ticker()
#define handle_livesync(a)