user_list.c: Minor documentation impreovements.

[paraslash.git] / recv.c

diff --git a/recv.c b/recv.c
index cead11a345362178b99b36a159a6bea4f496df7b..0dca8eadd7241588e145135fc3b1b0f205b56b5f 100644 (file)
--- a/recv.c
+++ b/recv.c
@@ -1,22 +1,15 @@
 /*
- * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2008 Andre Noll <maan@systemlinux.org>
  *
- *     This program is free software; you can redistribute it and/or modify
- *     it under the terms of the GNU General Public License as published by
- *     the Free Software Foundation; either version 2 of the License, or
- *     (at your option) any later version.
- *
- *     This program is distributed in the hope that it will be useful,
- *     but WITHOUT ANY WARRANTY; without even the implied warranty of
- *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *     GNU General Public License for more details.
- *
- *     You should have received a copy of the GNU General Public License
- *     along with this program; if not, write to the Free Software
- *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Licensed under the GPL v2. For licencing details see COPYING.
  */
-#include "para.h"
 
+/** \file recv.c the stand-alone audio stream receiver */
+
+#include <sys/types.h>
+#include <dirent.h>
+
+#include "para.h"
 #include "list.h"
 #include "sched.h"
 #include "recv.h"
@@ -25,21 +18,14 @@
 #include "error.h"
 #include "stdout.h"
 
+/** the gengetopt args info struct */
 struct recv_args_info conf;
 
-INIT_RECV_ERRLISTS;
+/** always log to stderr */
+INIT_STDERR_LOGGING(conf.loglevel_arg);
 
-__printf_2_3 void para_log(int ll, const char* fmt,...)
-{
-       va_list argp;
-
-       /* ignore log message if loglevel is not high enough */
-       if (ll < conf.loglevel_arg)
-               return;
-       va_start(argp, fmt);
-       vfprintf(stderr, fmt, argp);
-       va_end(argp);
-}
+/** init array of error codes used by para_recv */
+INIT_RECV_ERRLISTS;
 
 static void *parse_config(int argc, char *argv[], int *receiver_num)
 {
@@ -47,6 +33,7 @@ static void *parse_config(int argc, char *argv[], int *receiver_num)
 
        if (recv_cmdline_parser(argc, argv, &conf))
                return NULL;
+       HANDLE_VERSION_FLAG("recv", conf);
        if (conf.list_receivers_given) {
                printf("available receivers: ");
                for (i = 0; receivers[i].name; i++)
@@ -61,15 +48,26 @@ static void *parse_config(int argc, char *argv[], int *receiver_num)
 static void rn_event_handler(struct task *t)
 {
        struct receiver_node *rn = t->private_data;
-       PARA_NOTICE_LOG("%s\n", PARA_STRERROR(-t->ret));
-       rn->eof = 1;
+       PARA_NOTICE_LOG("%s\n", para_strerror(-t->ret));
+       rn->error = t->ret;
        unregister_task(t);
 }
 
+/**
+ * the main function of para_recv
+ *
+ * \param argc number of arguments
+ * \param argv vector of arguments
+ *
+ * para_recv uses the specified receiver to receive an audio stream sent by
+ * para_server. The received data is written to stdout.
+ *
+ * \return \a EXIT_SUCCESS on success, \a EXIT_FAILURE on errors.
+ */
 int main(int argc, char *argv[])
 {
        int ret, r_opened = 0, receiver_num;
-       struct  receiver *r = NULL;
+       struct receiver *r = NULL;
        struct receiver_node rn;
        struct stdout_task sot;
        struct sched s;
@@ -96,7 +94,7 @@ int main(int argc, char *argv[])
        stdout_set_defaults(&sot);
        sot.buf = rn.buf;
        sot.loaded = &rn.loaded;
-       sot.input_eof = &rn.eof;
+       sot.input_error = &rn.error;
        register_task(&sot.task);
 
        rn.task.private_data = &rn;
@@ -106,13 +104,13 @@ int main(int argc, char *argv[])
        sprintf(rn.task.status, "receiver node");
        register_task(&rn.task);
 
-       ret = sched(&s);
+       ret = schedule(&s);
 out:
        if (r_opened)
                r->close(&rn);
        if (r)
                r->shutdown();
        if (ret < 0)
-               PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
-       return ret;
+               PARA_ERROR_LOG("%s\n", para_strerror(-ret));
+       return ret < 0? EXIT_FAILURE : EXIT_SUCCESS;
 }