vppapiclient

Documentation

Overview

Package vppapiclient is the default VPP adapter being used for the connection to VPP binary & stats API via shared memory. It is essentially Go wrapper for the VPP vppapiclient library written in C.

DEPRECATED: The vppapiclient implementation has been deprecated. Use socketclient and statsclient.

Index

• Variables
• func NewStatClient(socketName string) adapter.StatsAPI
• func NewVppClient(shmPrefix string) adapter.VppAPI
• func NewVppClientWithInputQueueSize(shmPrefix string, inputQueueSize uint16) adapter.VppAPI

Variables

var (
	// MaxWaitReady defines maximum duration before waiting for shared memory
	// segment times out
	MaxWaitReady = time.Second * 10
)

Functions

func NewStatClient

func NewStatClient(socketName string) adapter.StatsAPI

NewStatClient returns new VPP stats API client.

func NewVppClient

func NewVppClient(shmPrefix string) adapter.VppAPI

NewVppClient returns a new VPP binary API client.

func NewVppClientWithInputQueueSize

func NewVppClientWithInputQueueSize(shmPrefix string, inputQueueSize uint16) adapter.VppAPI

NewVppClientWithInputQueueSize returns a new VPP binary API client with a custom input queue size.