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;
36 // Serialization/deserialization.
37 Client(const ClientProto &serialized, const std::vector<std::shared_ptr<const std::string>> &short_responses, Stream *stream);
38 ClientProto serialize(std::unordered_map<const std::string *, size_t> *short_response_pool) const;
40 ClientStats get_stats() const;
42 // The file descriptor associated with this socket.
45 // When the client connected, in terms of CLOCK_MONOTONIC_COARSE.
46 timespec connect_time;
48 // Some information only used for logging.
49 std::string remote_addr;
51 std::string user_agent;
53 enum State { READING_REQUEST, SENDING_HEADER, SENDING_DATA, SENDING_SHORT_RESPONSE, WAITING_FOR_KEYFRAME, PREBUFFERING };
54 State state = READING_REQUEST;
56 // The HTTP request, as sent by the client. If we are in READING_REQUEST,
57 // this might not be finished.
60 // What stream we're connecting to; parsed from <request>.
61 // Not relevant for READING_REQUEST.
63 Stream *stream = nullptr;
65 // Whether we should close the connection after sending the response.
66 // Not relevant for READING_REQUEST. Must be true if http_11 is false.
67 bool close_after_response;
69 // Whether the request came in over HTTP/1.1 or higher.
72 // The header we want to send, or the response with headers if we know
73 // it in its entirety after reading the request (typically an error).
74 // This is nominally a copy of Stream::header, but since that might
75 // change on reconnects etc., we keep a local copy here. Only relevant
76 // for SENDING_HEADER or SENDING_SHORT_RESPONSE; blank otherwise.
78 // Must start with the string "HTTP/1.0 ", which will be changed to 1.1
80 const std::string *header_or_short_response = nullptr;
82 // <header_or_short_response> can come from two distinct places; it can be
83 // local to the Client object, or it can be shared between many Clients
84 // (typically HLS playlists, that can be so large that they are expensive
85 // to hold in many copies). <header_or_short_response> will point to exactly
86 // one of these, which should be cleared out/dereferenced when it is
89 // The use of shared_ptr is somewhat overkill since we don't need
90 // to access the HLS playlists from multiple threads, but it's not a
92 std::string header_or_short_response_holder;
93 std::shared_ptr<const std::string> header_or_short_response_ref;
95 // Number of bytes we've sent of the header. Only relevant for SENDING_HEADER
96 // or SENDING_SHORT_RESPONSE.
97 size_t header_or_short_response_bytes_sent = 0;
99 // Number of bytes we are into the stream (ie., the end of last send).
100 // -1 means we want to send from the end of the backlog (the normal case),
101 // although only at a keyframe.
102 // -2 means we want to send from the _beginning_ of the backlog.
103 // -3 means we sent the header only.
104 static const size_t STREAM_POS_AT_END = -1;
105 static const size_t STREAM_POS_AT_START = -2;
106 static const size_t STREAM_POS_HEADER_ONLY = -3;
108 // Once we go into WAITING_FOR_KEYFRAME, PREBUFFERING or SENDING_DATA,
109 // these negative values will be translated to real numbers.
110 size_t stream_pos = 0;
112 // Position at which to end the stream (one-past-the-end, used for fragments).
113 // -1 means never to end; this is the common case.
114 static const size_t STREAM_POS_NO_END = -1;
115 size_t stream_pos_end = 0;
117 // Number of bytes we've sent of data. Only relevant for SENDING_DATA.
118 size_t bytes_sent = 0;
120 // Number of times we've skipped forward due to the backlog being too big,
121 // and how many bytes we've skipped over in all. Only relevant for SENDING_DATA.
122 size_t bytes_lost = 0, num_loss_events = 0;
124 TLSContext *tls_context = nullptr;
125 const unsigned char *tls_data_to_send = nullptr;
126 unsigned tls_data_left_to_send = 0;
127 bool in_ktls_mode = false;
130 #endif // !defined(_CLIENT_H)