transmission/libtransmission/tracker.h

/*
 * This file Copyright (C) 2007 Charles Kerr <charles@rebelbase.com>
 *
 * This file is licensed by the GPL version 2.  Works owned by the
 * Transmission project are granted a special exemption to clause 2(b)
 * so that the bulk of its code can remain under the MIT license. 
 * This exemption does not extend to derived works not owned by
 * the Transmission project.
 *
 * $Id$
 */

#ifndef _TR_TRACKER_H_
#define _TR_TRACKER_H_

#include <inttypes.h> /* for uint8_t */
#include "transmission.h"
#include "publish.h"

/**
***  Locating a tracker
**/

struct tr_tracker_s * tr_trackerNew( tr_torrent_t * );

void  tr_trackerFree ( struct tr_tracker_s * );

/**
***  Tracker Publish / Subscribe
**/

typedef enum
{
    TR_TRACKER_WARNING,
    TR_TRACKER_ERROR,
    TR_TRACKER_PEERS,
    TR_TRACKER_STOPPED
}
TrackerEventType;

typedef struct
{
    /* what type of event this is */
    TrackerEventType messageType;

    /* the torrent's 20-character sha1 hash */
    const uint8_t * hash;

    /* for TR_TRACKER_WARNING and TR_TRACKER_ERROR */
    const char * text;

    /* for TR_TRACKER_PEERS */
    const uint8_t * peerCompact;
    int peerCount;
}
tr_tracker_event_t;

tr_publisher_tag  tr_trackerSubscribe         ( struct tr_tracker_s * tag,
                                                tr_delivery_func      func,
                                                void                * user );

void              tr_trackerUnsubscribe       ( struct tr_tracker_s * tracker,
                                                tr_publisher_tag      tag );

/***
****
***/

void tr_trackerStart                          ( struct tr_tracker_s * );

void tr_trackerCompleted                      ( struct tr_tracker_s * );

void tr_trackerStop                           ( struct tr_tracker_s * );

void tr_trackerReannounce                     ( struct tr_tracker_s * );

void tr_trackerChangeMyPort                   ( struct tr_tracker_s * );

const tr_tracker_info_t * tr_trackerGetAddress( const struct tr_tracker_s * );

int  tr_trackerCanManualAnnounce              ( const struct tr_tracker_s * );

void tr_trackerGetCounts                      ( const struct tr_tracker_s *,
                                                int * setme_completedCount,
                                                int * setme_leecherCount,
                                                int * setme_seederCount );

#endif