1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
#ifndef FCGI_PROTOCOL_HH
#define FCGI_PROTOCOL_HH
#include <memory>
#include <stdint.h>
#include <string>
class Buffer;
class RoBuffer;
namespace fcgi {
enum RecordType {
BeginRequest = 1,
AbortRequest = 2,
EndRequest = 3,
Params = 4,
Stdin = 5,
Stdout = 6,
Stderr = 7,
Data = 8,
GetValues = 9,
GetValuesResult = 10,
UnknownType = 11,
};
enum Role {
Responder = 1,
Authorizer = 2,
Filter = 3,
};
enum Flags {
KeepConn = 1,
};
enum ProtocolStatus {
RequestComplete = 0,
CantMpxConn = 1,
Overloaded = 2,
UnknownRole = 3,
};
class Record {
public:
virtual ~Record() = default;
virtual bool good() const = 0;
virtual uint8_t type() const = 0;
virtual uint16_t request_id() const = 0;
virtual uint16_t content_length() const = 0;
virtual uint8_t padding_length() const = 0;
static std::unique_ptr<Record> parse(RoBuffer* buffer);
protected:
Record() = default;
Record(Record const&) = delete;
Record& operator=(Record const&) = delete;
};
class BeginRequestBody {
public:
virtual ~BeginRequestBody() = default;
virtual bool good() const = 0;
virtual uint16_t role() const = 0;
virtual uint8_t flags() const = 0;
static std::unique_ptr<BeginRequestBody> parse(Record const* record,
RoBuffer* buffer);
protected:
BeginRequestBody() = default;
BeginRequestBody(BeginRequestBody const&) = delete;
BeginRequestBody& operator=(BeginRequestBody const&) = delete;
};
class RecordStream {
public:
virtual ~RecordStream() = default;
// True if all data has been read from stream.
virtual bool end_of_stream() const = 0;
// True if all data from last added record has been read.
virtual bool end_of_record() const = 0;
// True if no more data is coming, ie. what rbuf() returned last is all
// there will ever be.
virtual bool all_available() = 0;
virtual char const* rbuf(RoBuffer* buf, size_t want, size_t& avail) = 0;
virtual void rcommit(RoBuffer* buf, size_t bytes) = 0;
// Call when next package for stream arrives.
virtual void add(Record const* record) = 0;
// Create stream with record as the first package in stream.
static std::unique_ptr<RecordStream> create_stream(Record const* record);
// Create stream with record as the only package in stream.
static std::unique_ptr<RecordStream> create_single(Record const* record);
protected:
RecordStream() = default;
RecordStream(RecordStream const&) = delete;
RecordStream& operator=(RecordStream const&) = delete;
};
class Pair {
public:
virtual ~Pair() = default;
// Returns false if bad encoding or an invalid stream was found.
// Calling next() will NOT change a false value back to true.
virtual bool good() const = 0;
virtual std::string const& name() const = 0;
virtual std::string const& value() const = 0;
// Returns nullptr if stream and buf needs more data.
static std::unique_ptr<Pair> start(
RecordStream* stream, RoBuffer* buf);
// Returns false if stream and buf needs more data. In that case Pair
// is not modified.
virtual bool next(RecordStream* stream, RoBuffer* buf) = 0;
protected:
Pair() = default;
Pair(Pair const&) = delete;
Pair& operator=(Pair const&) = delete;
};
class RecordBuilder {
public:
virtual ~RecordBuilder() = default;
virtual bool build(Buffer* dst) const = 0;
virtual bool build(char* dst, size_t avail) const = 0;
virtual bool padding(Buffer* dst) const = 0;
virtual bool padding(char* dst, size_t avail) const = 0;
virtual size_t size() const = 0;
static std::unique_ptr<RecordBuilder> create(
RecordType type,
uint16_t request_id,
uint16_t content_length,
int16_t padding_length = -1);
static std::unique_ptr<RecordBuilder> create(
RecordType type,
uint16_t request_id,
std::string body);
static std::unique_ptr<RecordBuilder> create_unknown_type(
uint8_t unknown_type);
static std::unique_ptr<RecordBuilder> create_begin_request(
uint16_t request_id, Role role, uint8_t flags);
static std::unique_ptr<RecordBuilder> create_end_request(
uint16_t request_id, uint32_t app_status, ProtocolStatus protocol_status);
protected:
RecordBuilder() = default;
RecordBuilder(RecordBuilder const&) = delete;
RecordBuilder& operator=(RecordBuilder const&) = delete;
};
class PairBuilder {
public:
virtual ~PairBuilder() = default;
virtual void add(std::string name, std::string value) = 0;
virtual size_t size() const = 0;
virtual bool build(Buffer* buf) const = 0;
static std::unique_ptr<PairBuilder> create();
protected:
PairBuilder() = default;
PairBuilder(PairBuilder const&) = delete;
PairBuilder& operator=(PairBuilder const&) = delete;
};
} // namespace fcgi
#endif // FCGI_PROTOCOL_HH
|
