4 // A Client represents a single connection from a client (watching a single stream).
11 #include <unordered_map>
19 // Digested statistics for writing to logs etc.
20 // Note that "referer" and "user_agent" here are already escaped for scary characters.
24 std::string remote_addr;
26 std::string user_agent;
27 timespec connect_time;
30 size_t num_loss_events;
31 std::string hls_zombie_key;
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;
41 ClientStats get_stats() const;
43 std::string get_hls_zombie_key() const {
44 if (x_playback_session_id.empty()) {
47 return x_playback_session_id;
51 // The file descriptor associated with this socket.
54 // When the client connected (or went into keepalive), in terms of CLOCK_MONOTONIC_COARSE.
55 timespec connect_time;
57 // Some information only used for logging.
58 std::string remote_addr;
60 std::string user_agent;
61 std::string x_playback_session_id;
63 enum State { READING_REQUEST, SENDING_HEADER, SENDING_DATA, SENDING_SHORT_RESPONSE, WAITING_FOR_KEYFRAME, PREBUFFERING };
64 State state = READING_REQUEST;
66 // The HTTP request, as sent by the client. If we are in READING_REQUEST,
67 // this might not be finished.
70 // What stream we're connecting to; parsed from <request>.
71 // Not relevant for READING_REQUEST.
73 Stream *stream = nullptr;
75 // If true, we don't actually serve the stream, but its HLS playlist.
76 // TODO: Maybe this shouldn't be part of Client, since it's only
77 // really used in communicating once from parse_request() to
78 // process_client(); it's not permanent state (and is not serialized).
79 bool serving_hls_playlist = false;
81 // Whether we should close the connection after sending the response.
82 // Not relevant for READING_REQUEST. Must be true if http_11 is false.
83 bool close_after_response;
85 // Whether the request came in over HTTP/1.1 or higher.
88 // The header we want to send, or the response with headers if we know
89 // it in its entirety after reading the request (typically an error).
90 // This is nominally a copy of Stream::header, but since that might
91 // change on reconnects etc., we keep a local copy here. Only relevant
92 // for SENDING_HEADER or SENDING_SHORT_RESPONSE; blank otherwise.
94 // Must start with the string "HTTP/1.0 ", which will be changed to 1.1
96 const std::string *header_or_short_response = nullptr;
98 // <header_or_short_response> can come from two distinct places; it can be
99 // local to the Client object, or it can be shared between many Clients
100 // (typically HLS playlists, that can be so large that they are expensive
101 // to hold in many copies). <header_or_short_response> will point to exactly
102 // one of these, which should be cleared out/dereferenced when it is
105 // The use of shared_ptr is somewhat overkill since we don't need
106 // to access the HLS playlists from multiple threads, but it's not a
108 std::string header_or_short_response_holder;
109 std::shared_ptr<const std::string> header_or_short_response_ref;
111 // Number of bytes we've sent of the header. Only relevant for SENDING_HEADER
112 // or SENDING_SHORT_RESPONSE.
113 size_t header_or_short_response_bytes_sent = 0;
115 // Number of bytes we are into the stream (ie., the end of last send).
116 // -1 means we want to send from the end of the backlog (the normal case),
117 // although only at a keyframe.
118 // -2 means we want to send from the _beginning_ of the backlog.
119 // -3 means we sent the header only.
120 static const uint64_t STREAM_POS_AT_END = -1;
121 static const uint64_t STREAM_POS_AT_START = -2;
122 static const uint64_t STREAM_POS_HEADER_ONLY = -3;
124 // Once we go into WAITING_FOR_KEYFRAME, PREBUFFERING or SENDING_DATA,
125 // these negative values will be translated to real numbers.
126 uint64_t stream_pos = 0;
128 // Position at which to end the stream (one-past-the-end, used for fragments).
129 // -1 means never to end; this is the common case.
130 static const uint64_t STREAM_POS_NO_END = -1;
131 uint64_t stream_pos_end = 0;
133 // Number of bytes we've sent of data. Only relevant for SENDING_DATA.
134 uint64_t bytes_sent = 0;
136 // Number of times we've skipped forward due to the backlog being too big,
137 // and how many bytes we've skipped over in all. Only relevant for SENDING_DATA.
138 uint64_t bytes_lost = 0, num_loss_events = 0;
140 TLSContext *tls_context = nullptr;
141 const unsigned char *tls_data_to_send = nullptr;
142 unsigned tls_data_left_to_send = 0;
143 bool in_ktls_mode = false;
146 #endif // !defined(_CLIENT_H)