Keep the HLS backlog even if the stream header changes.
[cubemap] / state.proto
1 syntax = "proto2";
2
3 // Corresponds to struct Client.
4 message ClientProto {
5         optional int32 sock = 1;
6         optional string remote_addr = 8;
7         optional int64 connect_time_sec = 13;
8         optional int32 connect_time_nsec = 14;
9         optional int32 state = 2;
10         optional bytes request = 3;
11         optional string url = 4;
12         optional bytes header_or_short_response_old = 5;  // Only for pre-1.4.0 servers. Use header_or_short_response_index instead.
13         optional int64 header_or_short_response_index = 21;  // Index into CubemapStateProto.short_response_pool.
14         optional int64 header_or_short_response_bytes_sent = 6;
15         optional int64 stream_pos = 7;
16         optional int64 stream_pos_end = 20 [default=-1];
17         optional int64 bytes_sent = 10;
18         optional int64 bytes_lost = 11;
19         optional int64 num_loss_events = 12;
20         optional bytes referer = 15;
21         optional bytes user_agent = 16;
22         optional bytes tls_context = 17;  // If not present, then not using TLS for this client.
23         optional int64 tls_output_bytes_already_consumed = 18;
24         optional bool in_ktls_mode = 19;
25         optional bytes x_playback_session_id = 22;
26         optional bool close_after_response = 23 [default=true];
27         optional bool http_11 = 24 [default=false];
28 };
29
30 // Corresponds to struct Stream::FragmentStart.
31 message FragmentStartProto {
32         optional int64 byte_position = 1;
33         optional double pts = 2;
34         optional bool begins_header = 3 [default=false];
35 };
36
37 // Corresponds to struct Stream.
38 message StreamProto {
39         optional bytes http_header = 6;
40         optional bytes stream_header = 7;
41         repeated int32 data_fds = 8;
42         optional int64 backlog_size = 5 [default=10485760];
43         // Tag 10 is unused from 1.4.0 up (it used to be prebuffering_bytes).
44         optional int64 bytes_received = 3;
45         repeated int64 suitable_starting_point = 9;
46         repeated FragmentStartProto fragment = 11;
47         optional int64 first_fragment_index = 12;
48         optional int64 discontinuity_counter = 13;
49         optional string url = 4;
50 };
51
52 // Corresponds to class Input.
53 message InputProto {
54         optional int32 state = 1;
55         optional string url = 3;
56         optional bytes request = 4;
57         optional int32 request_bytes_sent = 5;
58         optional bytes response = 6;
59         optional bytes http_header = 10;
60         optional bytes stream_header = 14;
61         optional bytes pending_data = 7;
62         optional bool has_metacube_header = 8;
63         optional int32 sock = 9;
64         optional int64 bytes_received = 11;
65         optional int64 data_bytes_received = 12;
66         optional int64 metadata_bytes_received = 16;
67         optional double latency_sec = 17;
68         optional int64 connect_time = 13;
69         optional bool is_metacube_encoded = 15 [default=true];
70 };
71
72 // Corresponds to class Acceptor.
73 message AcceptorProto {
74         optional int32 server_sock = 1;
75         optional int32 port = 2;
76         optional string addr = 3;  // As a string. Empty is equivalent to "::".
77         optional bytes certificate_chain = 4;
78         optional bytes private_key = 5;
79 };
80
81 // For deduplicating strings in header_or_short_response.
82 message ShortResponsePool {
83         optional bytes header_or_short_response = 1;
84 };
85
86 message HLSZombieProto {
87         optional bytes key = 1;
88         optional bytes remote_addr = 2;
89         optional bytes url = 3;
90         optional bytes referer = 4;
91         optional bytes user_agent = 5;
92         optional int64 expires_sec = 6;
93         optional int64 expires_nsec = 7;
94 };
95
96 message CubemapStateProto {
97         optional int64 serialize_start_sec = 6;
98         optional int64 serialize_start_usec = 7;
99         repeated ClientProto clients = 1;
100         repeated StreamProto streams = 2;
101         repeated InputProto inputs = 5;
102         repeated AcceptorProto acceptors = 8;
103         repeated ShortResponsePool short_response_pool = 9;
104         repeated HLSZombieProto hls_zombies = 10;
105 };