From: Andre Noll <maan@systemlinux.org>
Date: Sat, 16 Feb 2008 19:25:10 +0000 (+0100)
Subject: Doxify send_common.c.
X-Git-Tag: v0.3.1~14
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=16ffb7fe52ee412ccf4c70037e83014325cab23d;p=paraslash.git

Doxify send_common.c.
---

diff --git a/send_common.c b/send_common.c
index f0ba1689..448ce522 100644
--- a/send_common.c
+++ b/send_common.c
@@ -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,9 +54,10 @@ 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
@@ -156,6 +157,7 @@ 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.
@@ -203,6 +205,16 @@ out:
 		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 +227,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 +269,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 +318,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 +338,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 +400,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(