transmission/libtransmission/session.h

/******************************************************************************
 * $Id$
 *
 * Copyright (c) 2005-2008 Transmission authors and contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *****************************************************************************/

#ifndef TR_INTERNAL_H
#define TR_INTERNAL_H 1

#define TR_NAME "Transmission"

#ifndef UNUSED
#ifdef __GNUC__
#define UNUSED __attribute__((unused))
#else
#define UNUSED
#endif
#endif

typedef enum { TR_NET_OK, TR_NET_ERROR, TR_NET_WAIT } tr_tristate_t;

uint8_t* tr_peerIdNew( void );

const uint8_t* tr_getPeerId( void );

struct tr_metainfo_lookup
{
    char hashString[2*SHA_DIGEST_LENGTH+1];
    char * filename;
};

struct tr_handle
{
    unsigned int                 isPortSet        : 1;
    unsigned int                 isPexEnabled     : 1;
    unsigned int                 isClosed         : 1;
    unsigned int                 useUploadLimit   : 1;
    unsigned int                 useDownloadLimit : 1;

    tr_encryption_mode           encryptionMode;

    struct tr_event_handle     * events;

    int                          peerSocketTOS;

    int                          torrentCount;
    tr_torrent                 * torrentList;

    char                       * tag;

    char                       * configDir;
    char                       * downloadDir;
    char                       * resumeDir;
    char                       * torrentDir;

    struct tr_ratecontrol      * upload;
    struct tr_ratecontrol      * download;

    struct tr_blocklist        * blocklist;
    struct tr_peerMgr          * peerMgr;
    struct tr_shared           * shared;

    struct tr_lock             * lock;

    struct tr_web              * web;

    struct tr_rpc_server       * rpcServer;
    tr_rpc_func                  rpc_func;
    void                       * rpc_func_user_data;

    struct tr_stats_handle     * sessionStats;
    struct tr_tracker_handle   * tracker;

    struct tr_metainfo_lookup  * metainfoLookup;
    int                          metainfoLookupCount;
};

typedef struct tr_handle tr_session;

const char * tr_sessionFindTorrentFile( const tr_session * session,
                                        const char       * hashString );

void tr_sessionSetTorrentFile( tr_session   * session,
                               const char   * hashString,
                               const char   * filename );

void tr_globalLock       ( tr_session * );
void tr_globalUnlock     ( tr_session * );
int  tr_globalIsLocked   ( const tr_session * );


#define TR_ERROR_IS_IO(e) (TR_ERROR_IO_PARENT<=(e) && (e)<=TR_ERROR_IO_OTHER)
#define TR_ERROR_IS_TC(e) (TR_ERROR_TC_ERROR<=(e) && (e)<=TR_ERROR_TC_WARNING)


#endif