Minor documentation improvements.

[paraslash.git] / send_common.c

diff --git a/send_common.c b/send_common.c
index c542e7e62fa52864b9ad8f44520b5dd495900e6a..3d87008850a8ab3c39b3f1711d5aca1b2e2f3a45 100644 (file)
--- a/send_common.c
+++ b/send_common.c
@@ -62,6 +62,8 @@ static int open_sender(unsigned l4type, int port)
  * Close the file descriptor given by \a sc, remove it from the close-on-fork
  * list, destroy the chunk queue of this client, delete the client from the
  * list of connected clients and free the sender_client struct.
  * Close the file descriptor given by \a sc, remove it from the close-on-fork
  * list, destroy the chunk queue of this client, delete the client from the
  * list of connected clients and free the sender_client struct.

+ *
+ * \sa shutdown_clients().

  */
 void shutdown_client(struct sender_client *sc, struct sender_status *ss)
 {
  */
 void shutdown_client(struct sender_client *sc, struct sender_status *ss)
 {


@@ -76,6 +78,14 @@ void shutdown_client(struct sender_client *sc, struct sender_status *ss)
        ss->num_clients--;
 }
 
        ss->num_clients--;
 }
 

+/**
+ * Shut down all clients connected to a paraslash sender.
+ *
+ * \param ss The sender whose clients are to be shut down.
+ *
+ * This just loops over all connected clients and calls shutdown_client()
+ * for each client.
+ */

 void shutdown_clients(struct sender_status *ss)
 {
        struct sender_client *sc, *tmp;
 void shutdown_clients(struct sender_status *ss)
 {
        struct sender_client *sc, *tmp;


@@ -161,21 +171,20 @@ static int send_queued_chunks(struct sender_client *sc,
  * \param current_chunk The number of the chunk to write.
  * \param buf The data to write.
  * \param len The number of bytes of \a buf.
  * \param current_chunk The number of the chunk to write.
  * \param buf The data to write.
  * \param len The number of bytes of \a buf.

+ * \param header_buf The audio file header.
+ * \param header_len The number of bytes of \a header_buf.

  *
  * On errors, the client is shut down. If only a part of the buffer could be
  * written, the remainder is put into the chunk queue for that client.
  */
 void send_chunk(struct sender_client *sc, struct sender_status *ss,
                size_t max_bytes_per_write, long unsigned current_chunk,
  *
  * On errors, the client is shut down. If only a part of the buffer could be
  * written, the remainder is put into the chunk queue for that client.
  */
 void send_chunk(struct sender_client *sc, struct sender_status *ss,
                size_t max_bytes_per_write, long unsigned current_chunk,

-               const char *buf, size_t len)
+               const char *buf, size_t len, const char *header_buf,
+               size_t header_len)

 {
        int ret;
 
        if (!sc->header_sent && current_chunk) {
 {
        int ret;
 
        if (!sc->header_sent && current_chunk) {

-               size_t header_len;
-               char *header_buf;
-
-               vss_get_header(&header_buf, &header_len);

                if (header_buf && header_len > 0) {
                        ret = queue_chunk_or_shutdown(sc, ss, header_buf, header_len);
                        if (ret < 0)
                if (header_buf && header_len > 0) {
                        ret = queue_chunk_or_shutdown(sc, ss, header_buf, header_len);
                        if (ret < 0)