Changeset 310 for trunk/libtransmission/transmission.h

Timestamp:

Jun 9, 2006, 7:53:35 PM (16 years ago)

Author:

joshe

Message:

Add support to libtransmission and the MacOS X GUI for saving private copies of

torrent files.

File:

• trunk/libtransmission/transmission.h (modified) (6 diffs)

trunk/libtransmission/transmission.h

@@ -60 +60 @@
  * tr_getPrefsDirectory
  ***********************************************************************
- * Returns the full path to the directory used by libtransmission to
- * store the resume files. The string belongs to libtransmission, do
- * not free it.
+ * Returns the full path to a directory which can be used to store
+ * preferences. The string belongs to libtransmission, do not free it.
  **********************************************************************/
 char * tr_getPrefsDirectory();
@@ -124 +123 @@
  * valid torrent file, returns an handle and adds it to the list of
  * torrents (but doesn't start it). Returns NULL and sets *error
- * otherwise.
+ * otherwise.  If the TR_FSAVEPRIVATE flag is passed then a private copy
+ * of the torrent file will be saved.
  **********************************************************************/
 #define TR_EINVALID     1
@@ -131 +131 @@
 #define TR_EOTHER       666
 tr_torrent_t * tr_torrentInit( tr_handle_t *, const char * path,
-                               int * error );
+                               int flags, int * error );
+
+/***********************************************************************
+ * tr_torrentInitSaved
+ ***********************************************************************
+ * Opens and parses a torrent file as with tr_torrentInit, only taking
+ * the hash string of a saved torrent file instead of a filename.  There
+ * are currently no valid flags for this function.
+ **********************************************************************/
+tr_torrent_t * tr_torrentInitSaved( tr_handle_t *, const char * hashStr,
+                                    int flags, int * error );
 
 typedef struct tr_info_s tr_info_t;
@@ -202 +212 @@
 
 /***********************************************************************
+ * tr_torrentRemoveSaved
+ ***********************************************************************
+ * Removes the private saved copy of a torrent file for torrents which
+ * the TR_FSAVEPRIVATE flag is set.
+ **********************************************************************/
+void tr_torrentRemoveSaved( tr_torrent_t * );
+
+/***********************************************************************
  * tr_torrentClose
  ***********************************************************************
@@ -208 +226 @@
  **********************************************************************/
 void tr_torrentClose( tr_handle_t *, tr_torrent_t * );
-
 
 /***********************************************************************
@@ -226 +243 @@
     /* General info */
     uint8_t     hash[SHA_DIGEST_LENGTH];
+    char        hashString[2*SHA_DIGEST_LENGTH+1];
     char        name[MAX_PATH_LENGTH];
+
+    /* Flags */
+#define TR_FSAVEPRIVATE 0x01    /* save a private copy of the torrent */
+    int         flags;
 
     /* Tracker info */