52 releases (6 stable)
1.1.0-rc.1 | Jul 25, 2024 |
---|---|
1.0.5 | Oct 14, 2024 |
1.0.2 | Jun 3, 2024 |
1.0.0-rc.1 | Mar 19, 2024 |
0.2.0 | Apr 20, 2017 |
#191 in Network programming
423 downloads per month
Used in 8 crates
425KB
10K
SLoC
sozu-command-lib, tools to communicate with the Sōzu proxy
The sozu proxy can receive dynamic configuration changes through a unix socket. This library defines the communication protocol, the message format, the required structures, serialization and deserialization code.
Command messages are defined in protobuf
Protobuf is a language-agnostic, binary serialization format used to efficiently transmit structured data between different systems and languages.
The idea is to define the data once in this format, so that various libraries of various languages can translate it to their own.
All types are defined in the command.proto
file.
There are two main types received by, and sent from, Sōzu:
Request
Response
They look like this, in protobuf:
// A message received by Sōzu to change its state or query information
message Request {
oneof request_type {
// save Sōzu's parseable state as a file, with a path
string save_state = 1;
// load a state file, given its path
string load_state = 2;
/*
40 more requests
*/
}
}
// Response to a request
message Response {
// wether the request was a success, a failure, or is processing
required ResponseStatus status = 1 [default = FAILURE];
// a success or error message
required string message = 2;
// response data, if any
optional ResponseContent content = 3;
}
These are serialized in binary, NOT in plain text formats like JSON.
A response can have 3 possible status:
Ok
: the task was doneFailure
: there was an unrecoverable errorProcessing
: the task was started but may not finish right away
As an example, in a soft shutdown, the shutdown message is sent to all
the workers, and they acknowledge the message by sending an answer
with the Processing
status: in a soft shutdown, a worker stops accepting
new connections but keeps the active ones and exits when they are no longer
active. Once all connections are done, a worker will send an answer
with the same id and the Ok
status.
Dependencies
~8–18MB
~243K SLoC