Merge pull request #130 from jean-airoldie/default_sockopt

Document default socket options in `Socket` trait
jean-airoldie · Feb 13, 2020 · 760bf91 · 760bf91
2 parents bc4c04f + e816495
commit 760bf91
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/libzmq/src/core/mod.rs b/libzmq/src/core/mod.rs
@@ -195,6 +195,12 @@ impl From<Period> for Serde<Option<Duration>> {
 }
 
 /// Methods shared by all thread-safe sockets.
+///
+/// Here is the list of socket option that differs from the ØMQ defaults:
+/// * All sockets have their linger period set to zero (`ZMQ_BLOCKY`).
+/// * All sockets have IPV6 enabled (`ZMQ_IPV6`).
+/// * All sockets have `ZMQ_ZAP_ENFORCE_DOMAIN` set to true.
+/// * All sockets have `ZMQ_ZAP_DOMAIN` hardcoded to "global".
 pub trait Socket: GetRawSocket {
     /// Schedules a connection to a [`Endpoint`].
     ///