[Spice-commits] 2 commits - doc/reference src/spice-file-transfer-task.c

[Pavel Grunt]

 doc/reference/spice-gtk-sections.txt |    2 +
 src/spice-file-transfer-task.c       |   51 ++++++++++++++++++++++++++---------
 2 files changed, 41 insertions(+), 12 deletions(-)

New commits:
commit a04e103716ac47df21a21517d0f7a5f227393c44
Author: Pavel Grunt <pgrunt at redhat.com>
Date:   Thu Sep 1 11:30:04 2016 +0200

    file-transfer: Add guards to public functions
    
    Acked-by: Victor Toso <victortoso at redhat.com>

diff --git a/src/spice-file-transfer-task.c b/src/spice-file-transfer-task.c
index 2d42b61..d0170da 100644
--- a/src/spice-file-transfer-task.c
+++ b/src/spice-file-transfer-task.c
@@ -503,6 +503,8 @@ gboolean spice_file_transfer_task_is_completed(SpiceFileTransferTask *self)
  **/
 double spice_file_transfer_task_get_progress(SpiceFileTransferTask *self)
 {
+    g_return_val_if_fail(SPICE_IS_FILE_TRANSFER_TASK(self), 0.0);
+
     if (self->file_size == 0)
         return 0.0;
 
@@ -522,6 +524,8 @@ double spice_file_transfer_task_get_progress(SpiceFileTransferTask *self)
  **/
 void spice_file_transfer_task_cancel(SpiceFileTransferTask *self)
 {
+    g_return_if_fail(SPICE_IS_FILE_TRANSFER_TASK(self));
+
     g_cancellable_cancel(self->cancellable);
 }
 
@@ -537,6 +541,8 @@ void spice_file_transfer_task_cancel(SpiceFileTransferTask *self)
  **/
 char* spice_file_transfer_task_get_filename(SpiceFileTransferTask *self)
 {
+    g_return_val_if_fail(SPICE_IS_FILE_TRANSFER_TASK(self), NULL);
+
     return g_file_get_basename(self->file);
 }
 
@@ -552,7 +558,7 @@ char* spice_file_transfer_task_get_filename(SpiceFileTransferTask *self)
  **/
 guint64 spice_file_transfer_task_get_total_bytes(SpiceFileTransferTask *self)
 {
-    g_return_val_if_fail(self != NULL, 0);
+    g_return_val_if_fail(SPICE_IS_FILE_TRANSFER_TASK(self), 0);
     return self->file_size;
 }
 
@@ -569,7 +575,7 @@ guint64 spice_file_transfer_task_get_total_bytes(SpiceFileTransferTask *self)
  **/
 guint64 spice_file_transfer_task_get_transferred_bytes(SpiceFileTransferTask *self)
 {
-    g_return_val_if_fail(self != NULL, 0);
+    g_return_val_if_fail(SPICE_IS_FILE_TRANSFER_TASK(self), 0);
     return self->read_bytes;
 }
 
commit 74ce2dd22763e49870cd610d067b01fbb27a2830
Author: Pavel Grunt <pgrunt at redhat.com>
Date:   Thu Sep 1 11:22:28 2016 +0200

    file-transfer: Add documentation for public functions
    
    Acked-by: Victor Toso <victortoso at redhat.com>

diff --git a/doc/reference/spice-gtk-sections.txt b/doc/reference/spice-gtk-sections.txt
index df58297..386e737 100644
--- a/doc/reference/spice-gtk-sections.txt
+++ b/doc/reference/spice-gtk-sections.txt
@@ -511,6 +511,8 @@ SpiceWebdavChannelPrivate
 <SUBSECTION>
 spice_file_transfer_task_get_progress
 spice_file_transfer_task_get_filename
+spice_file_transfer_task_get_total_bytes
+spice_file_transfer_task_get_transferred_bytes
 spice_file_transfer_task_cancel
 <SUBSECTION Standard>
 SPICE_FILE_TRANSFER_TASK
diff --git a/src/spice-file-transfer-task.c b/src/spice-file-transfer-task.c
index aa9d95b..2d42b61 100644
--- a/src/spice-file-transfer-task.c
+++ b/src/spice-file-transfer-task.c
@@ -352,18 +352,6 @@ GCancellable *spice_file_transfer_task_get_cancellable(SpiceFileTransferTask *se
     return self->cancellable;
 }
 
-guint64 spice_file_transfer_task_get_total_bytes(SpiceFileTransferTask *self)
-{
-    g_return_val_if_fail(self != NULL, 0);
-    return self->file_size;
-}
-
-guint64 spice_file_transfer_task_get_transferred_bytes(SpiceFileTransferTask *self)
-{
-    g_return_val_if_fail(self != NULL, 0);
-    return self->read_bytes;
-}
-
 /* Helper function which only creates a SpiceFileTransferTask per GFile
  * in @files and returns a HashTable mapping task-id to the task itself
  * The SpiceFileTransferTask created here has two references, one should be
@@ -552,6 +540,39 @@ char* spice_file_transfer_task_get_filename(SpiceFileTransferTask *self)
     return g_file_get_basename(self->file);
 }
 
+/**
+ * spice_file_transfer_task_get_total_bytes:
+ * @self: a file transfer task
+ *
+ * Gets the total size in bytes of the file transfer.
+ *
+ * Returns: The total size of the file transfer
+ *
+ * Since: 0.33
+ **/
+guint64 spice_file_transfer_task_get_total_bytes(SpiceFileTransferTask *self)
+{
+    g_return_val_if_fail(self != NULL, 0);
+    return self->file_size;
+}
+
+
+/**
+ * spice_file_transfer_task_get_transferred_bytes:
+ * @self: a file transfer task
+ *
+ * Gets the number of bytes that have been transferred so far.
+ *
+ * Returns: The number of transferred bytes
+ *
+ * Since: 0.33
+ **/
+guint64 spice_file_transfer_task_get_transferred_bytes(SpiceFileTransferTask *self)
+{
+    g_return_val_if_fail(self != NULL, 0);
+    return self->read_bytes;
+}
+
 /*******************************************************************************
  * GObject
  ******************************************************************************/