api

package
v0.0.0-...-fec2341 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 16, 2019 License: MIT Imports: 6 Imported by: 1

Documentation

Overview

Package api is a generated protocol buffer package.

It is generated from these files:

bfd-api/bfd-api.proto

It has these top-level messages:

StartRequest
StopRequest
AddPeerRequest
AddPeerResponse
UpdatePeerRequest
DeletePeerRequest
ListPeerRequest
ListPeerResponse
GetPeerStateRequest
MonitorPeerRequest
PeerStateResponse
DisablePeerRequest
EnablePeerRequest
Peer
Authentication
PeerState

Index

Constants

This section is empty.

Variables

View Source
var AuthenticationType_name = map[int32]string{
	0: "NONE",
	1: "SIMPLE_PASSWORD",
	2: "KEYED_MD5",
	3: "METICULOUS_KEYED_MD5",
	4: "KEYED_SHA1",
	5: "METICULOUS_KEYED_SHA1",
}
View Source
var AuthenticationType_value = map[string]int32{
	"NONE":                  0,
	"SIMPLE_PASSWORD":       1,
	"KEYED_MD5":             2,
	"METICULOUS_KEYED_MD5":  3,
	"KEYED_SHA1":            4,
	"METICULOUS_KEYED_SHA1": 5,
}
View Source
var DiagnosticCode_name = map[int32]string{
	0: "NO_DIAGNOSTIC",
	1: "CONTROL_DETECTION_TIME_EXPIRED",
	2: "ECHO_FUNCTION_FAILED",
	3: "NEIGHBOR_SIGNALED_SESSION_DOWN",
	4: "FORWARDING_PLANE_RESET",
	5: "PATH_DOWN",
	6: "CONCATENATED_PATH_DOWN",
	7: "ADMINISTRATIVELY_DOWN",
	8: "REVERSE_CONCATENATED_PATH_DOWN",
}
View Source
var DiagnosticCode_value = map[string]int32{
	"NO_DIAGNOSTIC":                  0,
	"CONTROL_DETECTION_TIME_EXPIRED": 1,
	"ECHO_FUNCTION_FAILED":           2,
	"NEIGHBOR_SIGNALED_SESSION_DOWN": 3,
	"FORWARDING_PLANE_RESET":         4,
	"PATH_DOWN":                      5,
	"CONCATENATED_PATH_DOWN":         6,
	"ADMINISTRATIVELY_DOWN":          7,
	"REVERSE_CONCATENATED_PATH_DOWN": 8,
}
View Source
var SessionState_name = map[int32]string{
	0: "ADMIN_DOWN",
	1: "DOWN",
	2: "INIT",
	3: "UP",
}
View Source
var SessionState_value = map[string]int32{
	"ADMIN_DOWN": 0,
	"DOWN":       1,
	"INIT":       2,
	"UP":         3,
}

Functions

func RegisterBfdApiServer

func RegisterBfdApiServer(s *grpc.Server, srv BfdApiServer)

Types

type AddPeerRequest

type AddPeerRequest struct {
	Peer *Peer `protobuf:"bytes,1,opt,name=peer" json:"peer,omitempty"`
}

func (*AddPeerRequest) Descriptor

func (*AddPeerRequest) Descriptor() ([]byte, []int)

func (*AddPeerRequest) GetPeer

func (m *AddPeerRequest) GetPeer() *Peer

func (*AddPeerRequest) ProtoMessage

func (*AddPeerRequest) ProtoMessage()

func (*AddPeerRequest) Reset

func (m *AddPeerRequest) Reset()

func (*AddPeerRequest) String

func (m *AddPeerRequest) String() string

type AddPeerResponse

