tnt-retrieval

tnt-retrieval —

Synopsis




#define     TNT_RETRIEVAL                   (object)
struct      TntRetrieval;
gboolean    tnt_retrieval_init              (TntRetrieval *retrieval,
                                             const TntFileID *file_id);
TntRetrieval* tnt_retrieval_new             (const TntFileID *file_id);
void        tnt_retrieval_finalize          (FluxObject *retrieval);
const TntFileID* tnt_retrieval_get_file_id  (TntRetrieval *retrieval);
TntFileMeta* tnt_retrieval_get_file_meta    (TntRetrieval *retrieval);
void        tnt_retrieval_set_file_meta     (TntRetrieval *retrieval,
                                             TntFileMeta *file_meta);
TntFileBitmap* tnt_retrieval_get_local_bitmap
                                            (TntRetrieval *retrieval);
void        tnt_retrieval_set_local_bitmap  (TntRetrieval *retrieval,
                                             TntFileBitmap *file_bitmap);
void        tnt_retrieval_update_remote_bitmap
                                            (TntRetrieval *retrieval,
                                             TntNodeID node_id,
                                             TntFileBitmap *file_bitmap);
TntFileBitmap* tnt_retrieval_get_remote_bitmap
                                            (TntRetrieval *retrieval,
                                             TntNodeID node_id);
void        tnt_retrieval_queued            (TntRetrieval *retrieval,
                                             TntNodeID node_id,
                                             gint block_id,
                                             TntTimeStamp remote_timestamp);
void        tnt_retrieval_unqueued          (TntRetrieval *retrieval,
                                             TntNodeID node_id,
                                             gint block_id,
                                             TntTimeStamp remote_timestamp);
void        tnt_retrieval_got_block         (TntRetrieval *retrieval,
                                             gint block_id);
void        tnt_retrieval_set_active        (TntRetrieval *retrieval,
                                             gboolean state);
gboolean    tnt_retrieval_is_active         (TntRetrieval *retrieval);
gboolean    tnt_retrieval_is_complete       (TntRetrieval *retrieval);
guint       tnt_retrieval_get_source_count  (TntRetrieval *retrieval);
guchar      tnt_retrieval_get_block_saturation
                                            (TntRetrieval *retrieval,
                                             gint block_id);
TntNodeID   tnt_retrieval_get_block_asked   (TntRetrieval *retrieval,
                                             gint block_id);
TntNodeID   tnt_retrieval_get_block_queued  (TntRetrieval *retrieval,
                                             gint block_id);
TntNodeID   tnt_retrieval_get_block_unqueued
                                            (TntRetrieval *retrieval,
                                             gint block_id);
GSList*     tnt_retrieval_get_busy_sources  (TntRetrieval *retrieval);
gboolean    tnt_retrieval_ask_block         (TntRetrieval *retrieval,
                                             GSList *busy_list,
                                             TntNodeID *node_id,
                                             gint *block_id);
void        tnt_retrieval_set_cps_in        (TntRetrieval *retrieval,
                                             guint cps_in);
guint       tnt_retrieval_get_cps_in        (TntRetrieval *retrieval);
void        tnt_retrieval_set_update_func   (TntRetrieval *retrieval,
                                             TntRetrievalFunc *func,
                                             gpointer data);
void        tnt_retrieval_set_completed_func
                                            (TntRetrieval *retrieval,
                                             TntRetrievalFunc *func,
                                             gpointer data);
void        tnt_retrieval_set_status_change_func
                                            (TntRetrieval *retrieval,
                                             TntRetrievalFunc *func,
                                             gpointer data);

Description

Details

TNT_RETRIEVAL()

#define TNT_RETRIEVAL(object) ((TntRetrieval *) object)

object :

struct TntRetrieval

struct TntRetrieval {

  FluxObject         object;

  TntFileID          file_id;
  TntFileMeta       *file_meta;
  TntFileBitmap     *local_bitmap;
  GSList            *remote_sources;

  guint              is_active : 1;
  guint              cps_in;

  gint               eta;
  TntTimeStamp       eta_timestamp;
  GArray            *history;

  gchar             *target_path;

  TntRetrievalFunc  *update_func;
  gpointer           update_func_data;

  TntRetrievalFunc  *completed_func;
  gpointer           completed_func_data;

  TntRetrievalFunc  *status_change_func;
  gpointer           status_change_func_data;
};


tnt_retrieval_init ()

gboolean    tnt_retrieval_init              (TntRetrieval *retrieval,
                                             const TntFileID *file_id);

retrieval :
file_id :
Returns :

tnt_retrieval_new ()

TntRetrieval* tnt_retrieval_new             (const TntFileID *file_id);

file_id :
Returns :

tnt_retrieval_finalize ()

void        tnt_retrieval_finalize          (FluxObject *retrieval);

retrieval :

tnt_retrieval_get_file_id ()

const TntFileID* tnt_retrieval_get_file_id  (TntRetrieval *retrieval);

retrieval :
Returns :

