Add function header comment for mirror_writer:run_writer().

This commit is contained in:
Jacob Smith 2020-03-16 15:39:26 -05:00
parent b65405439d
commit f771958d75

View File

@ -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)
{