com_stat(): Return a proper error message if an invalid option was given.
[paraslash.git] / send.h
1 /*
2 * Copyright (C) 2005-2009 Andre Noll <maan@systemlinux.org>
3 *
4 * Licensed under the GPL v2. For licencing details see COPYING.
5 */
6
7 /** \file send.h Sender-related defines and structures. */
8
9 /** The sender subcommands. */
10 enum {SENDER_ADD, SENDER_DELETE, SENDER_ALLOW, SENDER_DENY, SENDER_ON, SENDER_OFF, NUM_SENDER_CMDS};
11
12 /**
13 * Describes one supported sender of para_server.
14 *
15 * \sa http_send.c udp_send.c, dccp_send.c.
16 */
17 struct sender {
18 /** The name of the sender. */
19 const char *name;
20 /**
21 * The init function of this sender.
22 *
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
26 * open a tcp port.
27 */
28 void (*init)(struct sender *s);
29 /**
30 * Return the help text of this sender.
31 *
32 * The result must be dynamically allocated and is freed by the caller.
33 */
34 char* (*help)(void);
35 /**
36 * Return current status info about this sender.
37 *
38 * The result must be dynamically allocated and is freed by the caller.
39 */
40 char* (*info)(void);
41 /**
42 * The send-hook.
43 *
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.
50 */
51 void (*send)(long unsigned current_chunk, long unsigned chunks_sent,
52 const char *buf, size_t len, const char *header_buf,
53 size_t header_len);
54 /**
55 * Add file descriptors to fd_sets.
56 *
57 * The pre_select function of each supported sender is called just before
58 * para_server enters its main select loop. Each sender may add its own
59 * file descriptors to the \a rfds or the \a wfds set.
60 *
61 * If a file descriptor was added, \a max_fileno must be increased by
62 * this function, if necessary.
63 *
64 * \sa select(2).
65 */
66 void (*pre_select)(int *max_fileno, fd_set *rfds, fd_set *wfds);
67 /**
68 * Handle the file descriptors which are ready for I/O.
69 *
70 * If the pre_select hook added one ore more file descriptors to the
71 * read or write set, this is the hook to check the result and do any
72 * I/O on those descriptors which are ready for reading/writing.
73 */
74 void (*post_select)(fd_set *rfds, fd_set *wfds);
75 /**
76 * Terminate all connected clients.
77 *
78 * This is called e.g. if the stop command was executed. It should make
79 * the clients aware of the end-of-file condition.
80 */
81 void (*shutdown_clients)(void);
82 /**
83 * Array of function pointers for the sender subcommands.
84 *
85 * Each sender may implement any subset of the sender commands by
86 * filling in the appropriate function pointer in the array. A \p NULL
87 * pointer means this command is not implemented by this sender.
88 */
89 int (*client_cmds[NUM_SENDER_CMDS])(struct sender_command_data*);
90 };
91
92 /** Describes one client, connected to a paraslash sender. */
93 struct sender_client {
94 /** The file descriptor of the client. */
95 int fd;
96 /** The socket "name" of the client. */
97 char *name;
98 /** The position of this client in the client list. */
99 struct list_head node;
100 /** Non-zero if audio file header has been sent. */
101 int header_sent;
102 /** The list of pending chunks for this client. */
103 struct chunk_queue *cq;
104 /** Data specific to the particular sender. */
105 void *private_data;
106 };
107
108 /** Describes the current status of one paraslash sender. */
109 struct sender_status {
110 /** The file descriptor of the socket this sender is listening on. */
111 int listen_fd;
112 /** The TCP/DCCP port used by this sender. */
113 int port;
114 /** The current number of simultaneous connections. */
115 int num_clients;
116 /** The maximal number of simultaneous connections. */
117 int max_clients;
118 /** Whether the access control list is a whitelist. */
119 int default_deny;
120 /** The whitelist/blacklist. */
121 struct list_head acl;
122 /** The list of connected clients. */
123 struct list_head client_list;
124 };
125
126 void shutdown_client(struct sender_client *sc, struct sender_status *ss);
127 void shutdown_clients(struct sender_status *ss);
128 void send_chunk(struct sender_client *sc, struct sender_status *ss,
129 size_t max_bytes_per_write, long unsigned current_chunk,
130 const char *buf, size_t len, const char *header_buf,
131 size_t header_len);
132 void init_sender_status(struct sender_status *ss, char **access_arg, int num_access_args,
133 int port, int max_clients, int default_deny);
134 char *get_sender_info(struct sender_status *ss, const char *name);
135
136 void generic_com_allow(struct sender_command_data *scd,
137 struct sender_status *ss);
138 void generic_com_deny(struct sender_command_data *scd,
139 struct sender_status *ss);
140 int generic_com_on(struct sender_status *ss, unsigned protocol);
141 void generic_com_off(struct sender_status *ss);
142 char *generic_sender_help(void);
143 struct sender_client *accept_sender_client(struct sender_status *ss);
144 int send_queued_chunks(int fd, struct chunk_queue *cq,
145 size_t max_bytes_per_write);
146 int parse_fec_url(const char *arg, struct sender_command_data *scd);