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