Changeset 7534


Ignore:
Timestamp:
Dec 29, 2008, 9:19:31 PM (12 years ago)
Author:
charles
Message:

(trunk libT) fix obsolete `iobuf' reference. (wereHamster)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/libtransmission/bandwidth.h

    r7493 r7534  
    88 * the Transmission project.
    99 *
    10  * $Id:$
     10 * $Id$
    1111 */
    1212
     
    1717#ifndef TR_BANDWIDTH_H
    1818#define TR_BANDWIDTH_H
    19 
    20 struct tr_iobuf;
    2119
    2220/**
     
    5048 *   speed and will decide how many bytes to make available over the
    5149 *   user-specified period to reach the user-specified desired speed.
    52  *   If appropriate, it notifies its iobufs that new bandwidth is available.
     50 *   If appropriate, it notifies its peer-ios that new bandwidth is available.
    5351 *
    5452 *   tr_bandwidthAllocate() operates on the tr_bandwidth subtree, so usually
    5553 *   you'll only need to invoke it for the top-level tr_session bandwidth.
    5654 *
    57  *   The iobufs all have a pointer to their associated tr_bandwidth object,
     55 *   The peer-ios all have a pointer to their associated tr_bandwidth object,
    5856 *   and call tr_bandwidthClamp() before performing I/O to see how much
    5957 *   bandwidth they can safely use.
     
    10098
    10199/**
    102  * @brief Set whether or not this bandwidth should throttle its iobufs' speeds
     100 * @brief Set whether or not this bandwidth should throttle its peer-io's speeds
    103101 */
    104102void    tr_bandwidthSetLimited        ( tr_bandwidth        * bandwidth,
     
    107105
    108106/**
    109  * @return nonzero if this bandwidth throttles its iobufs' speeds
     107 * @return nonzero if this bandwidth throttles its peer-ios speeds
    110108 */
    111109tr_bool tr_bandwidthIsLimited         ( const tr_bandwidth  * bandwidth,
     
    113111
    114112/**
    115  * @brief allocate the next period_msec's worth of bandwidth for the iobufs to consume
     113 * @brief allocate the next period_msec's worth of bandwidth for the peer-ios to consume
    116114 */
    117115void    tr_bandwidthAllocate          ( tr_bandwidth        * bandwidth,
     
    144142/**
    145143 * @brief Notify the bandwidth object that some of its allocated bandwidth has been consumed.
    146  * This is is usually invoked by the iobuf after a read or write.
     144 * This is is usually invoked by the peer-io after a read or write.
    147145 */
    148146void    tr_bandwidthUsed              ( tr_bandwidth        * bandwidth,
     
    180178
    181179/**
    182  * @brief remove an iobuf from this bandwidth's list of iobufs.
     180 * @brief remove a peer-io from this bandwidth's list.
    183181 */
    184182void    tr_bandwidthRemovePeer        ( tr_bandwidth        * bandwidth,
Note: See TracChangeset for help on using the changeset viewer.