transmission/libtransmission/ratecontrol.h

/******************************************************************************
 * $Id$
 *
 * Copyright (c) 2006-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_RATECONTROL_H_
#define _TR_RATECONTROL_H_

typedef struct tr_ratecontrol tr_ratecontrol;

tr_ratecontrol * tr_rcInit( void );
void             tr_rcSetLimit( tr_ratecontrol *, int );
int              tr_rcGetLimit( const tr_ratecontrol * );
size_t           tr_rcBytesLeft( const tr_ratecontrol * );
void             tr_rcTransferred( tr_ratecontrol *, size_t byteCount );
float            tr_rcRate( const tr_ratecontrol * );
void             tr_rcReset( tr_ratecontrol * );
void             tr_rcClose( tr_ratecontrol * );

#endif