From a38142939e84670f7743a1026189d83f56126e40 Mon Sep 17 00:00:00 2001 From: Brandon Nozaki Miller Date: Sat, 1 Mar 2014 09:54:32 -0800 Subject: [PATCH] added disconnect documentation --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 56dd080..dc94a3e 100644 --- a/README.md +++ b/README.md @@ -158,6 +158,21 @@ or only explicitly setting port and callback } ); +---- +##### disconnect + +``ipc.disconnect(id)`` + +Used to disconnect a client from a Unix, TCP or TLS socket. The socket and its refrence will be removed from memory and the ``ipc.of`` scope. This can be local or remote. UDP clients do not maintain connections and so there are no Clients and this method has no value to them. + +| variable | required | definition | +|----------|----------|------------| +| id | required | is the string id of the socket from which to disconnect. | + +**examples** + + ipc.disconnect('world'); + ---- ##### serve ``ipc.serve(path,callback);``