address.proto: added doc for abstract sockets (#462)

Signed-off-by: Sylvain Mellak <sylvainm@google.com>
7 years ago · 724c6c1ffa
parent 39c7658a1b
commit 724c6c1ffa
1 changed files with 4 additions and 1 deletions
--- a/envoy/api/v2/core/address.proto
+++ b/envoy/api/v2/core/address.proto
@ -12,7 +12,10 @@ option (gogoproto.equal_all) = true;
 // [#protodoc-title: Network addresses]

 message Pipe {
-  // Unix Domain Socket path.
+  // Unix Domain Socket path. On Linux, paths starting with '@' will use the
+  // abstract namespace. The starting '@' is replaced by a null byte by Envoy.
+  // Paths starting with '@' will result in an error in environments other than
+  // Linux.
  string path = 1 [(validate.rules).string.min_bytes = 1];
 }