Make the list of sleeping clients be per-stream instead of global, so we do not wake...
[cubemap] / server.h
1 #ifndef _SERVER_H
2 #define _SERVER_H 1
3
4 #include <stdint.h>
5 #include <pthread.h>
6 #include <sys/epoll.h>
7 #include <string>
8 #include <map>
9 #include <vector>
10
11 #define BACKLOG_SIZE 1048576
12 #define EPOLL_MAX_EVENTS 8192
13 #define EPOLL_TIMEOUT_MS 20
14 #define MAX_CLIENT_REQUEST 16384
15
16 class ClientProto;
17 class CubemapStateProto;
18 class Stream;
19 class StreamProto;
20
21 struct Client {
22         Client() {}
23         Client(int sock);
24
25         // Serialization/deserialization.
26         Client(const ClientProto &serialized, Stream *stream);
27         ClientProto serialize() const;
28
29         // The file descriptor associated with this socket.
30         int sock;
31
32         enum State { READING_REQUEST, SENDING_HEADER, SENDING_DATA, SENDING_ERROR };
33         State state;
34
35         // The HTTP request, as sent by the client. If we are in READING_REQUEST,
36         // this might not be finished.
37         std::string request;
38
39         // What stream we're connecting to; parsed from <request>.
40         // Not relevant for READING_REQUEST.
41         std::string stream_id;
42         Stream *stream;
43
44         // The header we want to send. This is nominally a copy of Stream::header,
45         // but since that might change on reconnects etc., we keep a local copy here.
46         // Only relevant for SENDING_HEADER or SENDING_ERROR; blank otherwise.
47         std::string header_or_error;
48
49         // Number of bytes we've sent of the header. Only relevant for SENDING_HEADER
50         // or SENDING_ERROR.
51         size_t header_or_error_bytes_sent;
52
53         // Number of bytes we've sent of data. Only relevant for SENDING_DATA.
54         size_t bytes_sent;
55 };
56
57 struct Stream {
58         Stream(const std::string &stream_id);
59         ~Stream();
60
61         // Serialization/deserialization.
62         Stream(const StreamProto &serialized);
63         StreamProto serialize() const;
64
65         std::string stream_id;
66
67         // The HTTP response header, plus the video stream header (if any).
68         std::string header;
69
70         // The stream data itself, stored in a circular buffer.
71         char *data;
72
73         // How many bytes <data> contains. Can very well be larger than BACKLOG_SIZE,
74         // since the buffer wraps.
75         size_t data_size;
76         
77         // Clients that are in SENDING_DATA, but that we don't listen on,
78         // because we currently don't have any data for them.
79         // See put_client_to_sleep() and wake_up_all_clients().
80         std::vector<Client *> sleeping_clients;
81
82         // Clients that we recently got data for (when they were in
83         // <sleeping_clients>).
84         std::vector<Client *> to_process;
85
86         // Put client to sleep, since there is no more data for it; we will on
87         // longer listen on POLLOUT until we get more data. Also, it will be put
88         // in the list of clients to wake up when we do.
89         void put_client_to_sleep(Client *client);
90
91         // We have more data, so mark all clients that are sleeping as ready to go.
92         void wake_up_all_clients();
93
94 private:
95         Stream(const Stream& other);
96 };
97
98 class Server {
99 public:
100         Server();
101         ~Server();
102
103         // Start a new thread that handles clients.
104         void run();
105
106         // Stop the thread.
107         void stop();
108
109         CubemapStateProto serialize() const;
110
111         void add_client(int sock);
112         void add_client_from_serialized(const ClientProto &client);
113
114         void add_stream(const std::string &stream_id);
115         void add_stream_from_serialized(const StreamProto &stream);
116
117         void set_header(const std::string &stream_id, const std::string &header);
118         void add_data(const std::string &stream_id, const char *data, size_t bytes);
119
120 private:
121         pthread_t worker_thread;
122
123         // All variables below this line are protected by the mutex.
124         pthread_mutex_t mutex;
125
126         // If the thread should stop or not.
127         bool should_stop;       
128
129         // Map from stream ID to stream.
130         std::map<std::string, Stream *> streams;
131
132         // Map from file descriptor to client.
133         std::map<int, Client> clients;
134
135         // Used for epoll implementation (obviously).
136         int epoll_fd;
137         epoll_event events[EPOLL_MAX_EVENTS];
138
139         // Recover the this pointer, and call do_work().
140         static void *do_work_thunk(void *arg);
141
142         // The actual worker thread.
143         void do_work();
144
145         // Process a client; read and write data as far as we can.
146         // After this call, one of these four is true:
147         //
148         //  1. The socket is closed, and the client deleted.
149         //  2. We are still waiting for more data from the client.
150         //  3. We've sent all the data we have to the client,
151         //     and put it in <sleeping_clients>.
152         //  4. The socket buffer is full (which means we still have
153         //     data outstanding).
154         //
155         // For #2, we listen for EPOLLIN events. For #3 and #4, we listen
156         // for EPOLLOUT in edge-triggered mode; it will never fire for #3,
157         // but it's cheaper than taking it in and out all the time.
158         void process_client(Client *client);
159
160         // Close a given client socket, and clean up after it.
161         void close_client(Client *client);
162
163         // Parse the HTTP request. Returns a HTTP status code (200/400/404).
164         int parse_request(Client *client);
165
166         // Construct the HTTP header, and set the client into
167         // the SENDING_HEADER state.
168         void construct_header(Client *client);
169
170         // Construct a generic error with the given line, and set the client into
171         // the SENDING_ERROR state.
172         void construct_error(Client *client, int error_code);
173
174         // TODO: This function should probably die.
175         Stream *find_stream(const std::string &stream_id);
176 };
177
178 #endif  // !defined(_SERVER_H)