summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/ftrvxmtrx/fd/README.md
diff options
context:
space:
mode:
authorOndrej Fabry <ofabry@cisco.com>2019-06-20 18:52:30 +0200
committerOndrej Fabry <ofabry@cisco.com>2019-06-20 18:52:30 +0200
commitda15c397b3dbbba07d159b3af767aa13d443cfd6 (patch)
tree284e4207377df3c0952656d4f75459a96d0ecb36 /vendor/github.com/ftrvxmtrx/fd/README.md
parent682250e328472e855a4c59e9e5f004473b6af0d3 (diff)
Add statsclient - pure Go implementation for stats API
Change-Id: Ia5bab652c6089378697459f477f9060dc7a53e90 Signed-off-by: Ondrej Fabry <ofabry@cisco.com>
Diffstat (limited to 'vendor/github.com/ftrvxmtrx/fd/README.md')
-rw-r--r--vendor/github.com/ftrvxmtrx/fd/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/vendor/github.com/ftrvxmtrx/fd/README.md b/vendor/github.com/ftrvxmtrx/fd/README.md
new file mode 100644
index 0000000..7a8a239
--- /dev/null
+++ b/vendor/github.com/ftrvxmtrx/fd/README.md
@@ -0,0 +1,25 @@
+# fd
+
+Package fd provides a simple API to pass file descriptors
+between different OS processes.
+
+It can be useful if you want to inherit network connections
+from another process without closing them.
+
+Example scenario:
+
+ * Running server receives a "let's upgrade" message
+ * Server opens a Unix domain socket for the "upgrade"
+ * Server starts a new copy of itself and passes Unix domain
+ socket name
+ * New copy starts reading data from the socket
+ * Server sends its state over the socket, also sending the number
+ of network connections to inherit, then it sends those connections
+ using fd.Put()
+ * New server copy reads the state and inherits connections using fd.Get(),
+ checks that everything is OK and writes an "OK" message to the socket
+ * Server receives "OK" message and kills itself
+
+## Documentation
+
+[fd on godoc.org](http://godoc.org/github.com/ftrvxmtrx/fd)