Minor documentation improvements.
[paraslash.git] / send_common.c
index f0ba168..3d87008 100644 (file)
@@ -28,7 +28,7 @@
 /**
  * Open a passive socket of given layer4 type.
  *
- * Set the resultig file descriptor to nonblocking mode and add it to the list
+ * Set the resulting file descriptor to nonblocking mode and add it to the list
  * of fds that are being closed in the child process when the server calls
  * fork().
  *
@@ -54,13 +54,16 @@ static int open_sender(unsigned l4type, int port)
 }
 
 /**
- * Shut down a connected client.
+ * Shut down a client connected to a paraslash sender.
  *
- * \param sc The client to be shut down.
+ * \param sc The client to shut down.
+ * \param ss The sender whose clients are to be shut down.
  *
  * 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)
 {
@@ -75,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;
@@ -122,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;
@@ -137,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);
@@ -156,25 +166,27 @@ static int send_queued_chunks(struct sender_client *sc,
  * Send one chunk of audio data to a connected client.
  *
  * \param sc The client.
+ * \param ss The sender.
  * \param max_bytes_per_write Split writes to chunks of at most that many bytes.
  * \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;
                }
@@ -188,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);
@@ -197,12 +209,22 @@ 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));
 }
 
+/**
+ * Initialize a struct sender status.
+ *
+ * \param ss The struct to initialize.
+ * \param access_arg The array of access arguments given at the command line.
+ * \param num_access_args The number of elements in \a access_arg.
+ * \param port The tcp or dccp port to listen on.
+ * \param max_clients The maximal number of simultaneous connections.
+ * \param default_deny Whether a blacklist should be used for access control.
+ */
 void init_sender_status(struct sender_status *ss, char **access_arg,
        int num_access_args, int port, int max_clients, int default_deny)
 {
@@ -215,6 +237,14 @@ void init_sender_status(struct sender_status *ss, char **access_arg,
        ss->default_deny = default_deny;
 }
 
+/**
+ * Return a string containing the current status of a sender.
+ *
+ * \param ss The sender.
+ * \param name Used for printing the header line.
+ *
+ * \return The string printed in the "si" command.
+ */
 char *get_sender_info(struct sender_status *ss, char *name)
 {
        char *clnts = NULL, *ret;
@@ -249,18 +279,42 @@ char *get_sender_info(struct sender_status *ss, char *name)
        return ret;
 }
 
+/**
+ * Allow connections from the given range of IP addresses.
+ *
+ * \param scd Contains the IP and the netmask.
+ * \param ss The sender.
+ *
+ * \sa generic_com_deny().
+ */
 void generic_com_allow(struct sender_command_data *scd,
                struct sender_status *ss)
 {
        acl_allow(scd->addr, scd->netmask, &ss->acl, ss->default_deny);
 }
 
+/**
+ * Deny connections from the given range of IP addresses.
+ *
+ * \param scd see \ref generic_com_allow().
+ * \param ss see \ref generic_com_allow().
+ *
+ * \sa generic_com_allow().
+ */
 void generic_com_deny(struct sender_command_data *scd,
                struct sender_status *ss)
 {
        acl_deny(scd->addr, scd->netmask, &ss->acl, ss->default_deny);
 }
 
+/**
+ * Activate a paraslash sender.
+ *
+ * \param ss The sender to activate.
+ * \param protocol The symbolic name of the transport-layer protocol.
+ *
+ * \return Standard.
+ */
 int generic_com_on(struct sender_status *ss, unsigned protocol)
 {
        int ret;
@@ -274,6 +328,15 @@ int generic_com_on(struct sender_status *ss, unsigned protocol)
        return 1;
 }
 
+/**
+ * Deactivate a paraslash sender.
+ *
+ * Shutdown all connected clients and stop listening on the TCP/DCCP socket.
+ *
+ * \param ss The sender to deactivate.
+ *
+ * \sa \ref del_close_on_fork_list(), shutdown_clients().
+ */
 void generic_com_off(struct sender_status *ss)
 {
        if (ss->listen_fd < 0)
@@ -285,6 +348,34 @@ void generic_com_off(struct sender_status *ss)
        ss->listen_fd = -1;
 }
 
+/**
+ * Accept a connection on the socket this server is listening on.
+ *
+ * \param ss The sender whose listening fd is ready for reading.
+ *
+ * This must be called only if the socket fd of \a ss is ready for reading.  It
+ * calls para_accept() to accept the connection and performs the following
+ * actions on the resulting file descriptor \a fd:
+ *
+ *     - Checks whether the maximal number of connections are exceeded.
+ *     - Sets \a fd to nonblocking mode.
+ *     - Checks the acl of the sender to find out whether connections
+ *       are allowed from the IP of the connecting peer.
+ *     - Increases the number of connections for this sender.
+ *     - Creates and initializes a new chunk queue for queuing network
+ *       packets that can not be sent immediately.
+ *     - Allocates a new struct sender_client and fills in its \a fd, \a cq
+ *       and \a name members.
+ *     - Adds \a fd to the list of connected clients for this sender.
+ *     - Adds \a fd to the list of file descriptors that should be closed
+ *       in the child process when the server calls fork().
+ *
+ * \return A pointer to the allocated sender_client structure on success, \p
+ * NULL on errors.
+ *
+ * \sa \ref para_accept(), \ref mark_fd_nonblocking(), \ref acl_check_access(),
+ * \ref cq_new(), \ref add_close_on_fork_list().
+ */
 struct sender_client *accept_sender_client(struct sender_status *ss)
 {
        struct sender_client *sc;
@@ -319,6 +410,12 @@ err_out:
        return NULL;
 }
 
+/**
+ * Get the generic help text.
+ *
+ * \return A dynamically allocated string containing the help text for
+ * a paraslash sender.
+ */
 char *generic_sender_help(void)
 {
        return make_message(