/*
- * Copyright (C) 2005-2011 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2013 Andre Noll <maan@systemlinux.org>
*
* Licensed under the GPL v2. For licencing details see COPYING.
*/
struct task task;
/** The receiver node is always the root of the buffer tree. */
struct btr_node *btrn;
+ /** Each receiver node maintains a buffer pool for the received data. */
+ struct btr_pool *btrp;
+ /**
+ * The file descriptor to receive the stream.
+ *
+ * The pre_select function of the receiver adds this file descriptor to
+ * the set of file descriptors which are watched for readability or
+ * writability, depending on the state of the connection (if any).
+ *
+ * If \a fd is readable, the post_select function of the receiver reads
+ * data from this fd into the buffer pool area of \a btrp.
+ *
+ * \sa \ref receiver.
+ */
+ int fd;
};
/**
/**
* The command line parser of the receiver.
*
- * It should check whether the command line options given by \a argc and \a
- * argv are valid. On success, it should return a pointer to the
- * receiver-specific configuration data determined by \a argc and \a argv.
- * Note that this might be called more than once with different values of
- * \a argc and \a argv.
+ * It should check whether the command line options given by \a argc
+ * and \a argv are valid. On success, it should return a pointer to
+ * the receiver-specific configuration data determined by \a argc and
+ * \a argv. Note that this might be called more than once with
+ * different values of \a argc and \a argv.
*/
void *(*parse_config)(int argc, char **argv);
/**
* Evaluate the result from select().
*
* This hook gets called after the call to select(). It should check
- * all file descriptors which were added to any of the the fd sets
- * during the previous call to pre_select. According to the result, it
- * may then use any non-blocking I/O to establish a connection or to
+ * all file descriptors which were added to any of the fd sets during
+ * the previous call to pre_select. According to the result, it may
+ * then use any non-blocking I/O to establish a connection or to
* receive the audio data.
*
* \sa select(2), struct receiver.
*/
- void (*post_select)(struct sched *s, struct task *t);
+ int (*post_select)(struct sched *s, struct task *t);
/** The two help texts of this receiver. */
struct ggo_help help;
+ /**
+ * Answer a buffer tree query.
+ *
+ * This optional function pointer is used for inter node communications
+ * of the buffer tree nodes. See \ref btr_command_handler for details.
+ */
+ btr_command_handler execute;
};
/** Define an array of all available receivers. */
HTTP_RECEIVER \
DCCP_RECEIVER \
UDP_RECEIVER \
+ AFH_RECEIVER \
{.name = NULL}};
/** Iterate over all available receivers. */
void recv_init(void);
void *check_receiver_arg(char *ra, int *receiver_num);
-void print_receiver_helps(int detailed);
+void print_receiver_helps(unsigned flags);
int generic_recv_pre_select(struct sched *s, struct task *t);
/** \cond receiver */
#define DCCP_RECEIVER {.name = "dccp", .init = dccp_recv_init},
extern void udp_recv_init(struct receiver *r);
#define UDP_RECEIVER {.name = "udp", .init = udp_recv_init},
+#define AFH_RECEIVER /* not active by default */
extern struct receiver receivers[];
/** \endcond receiver */