Minor documentation improvements.
[paraslash.git] / send_common.c
index 448ce52..3d87008 100644 (file)
@@ -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.
+ *
+ * \sa shutdown_clients().
  */
 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--;
 }
 
+/**
+ * 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;
@@ -123,10 +133,9 @@ static int write_nonblock(int fd, const char *buf, size_t len,
 }
 
 static int queue_chunk_or_shutdown(struct sender_client *sc,
-               struct sender_status *ss, long unsigned chunk_num,
-               size_t sent)
+               struct sender_status *ss, const char *buf, size_t num_bytes)
 {
-       int ret = cq_enqueue(sc->cq, chunk_num, sent);
+       int ret = cq_enqueue(sc->cq, buf, num_bytes);
        if (ret < 0)
                shutdown_client(sc, ss);
        return ret;
@@ -138,7 +147,7 @@ static int send_queued_chunks(struct sender_client *sc,
 {
        struct queued_chunk *qc;
        while ((qc = cq_peek(sc->cq))) {
-               char *buf;
+               const char *buf;
                size_t len;
                int ret;
                cq_get(qc, &buf, &len);
@@ -162,21 +171,22 @@ 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 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,
-               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) {
-               size_t header_len;
-               char *header_buf = vss_get_header(&header_len);
                if (header_buf && header_len > 0) {
-                       ret = queue_chunk_or_shutdown(sc, ss, -1U, 0);
+                       ret = queue_chunk_or_shutdown(sc, ss, header_buf, header_len);
                        if (ret < 0)
                                goto out;
                }
@@ -190,7 +200,7 @@ void send_chunk(struct sender_client *sc, struct sender_status *ss,
        if (!len)
                goto out;
        if (!ret) { /* still data left in the queue */
-               ret = queue_chunk_or_shutdown(sc, ss, current_chunk, 0);
+               ret = queue_chunk_or_shutdown(sc, ss, buf, len);
                goto out;
        }
        ret = write_nonblock(sc->fd, buf, len, max_bytes_per_write);
@@ -199,7 +209,7 @@ void send_chunk(struct sender_client *sc, struct sender_status *ss,
                goto out;
        }
        if (ret != len)
-               ret = queue_chunk_or_shutdown(sc, ss, current_chunk, ret);
+               ret = queue_chunk_or_shutdown(sc, ss, buf + ret, len - ret);
 out:
        if (ret < 0)
                PARA_NOTICE_LOG("%s\n", para_strerror(-ret));