Changeset 7021


Ignore:
Timestamp:
Nov 2, 2008, 10:21:59 PM (12 years ago)
Author:
charles
Message:

(libT) tr_handle --> tr_session

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/libtransmission/transmission.h

    r6949 r7021  
    250250 * @see tr_sessionClose()
    251251 */
    252 tr_handle * tr_sessionInitFull( const char *       configDir,
    253                                 const char *       tag,
    254                                 const char *       downloadDir,
    255                                 int                isPexEnabled,
    256                                 int                isPortForwardingEnabled,
    257                                 int                publicPort,
    258                                 tr_encryption_mode encryptionMode,
    259                                 int                useLazyBitfield,
    260                                 int                useUploadLimit,
    261                                 int                uploadLimit,
    262                                 int                useDownloadLimit,
    263                                 int                downloadLimit,
    264                                 int                peerLimit,
    265                                 int                messageLevel,
    266                                 int                isMessageQueueingEnabled,
    267                                 int                isBlocklistEnabled,
    268                                 int                peerSocketTOS,
    269                                 int                rpcIsEnabled,
    270                                 uint16_t           rpcPort,
    271                                 int                rpcWhitelistIsEnabled,
    272                                 const char *       rpcWhitelist,
    273                                 int                rpcPasswordIsEnabled,
    274                                 const char *       rpcUsername,
    275                                 const char *       rpcPassword,
    276                                 int                proxyIsEnabled,
    277                                 const char *       proxy,
    278                                 int                proxyPort,
    279                                 tr_proxy_type      proxyType,
    280                                 int                proxyAuthIsEnabled,
    281                                 const char *       proxyUsername,
    282                                 const char *       proxyPassword );
     252tr_session * tr_sessionInitFull( const char *       configDir,
     253                                 const char *       tag,
     254                                 const char *       downloadDir,
     255                                 int                isPexEnabled,
     256                                 int                isPortForwardingEnabled,
     257                                 int                publicPort,
     258                                 tr_encryption_mode encryptionMode,
     259                                 int                useLazyBitfield,
     260                                 int                useUploadLimit,
     261                                 int                uploadLimit,
     262                                 int                useDownloadLimit,
     263                                 int                downloadLimit,
     264                                 int                peerLimit,
     265                                 int                messageLevel,
     266                                 int                isMessageQueueingEnabled,
     267                                 int                isBlocklistEnabled,
     268                                 int                peerSocketTOS,
     269                                 int                rpcIsEnabled,
     270                                 uint16_t           rpcPort,
     271                                 int                rpcWhitelistIsEnabled,
     272                                 const char *       rpcWhitelist,
     273                                 int                rpcPasswordIsEnabled,
     274                                 const char *       rpcUsername,
     275                                 const char *       rpcPassword,
     276                                 int                proxyIsEnabled,
     277                                 const char *       proxy,
     278                                 int                proxyPort,
     279                                 tr_proxy_type      proxyType,
     280                                 int                proxyAuthIsEnabled,
     281                                 const char *       proxyUsername,
     282                                 const char *       proxyPassword );
    283283
    284284
    285285/** @brief Shorter form of tr_sessionInitFull()
    286286    @deprecated Use tr_sessionInitFull() instead. */
    287 tr_handle *  tr_sessionInit( const char * configDir,
    288                              const char * downloadDir,
    289                              const char * tag );
     287tr_session *  tr_sessionInit( const char * configDir,
     288                              const char * downloadDir,
     289                              const char * tag );
    290290
    291291/** @brief End a libtransmission session
    292292    @see tr_sessionInitFull() */
    293 void         tr_sessionClose( tr_handle * );
     293void         tr_sessionClose( tr_session * );
    294294
    295295/**
     
    299299 * blocklists, etc.
    300300 */
    301 const char * tr_sessionGetConfigDir( const tr_handle * );
     301const char * tr_sessionGetConfigDir( const tr_session * );
    302302
    303303/**
     
    307307 * @see tr_ctorSetDownloadDir()
    308308 */
    309 void         tr_sessionSetDownloadDir(
    310     tr_handle *,
    311     const char *
    312     downloadDir );
     309void tr_sessionSetDownloadDir( tr_session  * session,
     310                               const char  * downloadDir );
    313311
    314312/**
     
    318316 * and can be overridden on a per-torrent basis by tr_ctorSetDownloadDir().
    319317 */
    320 const char * tr_sessionGetDownloadDir( const tr_handle * );
     318const char * tr_sessionGetDownloadDir( const tr_session * session );
    321319
    322320/**
     
    329327 * queried by tr_sessionIsRPCEnabled().
    330328 */
    331 void tr_sessionSetRPCEnabled(                     tr_handle *,
    332                                               int isEnabled );
     329void tr_sessionSetRPCEnabled( tr_session  * session,
     330                              int          isEnabled );
    333331
    334332/** @brief Get whether or not RPC calls are allowed in this session.
    335333    @see tr_sessionInitFull()
    336334    @see tr_sessionSetRPCEnabled() */
    337 int  tr_sessionIsRPCEnabled( const tr_handle * handle );
     335int  tr_sessionIsRPCEnabled( const tr_session * session );
    338336
    339337/** @brief Specify which port to listen for RPC requests on.
    340338    @see tr_sessionInitFull()
    341339    @see tr_sessionGetRPCPort */
    342 void tr_sessionSetRPCPort( tr_handle * session,
    343                            uint16_t port );
     340void tr_sessionSetRPCPort( tr_session * session,
     341                           uint16_t      port );
    344342
    345343/** @brief Get which port to listen for RPC requests on.
    346344    @see tr_sessionInitFull()
    347345    @see tr_sessionSetRPCPort */
    348 uint16_t  tr_sessionGetRPCPort( const tr_handle * );
     346uint16_t  tr_sessionGetRPCPort( const tr_session * session );
    349347
    350348/**
     
    507505 * In public torrents, PEX is enabled by default.
    508506 */
    509 void               tr_sessionSetPexEnabled(                 tr_session *,
    510                                                         int isEnabled );
    511 
    512 int                tr_sessionIsPexEnabled( const tr_session * );
    513 
    514 void               tr_sessionSetLazyBitfieldEnabled( tr_handle * handle,
    515                                                      int         enabled );
    516 
    517 int                tr_sessionIsLazyBitfieldEnabled(
    518     const tr_handle * handle );
    519 
    520 tr_encryption_mode tr_sessionGetEncryption( tr_session * );
    521 
    522 void               tr_sessionSetEncryption(
    523                        tr_session *,
    524     tr_encryption_mode mode );
     507void               tr_sessionSetPexEnabled( tr_session  * session,
     508                                            int           isEnabled );
     509
     510int                tr_sessionIsPexEnabled( const tr_session * session );
     511
     512void               tr_sessionSetLazyBitfieldEnabled( tr_session * session,
     513                                                     int          enabled );
     514
     515int                tr_sessionIsLazyBitfieldEnabled( const tr_session * session );
     516
     517tr_encryption_mode tr_sessionGetEncryption( tr_session * session );
     518
     519void               tr_sessionSetEncryption( tr_session          * session,
     520                                            tr_encryption_mode    mode );
    525521
    526522
     
    529525*/
    530526
    531 void               tr_sessionSetPortForwardingEnabled(
    532         tr_handle *,
    533     int enable );
    534 
    535 int                tr_sessionIsPortForwardingEnabled( const tr_handle * );
    536 
    537 void               tr_sessionSetPeerPort( tr_handle *,
    538                                           int );
    539 
    540 int                tr_sessionGetPeerPort( const tr_handle * );
     527void  tr_sessionSetPortForwardingEnabled( tr_session  * session,
     528                                          int           enabled );
     529
     530int   tr_sessionIsPortForwardingEnabled( const tr_session  * session );
     531
     532void  tr_sessionSetPeerPort( tr_session  * session,
     533                             int           port);
     534
     535int   tr_sessionGetPeerPort( const tr_session * session );
    541536
    542537typedef enum
     
    550545tr_port_forwarding;
    551546
    552 tr_port_forwarding tr_sessionGetPortForwarding( const tr_handle * );
    553 
    554 int                tr_sessionCountTorrents( const tr_handle * h );
     547tr_port_forwarding tr_sessionGetPortForwarding( const tr_session * session );
     548
     549int                tr_sessionCountTorrents( const tr_session * session );
    555550
    556551typedef enum
     
    561556tr_direction;
    562557
    563 void               tr_sessionSetSpeedLimitEnabled( tr_handle *  session,
    564                                                    tr_direction direction,
    565                                                    int          isEnabled );
    566 
    567 void               tr_sessionGetSpeed( const tr_handle * session,
    568                                        float *           overall_down_KiBs,
    569                                        float *           overall_up_KiBs );
    570 
    571 int                tr_sessionIsSpeedLimitEnabled(
    572     const tr_handle * session,
    573     tr_direction
    574                       direction );
    575 
    576 void               tr_sessionSetSpeedLimit( tr_handle *  session,
    577                                             tr_direction direction,
    578                                             int          KiB_sec );
    579 
    580 int                tr_sessionGetSpeedLimit( const tr_handle * session,
    581                                             tr_direction      direction );
    582 
    583 void               tr_sessionSetPeerLimit( tr_handle * handle,
    584                                            uint16_t    maxGlobalPeers );
    585 
    586 uint16_t           tr_sessionGetPeerLimit( const tr_handle * handle );
     558void       tr_sessionSetSpeedLimitEnabled( tr_session    * session,
     559                                           tr_direction    direction,
     560                                           int             isEnabled );
     561
     562void       tr_sessionGetSpeed( const tr_session  * session,
     563                               float             * overall_down_KiBs,
     564                               float             * overall_up_KiBs );
     565
     566int        tr_sessionIsSpeedLimitEnabled( const tr_session  * session,
     567                                          tr_direction       direction );
     568
     569void       tr_sessionSetSpeedLimit( tr_session     * session,
     570                                    tr_direction     direction,
     571                                    int              KiB_sec );
     572
     573int        tr_sessionGetSpeedLimit( const tr_session  * session,
     574                                    tr_direction        direction );
     575
     576void       tr_sessionSetPeerLimit( tr_session  * session,
     577                                   uint16_t      maxGlobalPeers );
     578
     579uint16_t   tr_sessionGetPeerLimit( const tr_session * session );
    587580
    588581
     
    592585 *  from the previous session.
    593586 */
    594 tr_torrent **      tr_sessionLoadTorrents( tr_handle * h,
    595                                            tr_ctor *   ctor,
    596                                            int *       setmeCount );
    597 
     587tr_torrent ** tr_sessionLoadTorrents( tr_session  * session,
     588                                      tr_ctor     * ctor,
     589                                      int         * setmeCount );
    598590
    599591/** @} */
    600 
    601592
    602593/**
     
    622613{
    623614    /* TR_MSG_ERR, TR_MSG_INF, or TR_MSG_DBG */
    624     uint8_t    level;
     615    uint8_t level;
    625616
    626617    /* The line number in the source file where this message originated */
    627     int    line;
     618    int line;
    628619
    629620    /* Time the message was generated */
    630     time_t    when;
     621    time_t when;
    631622
    632623    /* The torrent associated with this message,
     
    639630
    640631    /* The source file where this message originated */
    641     const char *  file;
     632    const char * file;
    642633
    643634    /* linked list of messages */
     
    728719struct tr_benc;
    729720
    730 tr_ctor*    tr_ctorNew( const tr_handle * handle );
     721tr_ctor*    tr_ctorNew( const tr_session * session );
    731722
    732723void        tr_ctorFree( tr_ctor * ctor );
     
    772763                              uint8_t *       setmeIsPaused );
    773764
    774 int         tr_ctorGetDownloadDir( const tr_ctor * ctor,
    775                                    tr_ctorMode     mode,
    776                                    const char **  setmeDownloadDir );
    777 
    778 int         tr_ctorGetMetainfo( const tr_ctor *        ctor,
     765int         tr_ctorGetDownloadDir( const tr_ctor  * ctor,
     766                                   tr_ctorMode      mode,
     767                                   const char    ** setmeDownloadDir );
     768
     769int         tr_ctorGetMetainfo( const tr_ctor         * ctor,
    779770                                const struct tr_benc ** setme );
    780771
    781 int         tr_ctorGetDeleteSource( const tr_ctor * ctor,
    782                                     uint8_t *      setmeDoDelete );
     772int         tr_ctorGetDeleteSource( const tr_ctor  * ctor,
     773                                    uint8_t        * setmeDoDelete );
    783774
    784775/* returns NULL if tr_ctorSetMetainfoFromFile() wasn't used */
     
    800791 * caller via tr_metainfoFree().
    801792 */
    802 int          tr_torrentParse( const tr_handle * handle,
    803                               const tr_ctor *  ctor,
    804                               tr_info *        setme_info_or_NULL );
     793int tr_torrentParse( const tr_session  * session,
     794                     const tr_ctor     * ctor,
     795                     tr_info           * setme_info_or_NULL );
    805796
    806797/** Instantiate a single torrent.
     
    808799            TR_EINVALID if the torrent couldn't be parsed, or
    809800            TR_EDUPLICATE if there's already a matching torrent object. */
    810 tr_torrent * tr_torrentNew( tr_handle *     handle,
    811                             const tr_ctor * ctor,
    812                             int *          setmeError );
     801tr_torrent * tr_torrentNew( tr_session      * session,
     802                            const tr_ctor   * ctor,
     803                            int             * setmeError );
    813804
    814805/** @} */
     
    824815/** @brief Frees memory allocated by tr_torrentNew().
    825816           Running torrents are stopped first.  */
    826 void        tr_torrentFree( tr_torrent * );
     817void tr_torrentFree( tr_torrent * torrent );
    827818
    828819/** @brief Removes our .torrent and .resume files for
    829820           this torrent, then calls tr_torrentFree(). */
    830 void        tr_torrentRemove( tr_torrent * );
     821void tr_torrentRemove( tr_torrent * torrent );
    831822
    832823/** @brief Start a torrent */
    833 void        tr_torrentStart( tr_torrent * );
     824void tr_torrentStart( tr_torrent * torrent );
    834825
    835826/** @brief Stop (pause) a torrent */
    836 void        tr_torrentStop( tr_torrent * );
     827void tr_torrentStop( tr_torrent * torrent );
    837828
    838829/**
     
    841832 * Pass in a NULL pointer to get the first torrent.
    842833 */
    843 tr_torrent* tr_torrentNext( tr_handle * session,
    844                                         tr_torrent * );
     834tr_torrent* tr_torrentNext( tr_session * session,
     835                            tr_torrent  * current );
    845836
    846837/**
     
    851842 * tr_info.hashString.
    852843 */
    853 int         tr_torrentId( const tr_torrent * );
     844int tr_torrentId( const tr_torrent * torrent );
    854845
    855846/****
     
    865856tr_speedlimit;
    866857
    867 void          tr_torrentSetSpeedMode( tr_torrent * tor,
    868                                       tr_direction  up_or_down,
    869                                       tr_speedlimit mode );
     858void          tr_torrentSetSpeedMode( tr_torrent     * tor,
     859                                      tr_direction     up_or_down,
     860                                      tr_speedlimit    mode );
    870861
    871862tr_speedlimit tr_torrentGetSpeedMode( const tr_torrent * tor,
    872863                                      tr_direction       direction );
    873864
    874 void          tr_torrentSetSpeedLimit( tr_torrent * tor,
    875                                        tr_direction up_or_down,
    876                                        int          KiB_sec );
    877 
    878 int           tr_torrentGetSpeedLimit( const tr_torrent * tor,
    879                                        tr_direction       direction );
     865void          tr_torrentSetSpeedLimit( tr_torrent    * tor,
     866                                       tr_direction    up_or_down,
     867                                       int             KiB_sec );
     868
     869int           tr_torrentGetSpeedLimit( const tr_torrent  * tor,
     870                                       tr_direction        direction );
    880871
    881872/****
     
    906897 * @param priority must be one of TR_PRI_NORMAL, _HIGH, or _LOW
    907898 */
    908 void tr_torrentSetFilePriorities( tr_torrent *      tor,
    909                                   tr_file_index_t * files,
    910                                   tr_file_index_t   fileCount,
    911                                   tr_priority_t     priority );
     899void tr_torrentSetFilePriorities( tr_torrent       * torrent,
     900                                  tr_file_index_t  * files,
     901                                  tr_file_index_t    fileCount,
     902                                  tr_priority_t      priority );
    912903
    913904/**
     
    918909 *         It's the caller's responsibility to free() this.
    919910 */
    920 tr_priority_t*  tr_torrentGetFilePriorities( const tr_torrent * );
     911tr_priority_t*  tr_torrentGetFilePriorities( const tr_torrent * torrent );
    921912
    922913/**
     
    924915 * @return TR_PRI_NORMAL, TR_PRI_HIGH, or TR_PRI_LOW.
    925916 */
    926 tr_priority_t   tr_torrentGetFilePriority( const           tr_torrent *,
    927                                            tr_file_index_t file );
     917tr_priority_t   tr_torrentGetFilePriority( const tr_torrent  * torrent,
     918                                           tr_file_index_t     file );
    928919
    929920/**
     
    931922 * @return true if the file's `download' flag is set.
    932923 */
    933 int             tr_torrentGetFileDL( const           tr_torrent *,
    934                                      tr_file_index_t file );
     924int tr_torrentGetFileDL( const tr_torrent  * torrent,
     925                         tr_file_index_t    file );
    935926
    936927/** @brief Set a batch of files to be downloaded or not. */
    937 void            tr_torrentSetFileDLs( tr_torrent *      tor,
    938                                       tr_file_index_t * files,
    939                                       tr_file_index_t   fileCount,
    940                                       int               do_download );
    941 
    942 
    943 const tr_info * tr_torrentInfo( const tr_torrent * );
    944 
    945 void            tr_torrentSetDownloadDir(                         tr_torrent *,
    946                                                             const char * );
    947 
    948 const char *    tr_torrentGetDownloadDir( const tr_torrent * );
     928void            tr_torrentSetFileDLs( tr_torrent       * torrent,
     929                                      tr_file_index_t  * files,
     930                                      tr_file_index_t    fileCount,
     931                                      int                do_download );
     932
     933
     934const tr_info * tr_torrentInfo( const tr_torrent * torrent );
     935
     936void tr_torrentSetDownloadDir( tr_torrent  * torrent,
     937                               const char  * path );
     938
     939const char * tr_torrentGetDownloadDir( const tr_torrent * torrent );
    949940
    950941/**
     
    10271018 */
    10281019
    1029 void tr_torrentManualUpdate( tr_torrent * );
    1030 
    1031 int  tr_torrentCanManualUpdate( const tr_torrent * );
     1020void tr_torrentManualUpdate( tr_torrent * torrent );
     1021
     1022int  tr_torrentCanManualUpdate( const tr_torrent * torrent );
    10321023
    10331024/***********************************************************************
     
    10761067 *         NOTE: always free this array with tr_free() when you're done with it.
    10771068 */
    1078 float*         tr_torrentWebSpeeds( const tr_torrent * tor );
     1069float*         tr_torrentWebSpeeds( const tr_torrent * torrent );
    10791070
    10801071typedef struct tr_file_stat
     
    10851076tr_file_stat;
    10861077
    1087 tr_file_stat * tr_torrentFiles( const tr_torrent * tor,
    1088                                 tr_file_index_t * fileCount );
    1089 
    1090 void           tr_torrentFilesFree( tr_file_stat *  stat,
    1091                                     tr_file_index_t fileCount );
     1078tr_file_stat * tr_torrentFiles( const tr_torrent  * torrent,
     1079                                tr_file_index_t   * fileCount );
     1080
     1081void tr_torrentFilesFree( tr_file_stat     * files,
     1082                          tr_file_index_t    fileCount );
    10921083
    10931084
     
    11001091 * of connected peers who have the piece.
    11011092 **********************************************************************/
    1102 void tr_torrentAvailability( const    tr_torrent *,
    1103                              int8_t * tab,
    1104                              int      size );
    1105 
    1106 void tr_torrentAmountFinished( const tr_torrent * tor,
    1107                                float *            tab,
    1108                                int                size );
    1109 
    1110 void tr_torrentVerify( tr_torrent * );
     1093void tr_torrentAvailability( const tr_torrent  * torrent,
     1094                             int8_t            * tab,
     1095                             int                  size );
     1096
     1097void tr_torrentAmountFinished( const tr_torrent  * torrent,
     1098                               float *             tab,
     1099                               int                 size );
     1100
     1101void tr_torrentVerify( tr_torrent * torrent );
    11111102
    11121103/***********************************************************************
     
    14031394    on the torrent.  This is typically called by the GUI clients every
    14041395    second or so to get a new snapshot of the torrent's status. */
    1405 const tr_stat * tr_torrentStat( tr_torrent * );
     1396const tr_stat * tr_torrentStat( tr_torrent * torrent );
    14061397
    14071398/** Like tr_torrentStat(), but only recalculates the statistics if it's
    14081399    been longer than a second since they were last calculated.  This can
    14091400    reduce the CPU load if you're calling tr_torrentStat() frequently. */
    1410 const tr_stat * tr_torrentStatCached( tr_torrent * );
     1401const tr_stat * tr_torrentStatCached( tr_torrent * torrent );
    14111402
    14121403/** @deprecated this method will be removed in 1.40 */
    1413 void            tr_torrentSetAddedDate( tr_torrent *,
    1414                                         time_t );
     1404void tr_torrentSetAddedDate( tr_torrent * torrent,
     1405                             time_t       addedDate );
    14151406
    14161407/** @deprecated this method will be removed in 1.40 */
    1417 void            tr_torrentSetActivityDate( tr_torrent *,
    1418                                            time_t );
     1408void tr_torrentSetActivityDate( tr_torrent * torrent,
     1409                                time_t       activityDate );
    14191410
    14201411/** @deprecated this method will be removed in 1.40 */
    1421 void            tr_torrentSetDoneDate( tr_torrent *,
    1422                                        time_t );
     1412void tr_torrentSetDoneDate( tr_torrent  * torrent,
     1413                            time_t        doneDate );
    14231414
    14241415/** @} */
Note: See TracChangeset for help on using the changeset viewer.