git.sesse.net Git - cubemap/blob - stream.h

   1 #ifndef _STREAM_H
   2 #define _STREAM_H 1
   3
   4 // Representation of a single, muxed (we only really care about bytes/blocks) stream.
   5 // Fed by Input, sent out by Server (to Client).
   6
   7 #include <stddef.h>
   8 #include <stdint.h>
   9 #include <string>
  10 #include <vector>
  11
  12 class MarkPool;
  13 class StreamProto;
  14 struct Client;
  15
  16 struct Stream {
  17         Stream(const std::string &stream_id, size_t backlog_size);
  18         ~Stream();
  19
  20         // Serialization/deserialization.
  21         Stream(const StreamProto &serialized);
  22         StreamProto serialize();
  23
  24         std::string stream_id;
  25
  26         // The HTTP response header, plus the video stream header (if any).
  27         std::string header;
  28
  29         // The stream data itself, stored in a circular buffer.
  30         //
  31         // We store our data in a file, so that we can send the data to the
  32         // kernel only once (with write()). We then use sendfile() for each
  33         // client, which effectively zero-copies it out of the kernel's buffer
  34         // cache. This is significantly more efficient than doing write() from
  35         // a userspace memory buffer, since the latter makes the kernel copy
  36         // the same data from userspace many times.
  37         int data_fd;
  38
  39         // How many bytes <data_fd> can hold (the buffer size).
  40         size_t backlog_size;
  41
  42         // How many bytes this stream have received. Can very well be larger
  43         // than <backlog_size>, since the buffer wraps.
  44         size_t bytes_received;
  45
  46         // Clients that are in SENDING_DATA, but that we don't listen on,
  47         // because we currently don't have any data for them.
  48         // See put_client_to_sleep() and wake_up_all_clients().
  49         std::vector<Client *> sleeping_clients;
  50
  51         // Clients that we recently got data for (when they were in
  52         // <sleeping_clients>).
  53         std::vector<Client *> to_process;
  54
  55         // What pool to fetch marks from, or NULL.
  56         MarkPool *mark_pool;
  57
  58         // Put client to sleep, since there is no more data for it; we will on
  59         // longer listen on POLLOUT until we get more data. Also, it will be put
  60         // in the list of clients to wake up when we do.
  61         void put_client_to_sleep(Client *client);
  62
  63         // We have more data, so mark all clients that are sleeping as ready to go.
  64         void wake_up_all_clients();
  65
  66 private:
  67         Stream(const Stream& other);
  68 };
  69
  70 #endif  // !defined(_STREAM_H)