type AddPeerResponse struct {
	Uuid []byte `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
}

func (*AddPeerResponse) Descriptor

func (*AddPeerResponse) Descriptor() ([]byte, []int)

func (*AddPeerResponse) GetUuid

func (m *AddPeerResponse) GetUuid() []byte

func (*AddPeerResponse) ProtoMessage

func (*AddPeerResponse) ProtoMessage()

func (*AddPeerResponse) Reset

func (m *AddPeerResponse) Reset()

func (*AddPeerResponse) String

func (m *AddPeerResponse) String() string

type Authentication

type Authentication struct {
	Type     AuthenticationType `protobuf:"varint,1,opt,name=type,enum=api.AuthenticationType" json:"type,omitempty"`
	Password string             `protobuf:"bytes,2,opt,name=password" json:"password,omitempty"`
}

Password can either start with 0x.... -> then it's hex or be a string

SimplePassword = 16 bytes MD5 = 16 bytes SHA1 = 20 bytes

func (*Authentication) Descriptor

func (*Authentication) Descriptor() ([]byte, []int)

func (*Authentication) GetPassword

func (m *Authentication) GetPassword() string

func (*Authentication) GetType

func (m *Authentication) GetType() AuthenticationType

func (*Authentication) ProtoMessage

func (*Authentication) ProtoMessage()

func (*Authentication) Reset

func (m *Authentication) Reset()

func (*Authentication) String

func (m *Authentication) String() string

type AuthenticationType

type AuthenticationType int32
const (
	AuthenticationType_NONE                  AuthenticationType = 0
	AuthenticationType_SIMPLE_PASSWORD       AuthenticationType = 1
	AuthenticationType_KEYED_MD5             AuthenticationType = 2
	AuthenticationType_METICULOUS_KEYED_MD5  AuthenticationType = 3
	AuthenticationType_KEYED_SHA1            AuthenticationType = 4
	AuthenticationType_METICULOUS_KEYED_SHA1 AuthenticationType = 5
)

func (AuthenticationType) EnumDescriptor

func (AuthenticationType) EnumDescriptor() ([]byte, []int)

func (AuthenticationType) String

func (x AuthenticationType) String() string

type BfdApiClient

type BfdApiClient interface {
	// Manage the overall server state
	Start(ctx context.Context, in *StartRequest, opts ...grpc.CallOption) (*google_protobuf.Empty, error)
	Stop(ctx context.Context, in *StopRequest, opts ...grpc.CallOption) (*google_protobuf.Empty, error)
	// Manage the peers of the bfd server
	AddPeer(ctx context.Context, in *AddPeerRequest, opts ...grpc.CallOption) (*AddPeerResponse, error)
	UpdatePeer(ctx context.Context, in *UpdatePeerRequest, opts ...grpc.CallOption) (*google_protobuf.Empty, error)
	DeletePeer(ctx context.Context, in *DeletePeerRequest, opts ...grpc.CallOption) (*google_protobuf.Empty, error)
	ListPeer(ctx context.Context, in *ListPeerRequest, opts ...grpc.CallOption) (BfdApi_ListPeerClient, error)
	// Manage the state of the peers of the bfd server
	GetPeerState(ctx context.Context, in *GetPeerStateRequest, opts ...grpc.CallOption) (*PeerStateResponse, error)
	MonitorPeer(ctx context.Context, in *MonitorPeerRequest, opts ...grpc.CallOption) (BfdApi_MonitorPeerClient, error)
	DisablePeer(ctx context.Context, in *DisablePeerRequest, opts ...grpc.CallOption) (*google_protobuf.Empty, error)
	EnablePeer(ctx context.Context, in *EnablePeerRequest, opts ...grpc.CallOption) (*google_protobuf.Empty, error)
}

func NewBfdApiClient

func NewBfdApiClient(cc *grpc.ClientConn) BfdApiClient

type BfdApiServer

type BfdApiServer interface {
	// Manage the overall server state
	Start(context.Context, *StartRequest) (*google_protobuf.Empty, error)
	Stop(context.Context, *StopRequest) (*google_protobuf.Empty, error)
	// Manage the peers of the bfd server
	AddPeer(context.Context, *AddPeerRequest) (*AddPeerResponse, error)
	UpdatePeer(context.Context, *UpdatePeerRequest) (*google_protobuf.Empty, error)
	DeletePeer(context.Context, *DeletePeerRequest) (*google_protobuf.Empty, error)
	ListPeer(*ListPeerRequest, BfdApi_ListPeerServer) error
	// Manage the state of the peers of the bfd server
	GetPeerState(context.Context, *GetPeerStateRequest) (*PeerStateResponse, error)
	MonitorPeer(*MonitorPeerRequest, BfdApi_MonitorPeerServer) error
	DisablePeer(context.Context, *DisablePeerRequest) (*google_protobuf.Empty, error)
	EnablePeer(context.Context, *EnablePeerRequest) (*google_protobuf.Empty, error)
}

type BfdApi_ListPeerClient

type BfdApi_ListPeerClient interface {
	Recv() (*ListPeerResponse, error)
	grpc.ClientStream
}

type BfdApi_ListPeerServer

type BfdApi_ListPeerServer interface {
	Send(*ListPeerResponse) error
	grpc.ServerStream
}

type BfdApi_MonitorPeerClient

type BfdApi_MonitorPeerClient interface {
	Recv() (*PeerStateResponse, error)
	grpc.ClientStream
}

type BfdApi_MonitorPeerServer

type BfdApi_MonitorPeerServer interface {
	Send(*PeerStateResponse) error
	grpc.ServerStream
}

type DeletePeerRequest

type DeletePeerRequest struct {
	Uuid []byte `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
}

