2 * Copyright (C) 2005-2008 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file send.h Sender-related defines and structures. */
9 /** The sender subcommands. */
10 enum {SENDER_ADD, SENDER_DELETE, SENDER_ALLOW, SENDER_DENY, SENDER_ON, SENDER_OFF, NUM_SENDER_CMDS};
13 * Describes one supported sender of para_server.
15 * \sa http_send.c ortp_send.c, dccp_send.c.
18 /** The name of the sender. */
21 * The init function of this sender.
23 * It must fill in all function pointers of \a s as well as the \a
24 * client_cmds array, see below. It should also do all necessary
25 * preparations to init this sending facility, for example it could
28 void (*init)(struct sender *s);
30 * Return the help text of this sender.
32 * The result must be dynamically allocated and is freed by the caller.
36 * Return current status info about this sender.
38 * The result must be dynamically allocated and is freed by the caller.
44 * It gets called whenever para_server is playing and the current
45 * audio format handler indicates that another chunk of data should
46 * be sent now. The two parameters \a current_chunk and \a chunks_sent
47 * only differ if the stream was repositioned by the \a ff or \a jmp
48 * command. Of course, \a buf is a pointer to the chunk of data which
49 * should be sent, and \a len is the length of this buffer.
51 void (*send)(long unsigned current_chunk, long unsigned chunks_sent,
52 const char *buf, size_t len);
54 * Add file descriptors to fd_sets.
56 * The pre_select function of each supported sender is called just before
57 * para_server enters its main select loop. Each sender may add its own
58 * file descriptors to the \a rfds or the \a wfds set.
60 * If a file descriptor was added, \a max_fileno must be increased by
61 * this function, if necessary.
65 void (*pre_select)(int *max_fileno, fd_set *rfds, fd_set *wfds);
67 * Handle the file descriptors which are ready for I/O.
69 * If the pre_select hook added one ore more file descriptors to the
70 * read or write set, this is the hook to check the result and do any
71 * I/O on those descriptors which are ready for reading/writing.
73 void (*post_select)(fd_set *rfds, fd_set *wfds);
75 * Terminate all connected clients.
77 * This is called e.g. if the stop command was executed. It should make
78 * the clients aware of the end-of-file condition.
80 void (*shutdown_clients)(void);
82 * Array of function pointers for the sender subcommands.
84 * Each sender may implement any subset of the sender commands by
85 * filling in the appropriate function pointer in the array. A \p NULL
86 * pointer means this command is not implemented by this sender.
88 int (*client_cmds[NUM_SENDER_CMDS])(struct sender_command_data*);
91 /** Describes one client, connected to a paraslash sender. */
92 struct sender_client {
93 /** The file descriptor of the client. */
95 /** The socket "name" of the client. */
97 /** The position of this client in the client list. */
98 struct list_head node;
99 /** Non-zero if audio file header has been sent. */
101 /** The list of pending chunks for this client. */
102 struct chunk_queue *cq;
103 /** Data specific to the particular sender. */
107 /** Describes the current status of one paraslash sender. */
108 struct sender_status {
109 /* The file descriptor of the socket this sender is listening on. */
111 /** The TCP/DCCP port used by this sender. */
113 /** The current number of simultaneous connections. */
115 /** The maximal number of simultaneous connections. */
117 /** Whether the access control list is a whitelist. */
119 /** The whitelist/blacklist. */
120 struct list_head acl;
121 /** The list of connected clients. */
122 struct list_head client_list;
125 void shutdown_client(struct sender_client *sc, struct sender_status *ss);
126 void shutdown_clients(struct sender_status *ss);
127 void send_chunk(struct sender_client *sc, struct sender_status *ss,
128 size_t max_bytes_per_write, long unsigned current_chunk,
129 const char *buf, size_t len);
130 void init_sender_status(struct sender_status *ss, char **access_arg, int num_access_args,
131 int port, int max_clients, int default_deny);
132 char *get_sender_info(struct sender_status *ss, char *name);
134 void generic_com_allow(struct sender_command_data *scd,
135 struct sender_status *ss);
136 void generic_com_deny(struct sender_command_data *scd,
137 struct sender_status *ss);
138 int generic_com_on(struct sender_status *ss, unsigned protocol);
139 void generic_com_off(struct sender_status *ss);
140 char *generic_sender_help(void);
141 struct sender_client *accept_sender_client(struct sender_status *ss);