Make a comment more precise.
[cubemap] / server.h
1 #ifndef _SERVER_H
2 #define _SERVER_H 1
3
4 #include <pthread.h>
5 #include <stddef.h>
6 #include <stdint.h>
7 #include <sys/epoll.h>
8 #include <sys/types.h>
9 #include <time.h>
10 #include <map>
11 #include <queue>
12 #include <string>
13 #include <vector>
14
15 #include "client.h"
16 #include "stream.h"
17 #include "thread.h"
18
19 class ClientProto;
20 struct Stream;
21
22 #define EPOLL_MAX_EVENTS 8192
23 #define EPOLL_TIMEOUT_MS 20
24 #define MAX_CLIENT_REQUEST 16384
25 #define REQUEST_READ_TIMEOUT_SEC 60
26
27 class CubemapStateProto;
28 class StreamProto;
29
30 class Server : public Thread {
31 public:
32         Server();
33         ~Server();
34
35         // Get the list of all currently connected clients.     
36         std::vector<ClientStats> get_client_stats() const;
37
38         // Set header (both HTTP header and any stream headers) for the given stream.
39         void set_header(int stream_index,
40                         const std::string &http_header,
41                         const std::string &stream_header);
42
43         // Set that the given stream should use the given max pacing rate from now on.
44         // NOTE: This should be set before any clients are connected!
45         void set_pacing_rate(int stream_index, uint32_t pacing_rate);
46
47         // These will be deferred until the next time an iteration in do_work() happens,
48         // and the order between them are undefined.
49         // XXX: header should ideally be ordered with respect to data.
50         void add_client_deferred(int sock);
51         void add_data_deferred(int stream_index, const char *data, size_t bytes, StreamStartSuitability suitable_for_stream_start);
52
53         // These should not be called while running, since that would violate
54         // threading assumptions (ie., that epoll is only called from one thread
55         // at the same time).
56         CubemapStateProto serialize();
57         void add_client_from_serialized(const ClientProto &client);
58         int add_stream(const std::string &url, size_t bytes_received, size_t prebuffering_bytes, Stream::Encoding encoding);
59         int add_stream_from_serialized(const StreamProto &stream, int data_fd);
60         int lookup_stream_by_url(const std::string &url) const;
61         void set_backlog_size(int stream_index, size_t new_size);
62         void set_encoding(int stream_index, Stream::Encoding encoding);
63
64 private:
65         // Mutex protecting queued_add_clients.
66         // Note that if you want to hold both this and <mutex> below,
67         // you will need to take <mutex> before this one.
68         mutable pthread_mutex_t queued_clients_mutex;
69
70         // Deferred commands that should be run from the do_work() thread as soon as possible.
71         // We defer these for two reasons:
72         //
73         //  - We only want to fiddle with epoll from one thread at any given time,
74         //    and doing add_client() from the acceptor thread would violate that.
75         //  - We don't want the input thread(s) hanging on <mutex> when doing
76         //    add_data(), since they want to do add_data() rather often, and <mutex>
77         //    can be taken a lot of the time.
78         //      
79         // Protected by <queued_clients_mutex>.
80         std::vector<int> queued_add_clients;
81
82         // All variables below this line are protected by the mutex.
83         mutable pthread_mutex_t mutex;
84
85         // All streams.
86         std::vector<Stream *> streams;
87
88         // Map from URL to index into <streams>.
89         std::map<std::string, int> url_map;
90
91         // Map from file descriptor to client.
92         std::map<int, Client> clients;
93
94         // A list of all clients, ordered by the time they connected (first element),
95         // and their file descriptor (second element). It is ordered by connection time
96         // (and thus also by read timeout time) so that we can read clients from the
97         // start and stop processing once we get to one that isn't ready to be
98         // timed out yet (which means we only have to look at each client exactly once,
99         // save for the first element of the queue, which is always checked).
100         //
101         // Note that when we delete a client, we don't update this queue.
102         // This means that when reading it, we need to check if the client it
103         // describes is still exists (ie., that the fd still exists, and that
104         // the timespec matches).
105         std::queue<std::pair<timespec, int> > clients_ordered_by_connect_time;
106
107         // Used for epoll implementation (obviously).
108         int epoll_fd;
109         epoll_event events[EPOLL_MAX_EVENTS];
110
111         // The actual worker thread.
112         virtual void do_work();
113
114         // Process a client; read and write data as far as we can.
115         // After this call, one of these four is true:
116         //
117         //  1. The socket is closed, and the client deleted.
118         //  2. We are still waiting for more data from the client.
119         //  3. We've sent all the data we have to the client,
120         //     and put it in <sleeping_clients>.
121         //  4. The socket buffer is full (which means we still have
122         //     data outstanding).
123         //
124         // For #2, we listen for EPOLLIN events. For #3 and #4, we listen
125         // for EPOLLOUT in edge-triggered mode; it will never fire for #3,
126         // but it's cheaper than taking it in and out all the time.
127         void process_client(Client *client);
128
129         // Close a given client socket, and clean up after it.
130         void close_client(Client *client);
131
132         // Parse the HTTP request. Returns a HTTP status code (200/400/404).
133         int parse_request(Client *client);
134
135         // Construct the HTTP header, and set the client into
136         // the SENDING_HEADER state.
137         void construct_header(Client *client);
138
139         // Construct a generic error with the given line, and set the client into
140         // the SENDING_ERROR state.
141         void construct_error(Client *client, int error_code);
142
143         void process_queued_data();
144         void skip_lost_data(Client *client);
145
146         void add_client(int sock);
147 };
148
149 #endif  // !defined(_SERVER_H)