func (*DeletePeerRequest) Descriptor

func (*DeletePeerRequest) Descriptor() ([]byte, []int)

func (*DeletePeerRequest) GetUuid

func (m *DeletePeerRequest) GetUuid() []byte

func (*DeletePeerRequest) ProtoMessage

func (*DeletePeerRequest) ProtoMessage()

func (*DeletePeerRequest) Reset

func (m *DeletePeerRequest) Reset()

func (*DeletePeerRequest) String

func (m *DeletePeerRequest) String() string

type DiagnosticCode

type DiagnosticCode int32
const (
	DiagnosticCode_NO_DIAGNOSTIC                  DiagnosticCode = 0
	DiagnosticCode_CONTROL_DETECTION_TIME_EXPIRED DiagnosticCode = 1
	DiagnosticCode_ECHO_FUNCTION_FAILED           DiagnosticCode = 2
	DiagnosticCode_NEIGHBOR_SIGNALED_SESSION_DOWN DiagnosticCode = 3
	DiagnosticCode_FORWARDING_PLANE_RESET         DiagnosticCode = 4
	DiagnosticCode_PATH_DOWN                      DiagnosticCode = 5
	DiagnosticCode_CONCATENATED_PATH_DOWN         DiagnosticCode = 6
	DiagnosticCode_ADMINISTRATIVELY_DOWN          DiagnosticCode = 7
	DiagnosticCode_REVERSE_CONCATENATED_PATH_DOWN DiagnosticCode = 8
)

func (DiagnosticCode) EnumDescriptor

func (DiagnosticCode) EnumDescriptor() ([]byte, []int)

func (DiagnosticCode) String

func (x DiagnosticCode) String() string

type DisablePeerRequest

type DisablePeerRequest struct {
	Uuid []byte `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
}

func (*DisablePeerRequest) Descriptor

func (*DisablePeerRequest) Descriptor() ([]byte, []int)

func (*DisablePeerRequest) GetUuid

func (m *DisablePeerRequest) GetUuid() []byte

func (*DisablePeerRequest) ProtoMessage

func (*DisablePeerRequest) ProtoMessage()

func (*DisablePeerRequest) Reset

func (m *DisablePeerRequest) Reset()

func (*DisablePeerRequest) String

func (m *DisablePeerRequest) String() string

type EnablePeerRequest

type EnablePeerRequest struct {
	Uuid []byte `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
}

func (*EnablePeerRequest) Descriptor

func (*EnablePeerRequest) Descriptor() ([]byte, []int)

func (*EnablePeerRequest) GetUuid

func (m *EnablePeerRequest) GetUuid() []byte

func (*EnablePeerRequest) ProtoMessage

func (*EnablePeerRequest) ProtoMessage()

func (*EnablePeerRequest) Reset

func (m *EnablePeerRequest) Reset()

func (*EnablePeerRequest) String

func (m *EnablePeerRequest) String() string

type GetPeerStateRequest

