Code Review
/
govpp.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
review
|
tree
raw
|
inline
| side by side
Optimize socketclient adapter and add various code improvements
[govpp.git]
/
adapter
/
socketclient
/
doc.go
diff --git
a/adapter/socketclient/doc.go
b/adapter/socketclient/doc.go
index
0f93c56
..
cbb00a2
100644
(file)
--- a/
adapter/socketclient/doc.go
+++ b/
adapter/socketclient/doc.go
@@
-21,13
+21,18
@@
//
// Requirements
//
//
// Requirements
//
-// The socketclient will connect to /run/vpp-api.sock by default. However this
-// is not enabled in VPP configuration by default.
+// The socketclient connects to unix domain socket defined in VPP configuration.
//
//
-//
To enable the socket in VPP, add following section to VPP config.
+//
It is enabled by default at /run/vpp/api.sock by the following config section:
//
// socksvr {
//
// socksvr {
-// default
+// socket-name default
+// }
+//
+// If you want to use custom socket path:
+//
+// socksvr {
+// socket-name /run/vpp/api.sock
// }
//
package socketclient
// }
//
package socketclient