diff options
| author |   Rastislav Szabo <raszabo@cisco.com> | 2017-05-04 11:09:03 +0200 |
|---|---|---|
| committer | Rastislav Szabo <raszabo@cisco.com> | 2017-05-04 11:12:35 +0200 |
| commit | a101d966133a70b8a76526be25070436d14fcf9f (patch) | |
| tree | 75e2dbf20de615e58252b780b2ba5baae8fdcf82 /adapter/doc.go | |
| parent | a968ead74525125dff9ae90b1c9a9102e4327900 (diff) | |
initial commit
Signed-off-by: Rastislav Szabo <raszabo@cisco.com>
Diffstat (limited to 'adapter/doc.go')
| -rw-r--r-- | adapter/doc.go | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/adapter/doc.go b/adapter/doc.go new file mode 100644 index 0000000..5b0ac8a --- /dev/null +++ b/adapter/doc.go @@ -0,0 +1,9 @@ +// Package adapter provides an interface between govpp core and the VPP. It is responsible for sending +// and receiving binary-encoded data to/from VPP via shared memory. +// +// The default adapter being used for connection with real VPP is called vppapiclient. It is based on the +// communication with the vppapiclient VPP library written in C via CGO. +// +// Apart from the vppapiclient adapter, mock adapter is provided for unit/integration testing where the actual +// communication with VPP is not demanded. +package adapter |