type GetPeerStateRequest struct {
	Uuid []byte `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
}

func (*GetPeerStateRequest) Descriptor

func (*GetPeerStateRequest) Descriptor() ([]byte, []int)

func (*GetPeerStateRequest) GetUuid

func (m *GetPeerStateRequest) GetUuid() []byte

func (*GetPeerStateRequest) ProtoMessage

func (*GetPeerStateRequest) ProtoMessage()

func (*GetPeerStateRequest) Reset

func (m *GetPeerStateRequest) Reset()

func (*GetPeerStateRequest) String

func (m *GetPeerStateRequest) String() string

type ListPeerRequest

type ListPeerRequest struct {
}

func (*ListPeerRequest) Descriptor

func (*ListPeerRequest) Descriptor() ([]byte, []int)

func (*ListPeerRequest) ProtoMessage

func (*ListPeerRequest) ProtoMessage()

func (*ListPeerRequest) Reset

func (m *ListPeerRequest) Reset()

func (*ListPeerRequest) String

func (m *ListPeerRequest) String() string

type ListPeerResponse

type ListPeerResponse struct {
	Uuid []byte `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	Peer *Peer  `protobuf:"bytes,2,opt,name=peer" json:"peer,omitempty"`
}

func (*ListPeerResponse) Descriptor

func (*ListPeerResponse) Descriptor() ([]byte, []int)

func (*ListPeerResponse) GetPeer

func (m *ListPeerResponse) GetPeer() *Peer

func (*ListPeerResponse) GetUuid

func (m *ListPeerResponse) GetUuid() []byte

func (*ListPeerResponse) ProtoMessage

func (*ListPeerResponse) ProtoMessage()

func (*ListPeerResponse) Reset

func (m *ListPeerResponse) Reset()

func (*ListPeerResponse) String

func (m *ListPeerResponse) String() string

type MonitorPeerRequest

type MonitorPeerRequest struct {
	Uuid []byte `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
}

func (*MonitorPeerRequest) Descriptor

func (*MonitorPeerRequest) Descriptor() ([]byte, []int)

func (*MonitorPeerRequest) GetUuid

func (m *MonitorPeerRequest) GetUuid() []byte

func (*MonitorPeerRequest) ProtoMessage

func (*MonitorPeerRequest) ProtoMessage()

func (*MonitorPeerRequest) Reset

func (m *MonitorPeerRequest) Reset()

func (*MonitorPeerRequest) String

func (m *MonitorPeerRequest) String() string

type Peer

type Peer struct {
	Name                  string          `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Address               string          `protobuf:"bytes,2,opt,name=address" json:"address,omitempty"`
	DesiredMinTxInterval  uint32          `protobuf:"varint,3,opt,name=desired_min_tx_interval,json=desiredMinTxInterval" json:"desired_min_tx_interval,omitempty"`
	RequiredMinRxInterval uint32          `protobuf:"varint,4,opt,name=required_min_rx_interval,json=requiredMinRxInterval" json:"required_min_rx_interval,omitempty"`
	DetectMultiplier      uint32          `protobuf:"varint,5,opt,name=detect_multiplier,json=detectMultiplier" json:"detect_multiplier,omitempty"`
	IsMultiHop            bool            `protobuf:"varint,6,opt,name=is_multi_hop,json=isMultiHop" json:"is_multi_hop,omitempty"`
	Authentication        *Authentication `protobuf:"bytes,7,opt,name=authentication" json:"authentication,omitempty"`
}

func (*Peer) Descriptor

func (*Peer) Descriptor() ([]byte, []int)

func (*Peer) GetAddress

func (m *Peer) GetAddress() string

func (*Peer) GetAuthentication

func (m *Peer) GetAuthentication() *Authentication

func (*Peer) GetDesiredMinTxInterval

func (m *Peer) GetDesiredMinTxInterval() uint32

func (*Peer) GetDetectMultiplier

func (m *Peer) GetDetectMultiplier() uint32

func (*Peer) GetIsMultiHop

func (m *Peer) GetIsMultiHop() bool

func (*Peer) GetName

func (m *Peer) GetName() string

func (*Peer) GetRequiredMinRxInterval

func (m *Peer) GetRequiredMinRxInterval() uint32

func (*Peer) ProtoMessage

func (*Peer) ProtoMessage()

