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 /core/doc.go | |
parent | a968ead74525125dff9ae90b1c9a9102e4327900 (diff) |
initial commit
Signed-off-by: Rastislav Szabo <raszabo@cisco.com>
Diffstat (limited to 'core/doc.go')
-rw-r--r-- | core/doc.go | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/core/doc.go b/core/doc.go new file mode 100644 index 0000000..a4ecd50 --- /dev/null +++ b/core/doc.go @@ -0,0 +1,20 @@ +// Package core provides connectivity to VPP via the adapter: sends and receives the messages to/from VPP, +// marshalls/unmarshalls them and forwards them between the client Go channels and the VPP. +// +// The interface_plugin APIs the core exposes is tied to a connection: Connect provides a connection, that cane be +// later used to request an API channel via NewAPIChannel / NewAPIChannelBuffered functions: +// +// conn, err := govpp.Connect() +// if err != nil { +// // handle error! +// } +// defer conn.Disconnect() +// +// ch, err := conn.NewAPIChannel() +// if err != nil { +// // handle error! +// } +// defer ch.Close() +// +// Note that one application can open only one connection, that can serve multiple API channels. +package core |