Keep information about HLS downloads around for some time afterwards.
[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
9 #include <memory>
10 #include <string>
11 #include <unordered_map>
12 #include <vector>
13
14 #include "tlse.h"
15
16 class ClientProto;
17 struct Stream;
18
19 // Digested statistics for writing to logs etc.
20 // Note that "referer" and "user_agent" here are already escaped for scary characters.
21 struct ClientStats {
22         std::string url;
23         int sock;
24         std::string remote_addr;
25         std::string referer;
26         std::string user_agent;
27         timespec connect_time;
28         size_t bytes_sent;
29         size_t bytes_lost;
30         size_t num_loss_events;
31         std::string hls_zombie_key;
32 };
33
34 struct Client {
35         Client(int sock);
36
37         // Serialization/deserialization.
38         Client(const ClientProto &serialized, const std::vector<std::shared_ptr<const std::string>> &short_responses, Stream *stream);
39         ClientProto serialize(std::unordered_map<const std::string *, size_t> *short_response_pool) const;
40
41         ClientStats get_stats() const;
42
43         std::string get_hls_zombie_key() const {
44                 if (x_playback_session_id.empty()) {
45                         return remote_addr;
46                 } else {
47                         return x_playback_session_id;
48                 }
49         }
50
51         // The file descriptor associated with this socket.
52         int sock;
53
54         // When the client connected (or went into keepalive), in terms of CLOCK_MONOTONIC_COARSE.
55         timespec connect_time;
56
57         // Some information only used for logging.
58         std::string remote_addr;
59         std::string referer;
60         std::string user_agent;
61         std::string x_playback_session_id;
62
63         enum State { READING_REQUEST, SENDING_HEADER, SENDING_DATA, SENDING_SHORT_RESPONSE, WAITING_FOR_KEYFRAME, PREBUFFERING };
64         State state = READING_REQUEST;
65
66         // The HTTP request, as sent by the client. If we are in READING_REQUEST,
67         // this might not be finished.
68         std::string request;
69
70         // What stream we're connecting to; parsed from <request>.
71         // Not relevant for READING_REQUEST.
72         std::string url;
73         Stream *stream = nullptr;
74
75         // If true, we don't actually serve the stream, but its HLS playlist.
76         bool serving_hls_playlist = false;
77
78         // Whether we should close the connection after sending the response.
79         // Not relevant for READING_REQUEST. Must be true if http_11 is false.
80         bool close_after_response;
81
82         // Whether the request came in over HTTP/1.1 or higher.
83         bool http_11;
84
85         // The header we want to send, or the response with headers if we know
86         // it in its entirety after reading the request (typically an error).
87         // This is nominally a copy of Stream::header, but since that might
88         // change on reconnects etc., we keep a local copy here. Only relevant
89         // for SENDING_HEADER or SENDING_SHORT_RESPONSE; blank otherwise.
90         //
91         // Must start with the string "HTTP/1.0 ", which will be changed to 1.1
92         // if relevant.
93         const std::string *header_or_short_response = nullptr;
94
95         // <header_or_short_response> can come from two distinct places; it can be
96         // local to the Client object, or it can be shared between many Clients
97         // (typically HLS playlists, that can be so large that they are expensive
98         // to hold in many copies). <header_or_short_response> will point to exactly
99         // one of these, which should be cleared out/dereferenced when it is
100         // no longer needed.
101         //
102         // The use of shared_ptr is somewhat overkill since we don't need
103         // to access the HLS playlists from multiple threads, but it's not a
104         // big deal for us.
105         std::string header_or_short_response_holder;
106         std::shared_ptr<const std::string> header_or_short_response_ref;
107
108         // Number of bytes we've sent of the header. Only relevant for SENDING_HEADER
109         // or SENDING_SHORT_RESPONSE.
110         size_t header_or_short_response_bytes_sent = 0;
111
112         // Number of bytes we are into the stream (ie., the end of last send).
113         // -1 means we want to send from the end of the backlog (the normal case),
114         // although only at a keyframe.
115         // -2 means we want to send from the _beginning_ of the backlog.
116         // -3 means we sent the header only.
117         static const uint64_t STREAM_POS_AT_END = -1;
118         static const uint64_t STREAM_POS_AT_START = -2;
119         static const uint64_t STREAM_POS_HEADER_ONLY = -3;
120
121         // Once we go into WAITING_FOR_KEYFRAME, PREBUFFERING or SENDING_DATA,
122         // these negative values will be translated to real numbers.
123         uint64_t stream_pos = 0;
124
125         // Position at which to end the stream (one-past-the-end, used for fragments).
126         // -1 means never to end; this is the common case.
127         static const uint64_t STREAM_POS_NO_END = -1;
128         uint64_t stream_pos_end = 0;
129
130         // Number of bytes we've sent of data. Only relevant for SENDING_DATA.
131         uint64_t bytes_sent = 0;
132
133         // Number of times we've skipped forward due to the backlog being too big,
134         // and how many bytes we've skipped over in all. Only relevant for SENDING_DATA.
135         uint64_t bytes_lost = 0, num_loss_events = 0;
136
137         TLSContext *tls_context = nullptr;
138         const unsigned char *tls_data_to_send = nullptr;
139         unsigned tls_data_left_to_send = 0;
140         bool in_ktls_mode = false;
141 };
142
143 #endif  // !defined(_CLIENT_H)