summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJacob Smith <jake.smith@hdfgroup.org>2020-03-16 20:39:26 (GMT)
committerJacob Smith <jake.smith@hdfgroup.org>2020-03-16 20:39:26 (GMT)
commitf771958d757e388d9b9cebb21ca03f00505ada5b (patch)
tree85a6bcd5b6164f756bc25db53904c81ab3acb3b6
parentb65405439d88be6c09fe94360e7fea9856697926 (diff)
downloadhdf5-f771958d757e388d9b9cebb21ca03f00505ada5b.zip
hdf5-f771958d757e388d9b9cebb21ca03f00505ada5b.tar.gz
hdf5-f771958d757e388d9b9cebb21ca03f00505ada5b.tar.bz2
Add function header comment for `mirror_writer:run_writer()`.
-rw-r--r--utils/mirror_vfd/mirror_writer.c18
1 files changed, 17 insertions, 1 deletions
diff --git a/utils/mirror_vfd/mirror_writer.c b/utils/mirror_vfd/mirror_writer.c
index 9cd9b4c..fe5dac7 100644
--- a/utils/mirror_vfd/mirror_writer.c
+++ b/utils/mirror_vfd/mirror_writer.c
@@ -1033,7 +1033,23 @@ done:
} /* end process_instructions() */
-/* ------------------------------------------------------------------------- */
+/* ---------------------------------------------------------------------------
+ * Function: run_writer
+ *
+ * Purpose: Initiate Writer operations.
+ *
+ * Receives as parameters a socket which has accepted the
+ * connection to the Driver and the OPEN xmit (which must be
+ * decoded into the structure and verified prior to being passed
+ * to this function).
+ *
+ * Is not responsible for closing or cleaning up any of the
+ * received parameters.
+ *
+ * Return: Success: SUCCEED
+ * Failure: FAIL
+ * ---------------------------------------------------------------------------
+ */
herr_t
run_writer(int socketfd, H5FD_mirror_xmit_open_t *xmit_open)
{