X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=send.h;h=836babd50845088be08a2061fe39cc6ffd7760cb;hp=8ec5e7baf3386d420b3cb97fdba173c5bfc74fb1;hb=a365b8263a0d7a1673699bdf454677c95b38eb95;hpb=bc8187d6a4ca3191b3c54226ba54e4f0c4cf4e6e

diff --git a/send.h b/send.h
index 8ec5e7ba..836babd5 100644
--- a/send.h
+++ b/send.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2008 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2011 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -12,7 +12,7 @@ enum {SENDER_ADD, SENDER_DELETE, SENDER_ALLOW, SENDER_DENY, SENDER_ON, SENDER_OF
 /**
  * Describes one supported sender of para_server.
  *
- * \sa http_send.c ortp_send.c, dccp_send.c.
+ * \sa http_send.c udp_send.c, dccp_send.c.
  */
 struct sender {
 	/** The name of the sender. */
@@ -47,9 +47,10 @@ struct sender {
 	 * only differ if the stream was repositioned by the \a ff or \a jmp
 	 * command. Of course, \a buf is a pointer to the chunk of data which
 	 * should be sent, and \a len is the length of this buffer.
-	*/
+	 */
 	void (*send)(long unsigned current_chunk, long unsigned chunks_sent,
-		const char *buf, size_t len);
+		const char *buf, size_t len, const char *header_buf,
+		size_t header_len);
 	/**
 	 * Add file descriptors to fd_sets.
 	 *
@@ -86,6 +87,15 @@ struct sender {
 	 * pointer means this command is not implemented by this sender.
 	 */
 	int (*client_cmds[NUM_SENDER_CMDS])(struct sender_command_data*);
+	/**
+	 * Resolve target-specific URL string
+	 *
+	 * This method must be defined if the sender supports the add/delete
+	 * subcommands. It interprets a string specifying a target URL in a
+	 * sender-specific fashion (e.g. embedded FEC string). It can also
+	 * fill in sender-specific defaults if necessary.
+	 */
+	int (*resolve_target)(const char *, struct sender_command_data *);
 };
 
 /** Describes one client, connected to a paraslash sender. */
@@ -104,26 +114,64 @@ struct sender_client {
 	void *private_data;
 };
 
+/**
+ * Each paraslash sender may register arbitrary many clients to the virtual
+ * streaming system, possibly with varying fec parameters. In order to do so,
+ * it must allocate a \a fec_client_parms structure and pass it to \ref
+ * vss_add_fec_client.
+ *
+ * Clients are automatically removed from that list by the vss if an error
+ * occurs, or if the sender requests deletion of a client by calling \ref
+ * vss_del_fec_client().
+ */
+
+/** FEC parameters requested by FEC clients. */
+struct fec_client_parms {
+	/** Number of data slices plus redundant slices. */
+	uint8_t slices_per_group;
+	/** Number of slices minus number of redundant slices. */
+	uint8_t data_slices_per_group;
+	/** Whether the header must be sent periodically. */
+	bool need_periodic_header;
+	/**
+	 * Transport-layer initialisation for FEC support.
+	 *
+	 * This optional function serves (a) to make the transport layer
+	 * ready to send FEC slices and (b) to determine the Maximum
+	 * Packet Size (MPS) supported by the connection. The MPS value
+	 * determines the largest payload size. This value is used to
+	 * send FEC slices that are not larger than the path MTU, to avoid
+	 * fragmentation and to maximize packet utilization. The user can
+	 * alternatively specify a slice size of up to this value.
+	 */
+	int (*init_fec)(struct sender_client *sc);
+	/** Push out FEC-encoded packets */
+	int (*send_fec)(struct sender_client *sc, char *buf, size_t len);
+};
+
+/** Describes the current status of one paraslash sender. */
 struct sender_status {
+	/** The file descriptor of the socket this sender is listening on. */
 	int listen_fd;
+	/** The TCP/DCCP port used by this sender. */
 	int port;
+	/** The current number of simultaneous connections. */
 	int num_clients;
+	/** The maximal number of simultaneous connections. */
 	int max_clients;
+	/** Whether the access control list is a whitelist. */
 	int default_deny;
-	/** The list of connected clients. */
-	struct list_head client_list;
 	/** The whitelist/blacklist. */
 	struct list_head acl;
+	/** The list of connected clients. */
+	struct list_head client_list;
 };
 
 void shutdown_client(struct sender_client *sc, struct sender_status *ss);
 void shutdown_clients(struct sender_status *ss);
-void send_chunk(struct sender_client *sc, struct sender_status *ss,
-		size_t max_bytes_per_write, long unsigned current_chunk,
-		const char *buf, size_t len);
 void init_sender_status(struct sender_status *ss, char **access_arg, int num_access_args,
 	int port, int max_clients, int default_deny);
-char *get_sender_info(struct sender_status *ss, char *name);
+char *get_sender_info(struct sender_status *ss, const char *name);
 
 void generic_com_allow(struct sender_command_data *scd,
 		struct sender_status *ss);
@@ -132,4 +180,6 @@ void generic_com_deny(struct sender_command_data *scd,
 int generic_com_on(struct sender_status *ss, unsigned protocol);
 void generic_com_off(struct sender_status *ss);
 char *generic_sender_help(void);
-struct sender_client *accept_sender_client(struct sender_status *ss);
+struct sender_client *accept_sender_client(struct sender_status *ss, fd_set *rfds);
+int send_queued_chunks(int fd, struct chunk_queue *cq);
+int parse_fec_url(const char *arg, struct sender_command_data *scd);