tnt_retrieval_get_file_meta ()

TntFileMeta* tnt_retrieval_get_file_meta    (TntRetrieval *retrieval);

retrieval :
Returns :

tnt_retrieval_set_file_meta ()

void        tnt_retrieval_set_file_meta     (TntRetrieval *retrieval,
                                             TntFileMeta *file_meta);

retrieval :
file_meta :

tnt_retrieval_get_local_bitmap ()

TntFileBitmap* tnt_retrieval_get_local_bitmap
                                            (TntRetrieval *retrieval);

retrieval :
Returns :

tnt_retrieval_set_local_bitmap ()

void        tnt_retrieval_set_local_bitmap  (TntRetrieval *retrieval,
                                             TntFileBitmap *file_bitmap);

retrieval :
file_bitmap :

tnt_retrieval_update_remote_bitmap ()

void        tnt_retrieval_update_remote_bitmap
                                            (TntRetrieval *retrieval,
                                             TntNodeID node_id,
                                             TntFileBitmap *file_bitmap);

retrieval :
node_id :
file_bitmap :

tnt_retrieval_get_remote_bitmap ()

TntFileBitmap* tnt_retrieval_get_remote_bitmap
                                            (TntRetrieval *retrieval,
                                             TntNodeID node_id);

retrieval :
node_id :
Returns :

tnt_retrieval_queued ()

void        tnt_retrieval_queued            (TntRetrieval *retrieval,
                                             TntNodeID node_id,
                                             gint block_id,
                                             TntTimeStamp remote_timestamp);

retrieval :
node_id :
block_id :
remote_timestamp :

tnt_retrieval_unqueued ()

void        tnt_retrieval_unqueued          (TntRetrieval *retrieval,
                                             TntNodeID node_id,
                                             gint block_id,
                                             TntTimeStamp remote_timestamp);

retrieval :
node_id :
block_id :
remote_timestamp :

tnt_retrieval_got_block ()

void        tnt_retrieval_got_block         (TntRetrieval *retrieval,
                                             gint block_id);

retrieval :
block_id :

tnt_retrieval_set_active ()

void        tnt_retrieval_set_active        (TntRetrieval *retrieval,
                                             gboolean state);

retrieval :
state :

tnt_retrieval_is_active ()

gboolean    tnt_retrieval_is_active         (TntRetrieval *retrieval);

retrieval :
Returns :

tnt_retrieval_is_complete ()

gboolean    tnt_retrieval_is_complete       (TntRetrieval *retrieval);

retrieval :
Returns :

tnt_retrieval_get_source_count ()

guint       tnt_retrieval_get_source_count  (TntRetrieval *retrieval);

retrieval :
Returns :

tnt_retrieval_get_block_saturation ()

guchar      tnt_retrieval_get_block_saturation
                                            (TntRetrieval *retrieval,
                                             gint block_id);

retrieval :
block_id :
Returns :

tnt_retrieval_get_block_asked ()

TntNodeID   tnt_retrieval_get_block_asked   (TntRetrieval *retrieval,
                                             gint block_id);

retrieval :
block_id :
Returns :

tnt_retrieval_get_block_queued ()

TntNodeID   tnt_retrieval_get_block_queued  (TntRetrieval *retrieval,
                                             gint block_id);

retrieval :
block_id :
Returns :

tnt_retrieval_get_block_unqueued ()

TntNodeID   tnt_retrieval_get_block_unqueued
                                            (TntRetrieval *retrieval,
                                             gint block_id);

retrieval :
block_id :
Returns :

tnt_retrieval_get_busy_sources ()

GSList*     tnt_retrieval_get_busy_sources  (TntRetrieval *retrieval);

retrieval :
Returns :

tnt_retrieval_ask_block ()

gboolean    tnt_retrieval_ask_block         (TntRetrieval *retrieval,
                                             GSList *busy_list,
                                             TntNodeID *node_id,
                                             gint *block_id);

retrieval :
busy_list :
node_id :
block_id :
Returns :

tnt_retrieval_set_cps_in ()

void        tnt_retrieval_set_cps_in        (TntRetrieval *retrieval,
                                             guint cps_in);

retrieval :
cps_in :

tnt_retrieval_get_cps_in ()

guint       tnt_retrieval_get_cps_in        (TntRetrieval *retrieval);

retrieval :
Returns :

tnt_retrieval_set_update_func ()

void        tnt_retrieval_set_update_func   (TntRetrieval *retrieval,
                                             TntRetrievalFunc *func,
                                             gpointer data);

retrieval :
func :
data :

tnt_retrieval_set_completed_func ()

void        tnt_retrieval_set_completed_func
                                            (TntRetrieval *retrieval,
                                             TntRetrievalFunc *func,
                                             gpointer data);

retrieval :
func :
data :

tnt_retrieval_set_status_change_func ()

void        tnt_retrieval_set_status_change_func
                                            (TntRetrieval *retrieval,
                                             TntRetrievalFunc *func,
                                             gpointer data);

retrieval :
func :
data :