/*
- * Copyright (C) 2005-2009 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2012 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;
};
/**
* \a argc and \a argv.
*/
void *(*parse_config)(int argc, char **argv);
+ /**
+ * Deallocate the configuration structure of a receiver node.
+ *
+ * This calls the receiver-specific cleanup function generated by
+ * gengetopt.
+ */
void (*free_config)(void *conf);
/**
* Open one instance of the receiver.
* 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.
struct ggo_help help;
};
-
-/** \cond */
-extern void http_recv_init(struct receiver *r);
-#define HTTP_RECEIVER {.name = "http", .init = http_recv_init},
-extern void dccp_recv_init(struct receiver *r);
-#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},
-
-extern struct receiver receivers[];
-/** \endcond */
-
/** Define an array of all available receivers. */
#define DEFINE_RECEIVER_ARRAY struct receiver receivers[] = { \
HTTP_RECEIVER \
void *check_receiver_arg(char *ra, int *receiver_num);
void print_receiver_helps(int detailed);
int generic_recv_pre_select(struct sched *s, struct task *t);
+
+/** \cond receiver */
+extern void http_recv_init(struct receiver *r);
+#define HTTP_RECEIVER {.name = "http", .init = http_recv_init},
+extern void dccp_recv_init(struct receiver *r);
+#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},
+
+extern struct receiver receivers[];
+/** \endcond receiver */
+