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