From f771958d757e388d9b9cebb21ca03f00505ada5b Mon Sep 17 00:00:00 2001 From: Jacob Smith Date: Mon, 16 Mar 2020 15:39:26 -0500 Subject: Add function header comment for `mirror_writer:run_writer()`. --- utils/mirror_vfd/mirror_writer.c | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) 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) { -- cgit v0.12