Merge branch 'maint'
[paraslash.git] / recv_common.c
index a568939..59630df 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2006-2009 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006 Andre Noll <maan@tuebingen.mpg.de>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 #include "list.h"
 #include "sched.h"
 #include "ggo.h"
+#include "buffer_tree.h"
 #include "recv.h"
 #include "string.h"
 
-DEFINE_RECEIVER_ARRAY;
-
 /**
  * Call the init function of each paraslash receiver.
  */
@@ -32,48 +31,38 @@ static void *parse_receiver_args(int receiver_num, char *options)
 {
        struct receiver *r = &receivers[receiver_num];
        char **argv;
-       int argc, i;
+       int argc;
        void *conf;
 
-
-       PARA_DEBUG_LOG("%s, options: %s\n", r->name,
-               options? options : "(none)");
        if (options) {
-               PARA_DEBUG_LOG("options: %s\n", options);
-               argc = create_argv(options, " \t", &argv);
+               argc = create_shifted_argv(options, " \t", &argv);
                if (argc < 0)
                        return NULL;
-               for (i = argc - 1; i >= 0; i--)
-                       argv[i + 1] = argv[i];
-               argv[0] = NULL;
-               argc++;
        } else {
                argc = 1;
                argv = para_malloc(2 * sizeof(char*));
-               argv[0] = NULL;
                argv[1] = NULL;
        }
+       argv[0] = make_message("%s_recv", r->name);
        conf = r->parse_config(argc, argv);
-       for (i = 1; i < argc; i++)
-               free(argv[i]);
-       free(argv);
+       free_argv(argv);
        return conf;
 }
 
 /**
- * check if given string is a valid command line for any receiver
+ * Check if the given string is a valid receiver specifier.
  *
  * \param \ra string of the form receiver_name:options
  * \param receiver_num contains the number of the receiver upon success
  *
- * This function checks whether \a ra starts with the name of a supported
- * paraslash receiver, optinally followed by a colon and any options for that
- * receiver. If a valid receiver name was found and further are present, the
- * remaining part of \a ra is passed to that receiver's config parser.
+ * This function checks whether \a ra starts with the name of a receiver,
+ * optionally followed by options for that receiver. If a valid receiver name
+ * was found the remaining part of \a ra is passed to the receiver's config
+ * parser.
  *
- * \return On success, a pointer to the gengetopt args info struct is returned
- * and \a receiver_num contains the number of the receiver. Otherwise this function
- * returns \p NULL.
+ * \return On success, a pointer to the receiver-specific gengetopt args info
+ * struct is returned and \a receiver_num contains the number of the receiver.
+ * On errors, the function returns \p NULL.
  */
 void *check_receiver_arg(char *ra, int *receiver_num)
 {
@@ -103,21 +92,44 @@ void *check_receiver_arg(char *ra, int *receiver_num)
 /**
  * Print out the help texts to all receivers.
  *
- * \param detailed Whether the detailed help should be printed.
+ * \param flags Passed to \ref ggo_print_help().
  */
-void print_receiver_helps(int detailed)
+void print_receiver_helps(unsigned flags)
 {
        int i;
 
-       printf_or_die("\nAvailable receivers: \n\t");
+       printf_or_die("\nAvailable receivers: ");
        FOR_EACH_RECEIVER(i)
                printf_or_die("%s%s", i? " " : "", receivers[i].name);
-       printf_or_die("\n\n");
+       printf_or_die("\n");
        FOR_EACH_RECEIVER(i) {
                struct receiver *r = receivers + i;
                if (!r->help.short_help)
                        continue;
-               printf_or_die("Options for %s:\n", r->name);
-               ggo_print_help(&r->help, detailed);
+               printf_or_die("\n%s: %s", r->name,
+                       r->help.purpose);
+               ggo_print_help(&r->help, flags);
        }
 }
+
+/**
+ * Simple pre-select hook, used by all receivers.
+ *
+ * \param s Scheduler info.
+ * \param rn The receiver node.
+ *
+ * This requests a minimal delay from the scheduler if the status of the buffer
+ * tree node indicates an error/eof condition. No file descriptors are added to
+ * the fd sets of \a s.
+ *
+ * \return The status of the btr node of the receiver node, i.e. the return
+ * value of the underlying call to \ref btr_node_status().
+ */
+int generic_recv_pre_select(struct sched *s, struct receiver_node *rn)
+{
+       int ret = btr_node_status(rn->btrn, 0, BTR_NT_ROOT);
+
+       if (ret < 0)
+               sched_min_delay(s);
+       return ret;
+}