Add support for forced prebuffering.
[cubemap] / client.h
1 #ifndef _CLIENT_H
2 #define _CLIENT_H 1
3
4 // A Client represents a single connection from a client (watching a single stream).
5
6 #include <stddef.h>
7 #include <time.h>
8 #include <string>
9
10 class ClientProto;
11 struct Stream;
12
13 // Digested statistics for writing to logs etc.
14 struct ClientStats {
15         std::string url;
16         int sock;
17         std::string remote_addr;
18         time_t connect_time;
19         size_t bytes_sent;
20         size_t bytes_lost;
21         size_t num_loss_events;
22 };
23
24 struct Client {
25         Client(int sock);
26
27         // Serialization/deserialization.
28         Client(const ClientProto &serialized, Stream *stream);
29         ClientProto serialize() const;
30
31         ClientStats get_stats() const;
32
33         // The file descriptor associated with this socket.
34         int sock;
35
36         // Some information only used for logging.
37         std::string remote_addr;
38         time_t connect_time;
39
40         enum State { READING_REQUEST, SENDING_HEADER, SENDING_DATA, SENDING_ERROR, WAITING_FOR_KEYFRAME, PREBUFFERING };
41         State state;
42
43         // The HTTP request, as sent by the client. If we are in READING_REQUEST,
44         // this might not be finished.
45         std::string request;
46
47         // What stream we're connecting to; parsed from <request>.
48         // Not relevant for READING_REQUEST.
49         std::string url;
50         Stream *stream;
51
52         // The header we want to send. This is nominally a copy of Stream::header,
53         // but since that might change on reconnects etc., we keep a local copy here.
54         // Only relevant for SENDING_HEADER or SENDING_ERROR; blank otherwise.
55         std::string header_or_error;
56
57         // Number of bytes we've sent of the header. Only relevant for SENDING_HEADER
58         // or SENDING_ERROR.
59         size_t header_or_error_bytes_sent;
60
61         // Number of bytes we are into the stream (ie., the end of last send).
62         // -1 means we want to send from the end of the backlog (the normal case),
63         // although only at a keyframe.
64         // -2 means we want to send from the _beginning_ of the backlog.
65         // Once we go into WAITING_FOR_KEYFRAME, PREBUFFERING or SENDING_DATA,
66         // these negative values will be translated to real numbers.
67         size_t stream_pos;
68
69         // Number of bytes we've sent of data. Only relevant for SENDING_DATA.
70         size_t bytes_sent;
71
72         // Number of times we've skipped forward due to the backlog being too big,
73         // and how many bytes we've skipped over in all. Only relevant for SENDING_DATA.
74         size_t bytes_lost, num_loss_events;
75 };
76
77 #endif  // !defined(_CLIENT_H)