func (*Peer) Reset

func (m *Peer) Reset()

func (*Peer) String

func (m *Peer) String() string

type PeerState

type PeerState struct {
	State      SessionState   `protobuf:"varint,1,opt,name=state,enum=api.SessionState" json:"state,omitempty"`
	Diagnostic DiagnosticCode `protobuf:"varint,2,opt,name=diagnostic,enum=api.DiagnosticCode" json:"diagnostic,omitempty"`
}

func (*PeerState) Descriptor

func (*PeerState) Descriptor() ([]byte, []int)

func (*PeerState) GetDiagnostic

func (m *PeerState) GetDiagnostic() DiagnosticCode

func (*PeerState) GetState

func (m *PeerState) GetState() SessionState

func (*PeerState) ProtoMessage

func (*PeerState) ProtoMessage()

func (*PeerState) Reset

func (m *PeerState) Reset()

func (*PeerState) String

func (m *PeerState) String() string

type PeerStateResponse

type PeerStateResponse struct {
	Local  *PeerState `protobuf:"bytes,1,opt,name=local" json:"local,omitempty"`
	Remote *PeerState `protobuf:"bytes,2,opt,name=remote" json:"remote,omitempty"`
}

func (*PeerStateResponse) Descriptor

func (*PeerStateResponse) Descriptor() ([]byte, []int)

func (*PeerStateResponse) GetLocal

func (m *PeerStateResponse) GetLocal() *PeerState

func (*PeerStateResponse) GetRemote

func (m *PeerStateResponse) GetRemote() *PeerState

func (*PeerStateResponse) ProtoMessage

func (*PeerStateResponse) ProtoMessage()

func (*PeerStateResponse) Reset

func (m *PeerStateResponse) Reset()

func (*PeerStateResponse) String

func (m *PeerStateResponse) String() string

type SessionState

type SessionState int32
const (
	SessionState_ADMIN_DOWN SessionState = 0
	SessionState_DOWN       SessionState = 1
	SessionState_INIT       SessionState = 2
	SessionState_UP         SessionState = 3
)

func (SessionState) EnumDescriptor

func (SessionState) EnumDescriptor() ([]byte, []int)

func (SessionState) String

func (x SessionState) String() string

type StartRequest

type StartRequest struct {
	Address string `protobuf:"bytes,1,opt,name=address" json:"address,omitempty"`
	Port    uint32 `protobuf:"varint,2,opt,name=port" json:"port,omitempty"`
}

func (*StartRequest) Descriptor

func (*StartRequest) Descriptor() ([]byte, []int)

func (*StartRequest) GetAddress

func (m *StartRequest) GetAddress() string

func (*StartRequest) GetPort

func (m *StartRequest) GetPort() uint32

func (*StartRequest) ProtoMessage

func (*StartRequest) ProtoMessage()

func (*StartRequest) Reset

func (m *StartRequest) Reset()

func (*StartRequest) String

func (m *StartRequest) String() string

type StopRequest

type StopRequest struct {
}

func (*StopRequest) Descriptor

func (*StopRequest) Descriptor() ([]byte, []int)

func (*StopRequest) ProtoMessage

func (*StopRequest) ProtoMessage()

func (*StopRequest) Reset

func (m *StopRequest) Reset()

func (*StopRequest) String

func (m *StopRequest) String() string

type UpdatePeerRequest

type UpdatePeerRequest struct {
	Uuid []byte `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	Peer *Peer  `protobuf:"bytes,2,opt,name=peer" json:"peer,omitempty"`
}

func (*UpdatePeerRequest) Descriptor

func (*UpdatePeerRequest) Descriptor() ([]byte, []int)

func (*UpdatePeerRequest) GetPeer

func (m *UpdatePeerRequest) GetPeer() *Peer

func (*UpdatePeerRequest) GetUuid

func (m *UpdatePeerRequest) GetUuid() []byte

func (*UpdatePeerRequest) ProtoMessage

func (*UpdatePeerRequest) ProtoMessage()

func (*UpdatePeerRequest) Reset

func (m *UpdatePeerRequest) Reset()

func (*UpdatePeerRequest) String

func (m *UpdatePeerRequest) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL