1
0
Fork 0
mirror of https://github.com/transmission/transmission synced 2024-12-26 01:27:28 +00:00
transmission/libtransmission/makemeta.h
Jordan Lee 879a2afcbd Update the copyright year in the source code comments.
The Berne Convention says that the copyright year is moot, so instead of adding another year to each file as in previous years, I've removed the year altogether from the source code comments in libtransmission, gtk, qt, utils, daemon, and cli.

Juliusz's copyright notice in tr-dht and Johannes' copyright notice in tr-lpd have been left alone; it didn't seem appropriate to modify them.
2011-01-19 13:48:47 +00:00

127 lines
3.6 KiB
C

/*
* This file Copyright (C) Mnemosyne LLC
*
* 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_MAKEMETA_H
#define TR_MAKEMETA_H 1
#ifdef __cplusplus
extern "C" {
#endif
typedef struct tr_metainfo_builder_file
{
char * filename;
uint64_t size;
}
tr_metainfo_builder_file;
typedef enum
{
TR_MAKEMETA_OK,
TR_MAKEMETA_URL,
TR_MAKEMETA_CANCELLED,
TR_MAKEMETA_IO_READ, /* see builder.errfile, builder.my_errno */
TR_MAKEMETA_IO_WRITE /* see builder.errfile, builder.my_errno */
}
tr_metainfo_builder_err;
typedef struct tr_metainfo_builder
{
/**
*** These are set by tr_makeMetaInfoBuilderCreate()
*** and cleaned up by tr_metaInfoBuilderFree()
**/
char * top;
tr_metainfo_builder_file * files;
uint64_t totalSize;
uint32_t fileCount;
uint32_t pieceSize;
uint32_t pieceCount;
int isSingleFile;
/**
*** These are set inside tr_makeMetaInfo()
*** by copying the arguments passed to it,
*** and cleaned up by tr_metaInfoBuilderFree()
**/
tr_tracker_info * trackers;
int trackerCount;
char * comment;
char * outputFile;
int isPrivate;
/**
*** These are set inside tr_makeMetaInfo() so the client
*** can poll periodically to see what the status is.
*** The client can also set abortFlag to nonzero to
*** tell tr_makeMetaInfo() to abort and clean up after itself.
**/
uint32_t pieceIndex;
int abortFlag;
int isDone;
tr_metainfo_builder_err result;
/* file in use when result was set to _IO_READ or _IO_WRITE,
* or the URL in use when the result was set to _URL */
char errfile[2048];
/* errno encountered when result was set to _IO_READ or _IO_WRITE */
int my_errno;
/**
*** This is an implementation detail.
*** The client should never use these fields.
**/
struct tr_metainfo_builder * nextBuilder;
}
tr_metainfo_builder;
tr_metainfo_builder*tr_metaInfoBuilderCreate( const char * topFile );
void tr_metaInfoBuilderFree( tr_metainfo_builder* );
/**
* @brief create a new .torrent file
*
* This is actually done in a worker thread, not the main thread!
* Otherwise the client's interface would lock up while this runs.
*
* It is the caller's responsibility to poll builder->isDone
* from time to time! When the worker thread sets that flag,
* the caller must pass the builder to tr_metaInfoBuilderFree().
*
* @param outputFile if NULL, builder->top + ".torrent" will be used.
* @param trackers An array of trackers, sorted by tier from first to last.
* NOTE: only the `tier' and `announce' fields are used.
*
* @param trackerCount size of the `trackers' array
*/
void tr_makeMetaInfo( tr_metainfo_builder * builder,
const char * outputFile,
const tr_tracker_info * trackers,
int trackerCount,
const char * comment,
int isPrivate );
#ifdef __cplusplus
}
#endif
#endif