Keep information about HLS downloads around for some time afterwards.
[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 };
27
28 // Corresponds to struct Stream::FragmentStart.
29 message FragmentStartProto {
30         optional int64 byte_position = 1;
31         optional double pts = 2;
32 };
33
34 // Corresponds to struct Stream.
35 message StreamProto {
36         optional bytes http_header = 6;
37         optional bytes stream_header = 7;
38         repeated int32 data_fds = 8;
39         optional int64 backlog_size = 5 [default=10485760];
40         // Tag 10 is unused from 1.4.0 up (it used to be prebuffering_bytes).
41         optional int64 bytes_received = 3;
42         repeated int64 suitable_starting_point = 9;
43         repeated FragmentStartProto fragment = 11;
44         optional int64 first_fragment_index = 12;
45         optional int64 discontinuity_counter = 13;
46         optional string url = 4;
47 };
48
49 // Corresponds to class Input.
50 message InputProto {
51         optional int32 state = 1;
52         optional string url = 3;
53         optional bytes request = 4;
54         optional int32 request_bytes_sent = 5;
55         optional bytes response = 6;
56         optional bytes http_header = 10;
57         optional bytes stream_header = 14;
58         optional bytes pending_data = 7;
59         optional bool has_metacube_header = 8;
60         optional int32 sock = 9;
61         optional int64 bytes_received = 11;
62         optional int64 data_bytes_received = 12;
63         optional int64 metadata_bytes_received = 16;
64         optional double latency_sec = 17;
65         optional int64 connect_time = 13;
66         optional bool is_metacube_encoded = 15 [default=true];
67 };
68
69 // Corresponds to class Acceptor.
70 message AcceptorProto {
71         optional int32 server_sock = 1;
72         optional int32 port = 2;
73         optional string addr = 3;  // As a string. Empty is equivalent to "::".
74         optional bytes certificate_chain = 4;
75         optional bytes private_key = 5;
76 };
77
78 // For deduplicating strings in header_or_short_response.
79 message ShortResponsePool {
80         optional bytes header_or_short_response = 1;
81 };
82
83 message HLSZombieProto {
84         optional bytes key = 1;
85         optional bytes remote_addr = 2;
86         optional bytes url = 3;
87         optional bytes referer = 4;
88         optional bytes user_agent = 5;
89         optional int64 expires_sec = 6;
90         optional int64 expires_nsec = 7;
91 };
92
93 message CubemapStateProto {
94         optional int64 serialize_start_sec = 6;
95         optional int64 serialize_start_usec = 7;
96         repeated ClientProto clients = 1;
97         repeated StreamProto streams = 2;
98         repeated InputProto inputs = 5;
99         repeated AcceptorProto acceptors = 8;
100         repeated ShortResponsePool short_response_pool = 9;
101         repeated HLSZombieProto hls_zombies = 10;
102 };