Add documentation to struct rc4_context.

[paraslash.git] / vss.h

diff --git a/vss.h b/vss.h
index 3b238eb74f5b4e1124cbe38d3db6fc3adc9cbb21..9bdc449c0a2a8617b70d06bb1df50272b7761a40 100644 (file)
--- a/vss.h
+++ b/vss.h
@@ -1,31 +1,55 @@
 /*
- * Copyright (C) 2005-2008 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2009 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file vss.h exported functions from vss.c (para_server) */
-void vss_init(void);
-void vss_send_chunk(void);
-struct timeval *vss_preselect(fd_set *rfds, fd_set *wfds, int *max_fileno);
-void vss_post_select(fd_set *rfds, fd_set *wfds);
+/** \file vss.h Exported functions from vss.c (para_server). */
+
+void init_vss_task(int afs_socket);
 unsigned int vss_playing(void);
 unsigned int vss_next(void);
 unsigned int vss_repos(void);
 unsigned int vss_paused(void);
 unsigned int vss_stopped(void);
-void vss_get_header(char **buf, size_t *len);
 struct timeval *vss_chunk_time(void);
 const char *supported_audio_formats(void);
-int vss_get_chunk(long unsigned chunk_num, char **buf, size_t *len);
 
-/** stop playing after current audio file */
+/** Stop playing after current audio file. */
 #define VSS_NOMORE 1
-/** skip remaining part of current audio file */
+/** Skip remaining part of current audio file. */
 #define VSS_NEXT 2
-/** a reposition request was sent by a client */
+/** A reposition request was sent by a client. */
 #define VSS_REPOS 4
-/** currently playing */
+/** Currently playing. */
 #define VSS_PLAYING 8
-/** a client requested to change the audio file selector */
-#define VSS_CHANGE 16
+
+/**
+ * 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
+ * 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().
+ */
+struct 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;
+       /** Maximal number of bytes per slice. */
+       uint16_t max_slice_bytes;
+       /** Called by vss.c when the next slice should be sent. */
+       int (*send)(char *buf, size_t num_bytes, void *private_data);
+       /** Passed verbatim to \a send(). */
+       void *private_data;
+};
+
+int vss_add_fec_client(struct fec_client_parms *fcp, struct fec_client **result);
+void vss_del_fec_client(struct fec_client *fc);
+size_t vss_get_fec_eof_packet(const char **buf);