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