aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorewang <[email protected]>2024-03-01 12:39:07 -0800
committerYuchen Wu <[email protected]>2024-03-01 13:47:27 -0800
commit8dc94d6cc4c28799d2f0cdaa9eaaacc6f9b109eb (patch)
tree125430854bc3333b21dcbccc79c995a6d952ff25
parent8160ad169878ea6b4884b977f2a96541083036c4 (diff)
downloadpingora-8dc94d6cc4c28799d2f0cdaa9eaaacc6f9b109eb.tar.gz
pingora-8dc94d6cc4c28799d2f0cdaa9eaaacc6f9b109eb.zip
More minor comment fixes and improvements
-rw-r--r--.bleep2
-rw-r--r--pingora-core/src/listeners/tls.rs2
-rw-r--r--pingora-core/src/protocols/http/compression/mod.rs2
-rw-r--r--pingora-proxy/tests/utils/conf/origin/conf/nginx.conf4
-rw-r--r--pingora-timeout/src/fast_timeout.rs8
5 files changed, 9 insertions, 9 deletions
diff --git a/.bleep b/.bleep
index af0e4bc..ff99b8e 100644
--- a/.bleep
+++ b/.bleep
@@ -1 +1 @@
-39f0cfd032dab4ed6a064873c44b7f96a7710df4 \ No newline at end of file
+20f290d8adc57ed489bcdd1b950833d0eb6bd8ed \ No newline at end of file
diff --git a/pingora-core/src/listeners/tls.rs b/pingora-core/src/listeners/tls.rs
index 5152582..c8f0e74 100644
--- a/pingora-core/src/listeners/tls.rs
+++ b/pingora-core/src/listeners/tls.rs
@@ -53,7 +53,7 @@ impl DerefMut for TlsSettings {
}
impl TlsSettings {
- /// Create a new [`TlsSettings`] with the [Mozilla Intermediate](https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28recommended.29).
+ /// Create a new [`TlsSettings`] with the [Mozilla Intermediate](https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28recommended.29)
/// server side TLS settings. Users can adjust the TLS settings after this object is created.
/// Return error if the provided certificate and private key are invalid or not found.
pub fn intermediate(cert_path: &str, key_path: &str) -> Result<Self> {
diff --git a/pingora-core/src/protocols/http/compression/mod.rs b/pingora-core/src/protocols/http/compression/mod.rs
index 1a5cef2..26d4fb8 100644
--- a/pingora-core/src/protocols/http/compression/mod.rs
+++ b/pingora-core/src/protocols/http/compression/mod.rs
@@ -255,7 +255,7 @@ enum Algorithm {
Gzip,
Brotli,
Zstd,
- // TODO: Identify,
+ // TODO: Identity,
// TODO: Deflate
Other, // anything unknown
}
diff --git a/pingora-proxy/tests/utils/conf/origin/conf/nginx.conf b/pingora-proxy/tests/utils/conf/origin/conf/nginx.conf
index 6e55d30..31d3205 100644
--- a/pingora-proxy/tests/utils/conf/origin/conf/nginx.conf
+++ b/pingora-proxy/tests/utils/conf/origin/conf/nginx.conf
@@ -254,8 +254,8 @@ http {
}
# 1. A origin load balancer that rejects reused connections.
- # this is to simulate the common problem when customers LB drops
- # connection silently after being keepalived for awhile
+ # This is to simulate the common problem when an upstream LB drops
+ # a connection silently after being `keepalive`d for a while.
# 2. A middlebox might drop the connection if the origin takes too long
# to respond. We should not retry in this case.
location /bad_lb {
diff --git a/pingora-timeout/src/fast_timeout.rs b/pingora-timeout/src/fast_timeout.rs
index e5e3643..d8f9c25 100644
--- a/pingora-timeout/src/fast_timeout.rs
+++ b/pingora-timeout/src/fast_timeout.rs
@@ -14,14 +14,14 @@
//! The fast and more complicated version of pingora-timeout
//!
-//! The following optimizations are applied
+//! The following optimizations are applied:
//! - The timeouts lazily initialize their timer when the Future is pending for the first time.
//! - There is no global lock for creating and cancelling timeouts.
//! - Timeout timers are rounded to the next 10ms tick and timers are shared across all timeouts with the same deadline.
//!
-//! In order for this to work, a standalone thread is created to arm the timers, which has its
-//! overheads. As a general rule, the benefits of this doesn't outweigh the overhead unless
-//! there are more than about 100/s timeout() calls in the system. Use regular tokio timeout or
+//! In order for this to work, a standalone thread is created to arm the timers, which has some
+//! overhead. As a general rule, the benefits of this don't outweigh the overhead unless
+//! there are more than about 100 timeout() calls/sec in the system. Use regular tokio timeout or
//! [super::tokio_timeout] in the low usage case.
use super::timer::*;