diff options
Diffstat (limited to 'docs/ADAPTERS.md')
| -rw-r--r-- | docs/ADAPTERS.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/ADAPTERS.md b/docs/ADAPTERS.md new file mode 100644 index 0000000..d3fa8b2 --- /dev/null +++ b/docs/ADAPTERS.md @@ -0,0 +1,37 @@ +# Adapters + +## Pure-Go implementation (recommended) + +GoVPP now supports pure Go implementation for VPP binary API. This does +not depend on CGo or any VPP library and can be easily compiled. + +There are two packages providing pure Go implementations in GoVPP: +- [`socketclient`](adapter/socketclient) - for VPP binary API (via unix socket) +- [`statsclient`](adapter/statsclient) - for VPP stats API (via shared memory) + +## CGo wrapper for vppapiclient library (deprecated) + +GoVPP also provides vppapiclient package which actually uses +`vppapiclient.so` library from VPP codebase to communicate with VPP API. +To build GoVPP, `vpp-dev` package must be installed, +either [from packages][from-packages] or [from sources][from-sources]. + +To build & install `vpp-dev` from sources: + +```sh +git clone https://gerrit.fd.io/r/vpp +cd vpp +make install-dep +make pkg-deb +cd build-root +sudo dpkg -i vpp*.deb +``` + +To build & install GoVPP: + +```sh +go get -u go.fd.io/govpp +cd $GOPATH/src/go.fd.io/govpp +make test +make install +``` |