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