device

package
v0.7.2 Latest Latest
Warning

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

 Go to latest Published: Feb 2, 2021 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrInvalidLengthDevice        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowDevice          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupDevice = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var ChannelState_name = map[int32]string{
	0: "UNKNOWN_CHANNEL_STATE",
	1: "CONNECTED",
	2: "DISCONNECTED",
}
View Source 
var ChannelState_value = map[string]int32{
	"UNKNOWN_CHANNEL_STATE": 0,
	"CONNECTED":             1,
	"DISCONNECTED":          2,
}
View Source 
var ConnectivityState_name = map[int32]string{
	0: "UNKNOWN_CONNECTIVITY_STATE",
	1: "REACHABLE",
	2: "UNREACHABLE",
}
View Source 
var ConnectivityState_value = map[string]int32{
	"UNKNOWN_CONNECTIVITY_STATE": 0,
	"REACHABLE":                  1,
	"UNREACHABLE":                2,
}
View Source 
var DeviceServiceClientFactory = func(cc *grpc.ClientConn) DeviceServiceClient {
	return NewDeviceServiceClient(cc)
}

DeviceServiceClientFactory : Default DeviceServiceClient creation.

View Source 
var ListResponse_Type_name = map[int32]string{
	0: "NONE",
	1: "ADDED",
	2: "UPDATED",
	3: "REMOVED",
}
View Source 
var ListResponse_Type_value = map[string]int32{
	"NONE":    0,
	"ADDED":   1,
	"UPDATED": 2,
	"REMOVED": 3,
}
View Source 
var Protocol_name = map[int32]string{
	0: "UNKNOWN_PROTOCOL",
	1: "GNMI",
	2: "P4RUNTIME",
	3: "GNOI",
	4: "E2AP",
}
View Source 
var Protocol_value = map[string]int32{
	"UNKNOWN_PROTOCOL": 0,
	"GNMI":             1,
	"P4RUNTIME":        2,
	"GNOI":             3,
	"E2AP":             4,
}
View Source 
var ServiceState_name = map[int32]string{
	0: "UNKNOWN_SERVICE_STATE",
	1: "AVAILABLE",
	2: "UNAVAILABLE",
	3: "CONNECTING",
}
View Source 
var ServiceState_value = map[string]int32{
	"UNKNOWN_SERVICE_STATE": 0,
	"AVAILABLE":             1,
	"UNAVAILABLE":           2,
	"CONNECTING":            3,
}

Functions

func RegisterDeviceServiceServer 

func RegisterDeviceServiceServer(s *grpc.Server, srv DeviceServiceServer)

Types

type AddRequest 

type AddRequest struct {
	// device is the device to add
	Device *Device `protobuf:"bytes,1,opt,name=device,proto3" json:"device,omitempty"`
}

AddRequest adds a device to the topology

func (*AddRequest) Descriptor 

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

func (*AddRequest) GetDevice 

func (m *AddRequest) GetDevice() *Device

func (*AddRequest) Marshal 

func (m *AddRequest) Marshal() (dAtA []byte, err error)

func (*AddRequest) MarshalTo 

func (m *AddRequest) MarshalTo(dAtA []byte) (int, error)

func (*AddRequest) MarshalToSizedBuffer 

func (m *AddRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*AddRequest) ProtoMessage 

func (*AddRequest) ProtoMessage()

func (*AddRequest) Reset 

func (m *AddRequest) Reset()

func (*AddRequest) Size 

func (m *AddRequest) Size() (n int)

func (*AddRequest) String 

func (m *AddRequest) String() string

func (*AddRequest) Unmarshal 

func (m *AddRequest) Unmarshal(dAtA []byte) error

func (*AddRequest) XXX_DiscardUnknown 

func (m *AddRequest) XXX_DiscardUnknown()

func (*AddRequest) XXX_Marshal 

func (m *AddRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*AddRequest) XXX_Merge 

func (m *AddRequest) XXX_Merge(src proto.Message)

func (*AddRequest) XXX_Size 

func (m *AddRequest) XXX_Size() int

func (*AddRequest) XXX_Unmarshal 

func (m *AddRequest) XXX_Unmarshal(b []byte) error

type AddResponse 

type AddResponse struct {
	// device is the device with a revision number
	Device *Device `protobuf:"bytes,1,opt,name=device,proto3" json:"device,omitempty"`
}

AddResponse is sent in response to an AddDeviceRequest

func (*AddResponse) Descriptor 

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

func (*AddResponse) GetDevice 

func (m *AddResponse) GetDevice() *Device

func (*AddResponse) Marshal 

func (m *AddResponse) Marshal() (dAtA []byte, err error)

func (*AddResponse) MarshalTo 

func (m *AddResponse) MarshalTo(dAtA []byte) (int, error)

func (*AddResponse) MarshalToSizedBuffer 

func (m *AddResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*AddResponse) ProtoMessage 

func (*AddResponse) ProtoMessage()

func (*AddResponse) Reset 

func (m *AddResponse) Reset()

func (*AddResponse) Size 

func (m *AddResponse) Size() (n int)

func (*AddResponse) String 

func (m *AddResponse) String() string

func (*AddResponse) Unmarshal 

func (m *AddResponse) Unmarshal(dAtA []byte) error

func (*AddResponse) XXX_DiscardUnknown 

func (m *AddResponse) XXX_DiscardUnknown()

func (*AddResponse) XXX_Marshal 

func (m *AddResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*AddResponse) XXX_Merge 

func (m *AddResponse) XXX_Merge(src proto.Message)

func (*AddResponse) XXX_Size 

func (m *AddResponse) XXX_Size() int

func (*AddResponse) XXX_Unmarshal 

func (m *AddResponse) XXX_Unmarshal(b []byte) error

type ChannelState 

type ChannelState int32

ConnectivityState represents the state of a gRPC channel to the device from the service container 

const (
	//UNKNOWN_CHANNEL_STATE constant needed to go around proto3 nullifying the 0 values
	ChannelState_UNKNOWN_CHANNEL_STATE ChannelState = 0
	// CONNECTED indicates the corresponding grpc channel is connected on this device
	ChannelState_CONNECTED ChannelState = 1
	// DISCONNECTED indicates the corresponding grpc channel is not connected on this device
	ChannelState_DISCONNECTED ChannelState = 2
)

func (ChannelState) EnumDescriptor 

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

func (ChannelState) String 

func (x ChannelState) String() string

type ConnectivityState 

type ConnectivityState int32

ConnectivityState represents the L3 reachability of a device from the service container (e.g. enos-config), independently of gRPC or the service itself (e.g. gNMI) 

const (
	//UNKNOWN_CONNECTIVITY_STATE constant needed to go around proto3 nullifying the 0 values
	ConnectivityState_UNKNOWN_CONNECTIVITY_STATE ConnectivityState = 0
	// REACHABLE indicates the the service can reach the device at L3
	ConnectivityState_REACHABLE ConnectivityState = 1
	// UNREACHABLE indicates the the service can't reach the device at L3
	ConnectivityState_UNREACHABLE ConnectivityState = 2
)

func (ConnectivityState) EnumDescriptor 

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

func (ConnectivityState) String 

func (x ConnectivityState) String() string

type Credentials 

type Credentials struct {
	// user is the user with which to connect to the device
	User string `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"`
	// password is the password for connecting to the device
	Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
}

Credentials is the device credentials

func (*Credentials) Descriptor 

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

func (*Credentials) GetPassword 

func (m *Credentials) GetPassword() string

func (*Credentials) GetUser 

func (m *Credentials) GetUser() string

func (*Credentials) Marshal 

func (m *Credentials) Marshal() (dAtA []byte, err error)

func (*Credentials) MarshalTo 

func (m *Credentials) MarshalTo(dAtA []byte) (int, error)

func (*Credentials) MarshalToSizedBuffer 

func (m *Credentials) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Credentials) ProtoMessage 

func (*Credentials) ProtoMessage()

func (*Credentials) Reset 

func (m *Credentials) Reset()

func (*Credentials) Size 

func (m *Credentials) Size() (n int)

func (*Credentials) String 

func (m *Credentials) String() string

func (*Credentials) Unmarshal 

func (m *Credentials) Unmarshal(dAtA []byte) error

func (*Credentials) XXX_DiscardUnknown 

func (m *Credentials) XXX_DiscardUnknown()

func (*Credentials) XXX_Marshal 

func (m *Credentials) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Credentials) XXX_Merge 

func (m *Credentials) XXX_Merge(src proto.Message)

func (*Credentials) XXX_Size 

func (m *Credentials) XXX_Size() int

func (*Credentials) XXX_Unmarshal 

func (m *Credentials) XXX_Unmarshal(b []byte) error

type Device 

type Device struct {
	// id is a globally unique device identifier
	ID ID `protobuf:"bytes,1,opt,name=id,proto3,casttype=ID" json:"id,omitempty"`
	// revision is the revision of the device
	Revision Revision `protobuf:"varint,2,opt,name=revision,proto3,casttype=Revision" json:"revision,omitempty"`
	// address is the host:port of the device
	Address string `protobuf:"bytes,3,opt,name=address,proto3" json:"address,omitempty"`
	// target is the device target
	Target string `protobuf:"bytes,4,opt,name=target,proto3" json:"target,omitempty"`
	// version is the device software version
	Version string `protobuf:"bytes,5,opt,name=version,proto3" json:"version,omitempty"`
	// timeout indicates the device request timeout
	Timeout *time.Duration `protobuf:"bytes,6,opt,name=timeout,proto3,stdduration" json:"timeout,omitempty"`
	// credentials contains the credentials for connecting to the device
	Credentials Credentials `protobuf:"bytes,7,opt,name=credentials,proto3" json:"credentials"`
	// tls is the device TLS configuration
	TLS TlsConfig `protobuf:"bytes,8,opt,name=tls,proto3" json:"tls"`
	// type is the type of the device
	Type Type `protobuf:"bytes,9,opt,name=type,proto3,casttype=Type" json:"type,omitempty"`
	// role is a role for the device
	Role Role `protobuf:"bytes,10,opt,name=role,proto3,casttype=Role" json:"role,omitempty"`
	// attributes is an arbitrary mapping of attribute keys/values
	Attributes map[string]string `` /* 162-byte string literal not displayed */
	Protocols  []*ProtocolState  `protobuf:"bytes,12,rep,name=protocols,proto3" json:"protocols,omitempty"`
	// displayname is a user friendly tag
	Displayname string `protobuf:"bytes,13,opt,name=displayname,proto3" json:"displayname,omitempty"`
}

Device contains information about a device

func (*Device) Descriptor 

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

func (*Device) GetAddress 

func (m *Device) GetAddress() string

func (*Device) GetAttributes 

func (m *Device) GetAttributes() map[string]string

func (*Device) GetCredentials 

func (m *Device) GetCredentials() Credentials

func (*Device) GetDisplayname added in v0.6.3 

func (m *Device) GetDisplayname() string

func (*Device) GetID 

func (m *Device) GetID() ID

func (*Device) GetProtocols 

func (m *Device) GetProtocols() []*ProtocolState

func (*Device) GetRevision 

func (m *Device) GetRevision() Revision

func (*Device) GetRole 

func (m *Device) GetRole() Role

func (*Device) GetTLS 

func (m *Device) GetTLS() TlsConfig

func (*Device) GetTarget 

func (m *Device) GetTarget() string

func (*Device) GetTimeout 

func (m *Device) GetTimeout() *time.Duration

func (*Device) GetType 

func (m *Device) GetType() Type

func (*Device) GetVersion 

func (m *Device) GetVersion() string

func (*Device) Marshal 

func (m *Device) Marshal() (dAtA []byte, err error)

func (*Device) MarshalTo 

func (m *Device) MarshalTo(dAtA []byte) (int, error)

func (*Device) MarshalToSizedBuffer 

func (m *Device) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Device) ProtoMessage 

func (*Device) ProtoMessage()

func (*Device) Reset 

func (m *Device) Reset()

func (*Device) Size 

func (m *Device) Size() (n int)

func (*Device) String 

func (m *Device) String() string

func (*Device) Unmarshal 

func (m *Device) Unmarshal(dAtA []byte) error

func (*Device) XXX_DiscardUnknown 

func (m *Device) XXX_DiscardUnknown()

func (*Device) XXX_Marshal 

func (m *Device) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Device) XXX_Merge 

func (m *Device) XXX_Merge(src proto.Message)

func (*Device) XXX_Size 

func (m *Device) XXX_Size() int

func (*Device) XXX_Unmarshal 

func (m *Device) XXX_Unmarshal(b []byte) error

type DeviceServiceClient 

type DeviceServiceClient interface {
	// Add adds a device to the topology
	Add(ctx context.Context, in *AddRequest, opts ...grpc.CallOption) (*AddResponse, error)
	// Update updates a device
	Update(ctx context.Context, in *UpdateRequest, opts ...grpc.CallOption) (*UpdateResponse, error)
	// Get gets a device by ID
	Get(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*GetResponse, error)
	// List gets a stream of device add/update/remove events
	List(ctx context.Context, in *ListRequest, opts ...grpc.CallOption) (DeviceService_ListClient, error)
	// Remove removes a device from the topology
	Remove(ctx context.Context, in *RemoveRequest, opts ...grpc.CallOption) (*RemoveResponse, error)
}

DeviceServiceClient is the client API for DeviceService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func CreateDeviceServiceClient 

func CreateDeviceServiceClient(cc *grpc.ClientConn) DeviceServiceClient

CreateDeviceServiceClient creates and returns a new topo device client

func NewDeviceServiceClient 

func NewDeviceServiceClient(cc *grpc.ClientConn) DeviceServiceClient

type DeviceServiceServer 

type DeviceServiceServer interface {
	// Add adds a device to the topology
	Add(context.Context, *AddRequest) (*AddResponse, error)
	// Update updates a device
	Update(context.Context, *UpdateRequest) (*UpdateResponse, error)
	// Get gets a device by ID
	Get(context.Context, *GetRequest) (*GetResponse, error)
	// List gets a stream of device add/update/remove events
	List(*ListRequest, DeviceService_ListServer) error
	// Remove removes a device from the topology
	Remove(context.Context, *RemoveRequest) (*RemoveResponse, error)
}

DeviceServiceServer is the server API for DeviceService service.

type DeviceService_ListClient 

type DeviceService_ListClient interface {
	Recv() (*ListResponse, error)
	grpc.ClientStream
}

type DeviceService_ListServer 

type DeviceService_ListServer interface {
	Send(*ListResponse) error
	grpc.ServerStream
}

type GetRequest 

type GetRequest struct {
	// id is the unique device ID with which to lookup the device
	ID ID `protobuf:"bytes,1,opt,name=id,proto3,casttype=ID" json:"id,omitempty"`
}

GetRequest gets a device by ID

func (*GetRequest) Descriptor 

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

func (*GetRequest) GetID 

func (m *GetRequest) GetID() ID

func (*GetRequest) Marshal 

func (m *GetRequest) Marshal() (dAtA []byte, err error)

func (*GetRequest) MarshalTo 

func (m *GetRequest) MarshalTo(dAtA []byte) (int, error)

func (*GetRequest) MarshalToSizedBuffer 

func (m *GetRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*GetRequest) ProtoMessage 

func (*GetRequest) ProtoMessage()

func (*GetRequest) Reset 

func (m *GetRequest) Reset()

func (*GetRequest) Size 

func (m *GetRequest) Size() (n int)

func (*GetRequest) String 

func (m *GetRequest) String() string

func (*GetRequest) Unmarshal 

func (m *GetRequest) Unmarshal(dAtA []byte) error

func (*GetRequest) XXX_DiscardUnknown 

func (m *GetRequest) XXX_DiscardUnknown()

func (*GetRequest) XXX_Marshal 

func (m *GetRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetRequest) XXX_Merge 

func (m *GetRequest) XXX_Merge(src proto.Message)

func (*GetRequest) XXX_Size 

func (m *GetRequest) XXX_Size() int

func (*GetRequest) XXX_Unmarshal 

func (m *GetRequest) XXX_Unmarshal(b []byte) error

type GetResponse 

type GetResponse struct {
	// device is the device object
	Device *Device `protobuf:"bytes,1,opt,name=device,proto3" json:"device,omitempty"`
}

GetResponse carries a device

func (*GetResponse) Descriptor 

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

func (*GetResponse) GetDevice 

func (m *GetResponse) GetDevice() *Device

func (*GetResponse) Marshal 

func (m *GetResponse) Marshal() (dAtA []byte, err error)

func (*GetResponse) MarshalTo 

func (m *GetResponse) MarshalTo(dAtA []byte) (int, error)

func (*GetResponse) MarshalToSizedBuffer 

func (m *GetResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*GetResponse) ProtoMessage 

func (*GetResponse) ProtoMessage()

func (*GetResponse) Reset 

func (m *GetResponse) Reset()

func (*GetResponse) Size 

func (m *GetResponse) Size() (n int)

func (*GetResponse) String 

func (m *GetResponse) String() string

func (*GetResponse) Unmarshal 

func (m *GetResponse) Unmarshal(dAtA []byte) error

func (*GetResponse) XXX_DiscardUnknown 

func (m *GetResponse) XXX_DiscardUnknown()

func (*GetResponse) XXX_Marshal 

func (m *GetResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetResponse) XXX_Merge 

func (m *GetResponse) XXX_Merge(src proto.Message)

func (*GetResponse) XXX_Size 

func (m *GetResponse) XXX_Size() int

func (*GetResponse) XXX_Unmarshal 

func (m *GetResponse) XXX_Unmarshal(b []byte) error

type ID 

type ID string

ID is a device ID

type ListRequest 

type ListRequest struct {
	// subscribe indicates whether to subscribe to events (e.g. ADD, UPDATE, and REMOVE) that occur
	// after all devices have been streamed to the client
	Subscribe bool `protobuf:"varint,1,opt,name=subscribe,proto3" json:"subscribe,omitempty"`
}

ListRequest requests a stream of devices and changes By default, the request requests a stream of all devices that are present in the topology when the request is received by the service. However, if `subscribe` is `true`, the stream will remain open after all devices have been sent and events that occur following the last device will be streamed to the client until the stream is closed.

func (*ListRequest) Descriptor 

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

func (*ListRequest) GetSubscribe 

func (m *ListRequest) GetSubscribe() bool

func (*ListRequest) Marshal 

func (m *ListRequest) Marshal() (dAtA []byte, err error)

func (*ListRequest) MarshalTo 

func (m *ListRequest) MarshalTo(dAtA []byte) (int, error)

func (*ListRequest) MarshalToSizedBuffer 

func (m *ListRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ListRequest) ProtoMessage 

func (*ListRequest) ProtoMessage()

func (*ListRequest) Reset 

func (m *ListRequest) Reset()

func (*ListRequest) Size 

func (m *ListRequest) Size() (n int)

func (*ListRequest) String 

func (m *ListRequest) String() string

func (*ListRequest) Unmarshal 

func (m *ListRequest) Unmarshal(dAtA []byte) error

func (*ListRequest) XXX_DiscardUnknown 

func (m *ListRequest) XXX_DiscardUnknown()

func (*ListRequest) XXX_Marshal 

func (m *ListRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListRequest) XXX_Merge 

func (m *ListRequest) XXX_Merge(src proto.Message)

func (*ListRequest) XXX_Size 

func (m *ListRequest) XXX_Size() int

func (*ListRequest) XXX_Unmarshal 

func (m *ListRequest) XXX_Unmarshal(b []byte) error

type ListResponse 

type ListResponse struct {
	// type is the type of the event
	Type ListResponse_Type `protobuf:"varint,1,opt,name=type,proto3,enum=topo.device.ListResponse_Type" json:"type,omitempty"`
	// device is the device on which the event occurred
	Device *Device `protobuf:"bytes,2,opt,name=device,proto3" json:"device,omitempty"`
}

ListResponse carries a single device event

func (*ListResponse) Descriptor 

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

func (*ListResponse) GetDevice 

func (m *ListResponse) GetDevice() *Device

func (*ListResponse) GetType 

func (m *ListResponse) GetType() ListResponse_Type

func (*ListResponse) Marshal 

func (m *ListResponse) Marshal() (dAtA []byte, err error)

func (*ListResponse) MarshalTo 

func (m *ListResponse) MarshalTo(dAtA []byte) (int, error)

func (*ListResponse) MarshalToSizedBuffer 

func (m *ListResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ListResponse) ProtoMessage 

func (*ListResponse) ProtoMessage()

func (*ListResponse) Reset 

func (m *ListResponse) Reset()

func (*ListResponse) Size 

func (m *ListResponse) Size() (n int)

func (*ListResponse) String 

func (m *ListResponse) String() string

func (*ListResponse) Unmarshal 

func (m *ListResponse) Unmarshal(dAtA []byte) error

func (*ListResponse) XXX_DiscardUnknown 

func (m *ListResponse) XXX_DiscardUnknown()

func (*ListResponse) XXX_Marshal 

func (m *ListResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListResponse) XXX_Merge 

func (m *ListResponse) XXX_Merge(src proto.Message)

func (*ListResponse) XXX_Size 

func (m *ListResponse) XXX_Size() int

func (*ListResponse) XXX_Unmarshal 

func (m *ListResponse) XXX_Unmarshal(b []byte) error

type ListResponse_Type 

type ListResponse_Type int32

Device event type 

const (
	// NONE indicates this response does not represent a state change
	ListResponse_NONE ListResponse_Type = 0
	// ADDED is an event which occurs when a device is added to the topology
	ListResponse_ADDED ListResponse_Type = 1
	// UPDATED is an event which occurs when a device is updated
	ListResponse_UPDATED ListResponse_Type = 2
	// REMOVED is an event which occurs when a device is removed from the topology
	ListResponse_REMOVED ListResponse_Type = 3
)

func (ListResponse_Type) EnumDescriptor 

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

func (ListResponse_Type) String 

func (x ListResponse_Type) String() string

type Protocol 

type Protocol int32

Protocol to interact with a device 

const (
	//UNKNOWN_PROTOCOL constant needed to go around proto3 nullifying the 0 values
	Protocol_UNKNOWN_PROTOCOL Protocol = 0
	// GNMI protocol reference
	Protocol_GNMI Protocol = 1
	// P4RUNTIME protocol reference
	Protocol_P4RUNTIME Protocol = 2
	// GNOI protocol reference
	Protocol_GNOI Protocol = 3
	// E2 Control Plane Protocol
	Protocol_E2AP Protocol = 4
)

func (Protocol) EnumDescriptor 

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

func (Protocol) String 

func (x Protocol) String() string

type ProtocolState 

type ProtocolState struct {
	//The protocol to which state relates
	Protocol Protocol `protobuf:"varint,1,opt,name=protocol,proto3,enum=topo.device.Protocol" json:"protocol,omitempty"`
	//ConnectivityState contains the L3 connectivity information
	ConnectivityState ConnectivityState `protobuf:"varint,2,opt,name=connectivityState,proto3,enum=topo.device.ConnectivityState" json:"connectivityState,omitempty"`
	//ChannelState relates to the availability of the gRPC channel
	ChannelState ChannelState `protobuf:"varint,3,opt,name=channelState,proto3,enum=topo.device.ChannelState" json:"channelState,omitempty"`
	//ServiceState indicates the availability of the gRPC servic on top of the channel
	ServiceState ServiceState `protobuf:"varint,4,opt,name=serviceState,proto3,enum=topo.device.ServiceState" json:"serviceState,omitempty"`
}

ProtocolState contains information related to service and connectivity to a device

func (*ProtocolState) Descriptor 

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

func (*ProtocolState) GetChannelState 

func (m *ProtocolState) GetChannelState() ChannelState

func (*ProtocolState) GetConnectivityState 

func (m *ProtocolState) GetConnectivityState() ConnectivityState

func (*ProtocolState) GetProtocol 

func (m *ProtocolState) GetProtocol() Protocol

func (*ProtocolState) GetServiceState 

func (m *ProtocolState) GetServiceState() ServiceState

func (*ProtocolState) Marshal 

func (m *ProtocolState) Marshal() (dAtA []byte, err error)

func (*ProtocolState) MarshalTo 

func (m *ProtocolState) MarshalTo(dAtA []byte) (int, error)

func (*ProtocolState) MarshalToSizedBuffer 

func (m *ProtocolState) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ProtocolState) ProtoMessage 

func (*ProtocolState) ProtoMessage()

func (*ProtocolState) Reset 

func (m *ProtocolState) Reset()

func (*ProtocolState) Size 

func (m *ProtocolState) Size() (n int)

func (*ProtocolState) String 

func (m *ProtocolState) String() string

func (*ProtocolState) Unmarshal 

func (m *ProtocolState) Unmarshal(dAtA []byte) error

func (*ProtocolState) XXX_DiscardUnknown 

func (m *ProtocolState) XXX_DiscardUnknown()

func (*ProtocolState) XXX_Marshal 

func (m *ProtocolState) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ProtocolState) XXX_Merge 

func (m *ProtocolState) XXX_Merge(src proto.Message)

func (*ProtocolState) XXX_Size 

func (m *ProtocolState) XXX_Size() int

func (*ProtocolState) XXX_Unmarshal 

func (m *ProtocolState) XXX_Unmarshal(b []byte) error

type RemoveRequest 

type RemoveRequest struct {
	// device is the device to remove
	Device *Device `protobuf:"bytes,1,opt,name=device,proto3" json:"device,omitempty"`
}

RemoveRequest removes a device by ID

func (*RemoveRequest) Descriptor 

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

func (*RemoveRequest) GetDevice 

func (m *RemoveRequest) GetDevice() *Device

func (*RemoveRequest) Marshal 

func (m *RemoveRequest) Marshal() (dAtA []byte, err error)

func (*RemoveRequest) MarshalTo 

func (m *RemoveRequest) MarshalTo(dAtA []byte) (int, error)

func (*RemoveRequest) MarshalToSizedBuffer 

func (m *RemoveRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*RemoveRequest) ProtoMessage 

func (*RemoveRequest) ProtoMessage()

func (*RemoveRequest) Reset 

func (m *RemoveRequest) Reset()

func (*RemoveRequest) Size 

func (m *RemoveRequest) Size() (n int)

func (*RemoveRequest) String 

func (m *RemoveRequest) String() string

func (*RemoveRequest) Unmarshal 

func (m *RemoveRequest) Unmarshal(dAtA []byte) error

func (*RemoveRequest) XXX_DiscardUnknown 

func (m *RemoveRequest) XXX_DiscardUnknown()

func (*RemoveRequest) XXX_Marshal 

func (m *RemoveRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RemoveRequest) XXX_Merge 

func (m *RemoveRequest) XXX_Merge(src proto.Message)

func (*RemoveRequest) XXX_Size 

func (m *RemoveRequest) XXX_Size() int

func (*RemoveRequest) XXX_Unmarshal 

func (m *RemoveRequest) XXX_Unmarshal(b []byte) error

type RemoveResponse 

type RemoveResponse struct {
}

RemoveResponse is sent in response to a RemoveDeviceRequest

func (*RemoveResponse) Descriptor 

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

func (*RemoveResponse) Marshal 

func (m *RemoveResponse) Marshal() (dAtA []byte, err error)

func (*RemoveResponse) MarshalTo 

func (m *RemoveResponse) MarshalTo(dAtA []byte) (int, error)

func (*RemoveResponse) MarshalToSizedBuffer 

func (m *RemoveResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*RemoveResponse) ProtoMessage 

func (*RemoveResponse) ProtoMessage()

func (*RemoveResponse) Reset 

func (m *RemoveResponse) Reset()

func (*RemoveResponse) Size 

func (m *RemoveResponse) Size() (n int)

func (*RemoveResponse) String 

func (m *RemoveResponse) String() string

func (*RemoveResponse) Unmarshal 

func (m *RemoveResponse) Unmarshal(dAtA []byte) error

func (*RemoveResponse) XXX_DiscardUnknown 

func (m *RemoveResponse) XXX_DiscardUnknown()

func (*RemoveResponse) XXX_Marshal 

func (m *RemoveResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RemoveResponse) XXX_Merge 

func (m *RemoveResponse) XXX_Merge(src proto.Message)

func (*RemoveResponse) XXX_Size 

func (m *RemoveResponse) XXX_Size() int

func (*RemoveResponse) XXX_Unmarshal 

func (m *RemoveResponse) XXX_Unmarshal(b []byte) error

type Revision 

type Revision uint64

Revision is the device revision number

type Role 

type Role string

Role is a device role

type ServiceState 

type ServiceState int32

ServiceState represents the state of the gRPC service (e.g. gNMI) to the device from the service container 

const (
	//UNKNOWN_SERVICE_STATE constant needed to go around proto3 nullifying the 0 values
	ServiceState_UNKNOWN_SERVICE_STATE ServiceState = 0
	// AVAILABLE indicates the corresponding grpc service is available
	ServiceState_AVAILABLE ServiceState = 1
	// UNAVAILABLE indicates the corresponding grpc service is not available
	ServiceState_UNAVAILABLE ServiceState = 2
	// CONNECTING indicates the corresponding protocol is in the connecting phase on this device
	ServiceState_CONNECTING ServiceState = 3
)

func (ServiceState) EnumDescriptor 

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

func (ServiceState) String 

func (x ServiceState) String() string

type TlsConfig 

type TlsConfig struct {
	// caCert is the name of the device's CA certificate
	CaCert string `protobuf:"bytes,3,opt,name=caCert,proto3" json:"caCert,omitempty"`
	// cert is the name of the device's certificate
	Cert string `protobuf:"bytes,4,opt,name=cert,proto3" json:"cert,omitempty"`
	// key is the name of the device's TLS key
	Key string `protobuf:"bytes,5,opt,name=key,proto3" json:"key,omitempty"`
	// plain indicates whether to connect to the device over plaintext
	Plain bool `protobuf:"varint,6,opt,name=plain,proto3" json:"plain,omitempty"`
	// insecure indicates whether to connect to the device with insecure communication
	Insecure bool `protobuf:"varint,7,opt,name=insecure,proto3" json:"insecure,omitempty"`
}

Device TLS configuration

func (*TlsConfig) Descriptor 

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

func (*TlsConfig) GetCaCert 

func (m *TlsConfig) GetCaCert() string

func (*TlsConfig) GetCert 

func (m *TlsConfig) GetCert() string

func (*TlsConfig) GetInsecure 

func (m *TlsConfig) GetInsecure() bool

func (*TlsConfig) GetKey 

func (m *TlsConfig) GetKey() string

func (*TlsConfig) GetPlain 

func (m *TlsConfig) GetPlain() bool

func (*TlsConfig) Marshal 

func (m *TlsConfig) Marshal() (dAtA []byte, err error)

func (*TlsConfig) MarshalTo 

func (m *TlsConfig) MarshalTo(dAtA []byte) (int, error)

func (*TlsConfig) MarshalToSizedBuffer 

func (m *TlsConfig) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*TlsConfig) ProtoMessage 

func (*TlsConfig) ProtoMessage()

func (*TlsConfig) Reset 

func (m *TlsConfig) Reset()

func (*TlsConfig) Size 

func (m *TlsConfig) Size() (n int)

func (*TlsConfig) String 

func (m *TlsConfig) String() string

func (*TlsConfig) Unmarshal 

func (m *TlsConfig) Unmarshal(dAtA []byte) error

func (*TlsConfig) XXX_DiscardUnknown 

func (m *TlsConfig) XXX_DiscardUnknown()

func (*TlsConfig) XXX_Marshal 

func (m *TlsConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TlsConfig) XXX_Merge 

func (m *TlsConfig) XXX_Merge(src proto.Message)

func (*TlsConfig) XXX_Size 

func (m *TlsConfig) XXX_Size() int

func (*TlsConfig) XXX_Unmarshal 

func (m *TlsConfig) XXX_Unmarshal(b []byte) error

type Type 

type Type string

Type is a device type

type UnimplementedDeviceServiceServer 

type UnimplementedDeviceServiceServer struct {
}

UnimplementedDeviceServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedDeviceServiceServer) Add 

func (*UnimplementedDeviceServiceServer) Add(ctx context.Context, req *AddRequest) (*AddResponse, error)

func (*UnimplementedDeviceServiceServer) Get 

func (*UnimplementedDeviceServiceServer) Get(ctx context.Context, req *GetRequest) (*GetResponse, error)

func (*UnimplementedDeviceServiceServer) List 

func (*UnimplementedDeviceServiceServer) List(req *ListRequest, srv DeviceService_ListServer) error

func (*UnimplementedDeviceServiceServer) Remove 

func (*UnimplementedDeviceServiceServer) Remove(ctx context.Context, req *RemoveRequest) (*RemoveResponse, error)

func (*UnimplementedDeviceServiceServer) Update 

func (*UnimplementedDeviceServiceServer) Update(ctx context.Context, req *UpdateRequest) (*UpdateResponse, error)

type UpdateRequest 

type UpdateRequest struct {
	// device is the updated device
	Device *Device `protobuf:"bytes,1,opt,name=device,proto3" json:"device,omitempty"`
}

UpdateRequest updates a device

func (*UpdateRequest) Descriptor 

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

func (*UpdateRequest) GetDevice 

func (m *UpdateRequest) GetDevice() *Device

func (*UpdateRequest) Marshal 

func (m *UpdateRequest) Marshal() (dAtA []byte, err error)

func (*UpdateRequest) MarshalTo 

func (m *UpdateRequest) MarshalTo(dAtA []byte) (int, error)

func (*UpdateRequest) MarshalToSizedBuffer 

func (m *UpdateRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*UpdateRequest) ProtoMessage 

func (*UpdateRequest) ProtoMessage()

func (*UpdateRequest) Reset 

func (m *UpdateRequest) Reset()

func (*UpdateRequest) Size 

func (m *UpdateRequest) Size() (n int)

func (*UpdateRequest) String 

func (m *UpdateRequest) String() string

func (*UpdateRequest) Unmarshal 

func (m *UpdateRequest) Unmarshal(dAtA []byte) error

func (*UpdateRequest) XXX_DiscardUnknown 

func (m *UpdateRequest) XXX_DiscardUnknown()

func (*UpdateRequest) XXX_Marshal 

func (m *UpdateRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UpdateRequest) XXX_Merge 

func (m *UpdateRequest) XXX_Merge(src proto.Message)

func (*UpdateRequest) XXX_Size 

func (m *UpdateRequest) XXX_Size() int

func (*UpdateRequest) XXX_Unmarshal 

func (m *UpdateRequest) XXX_Unmarshal(b []byte) error

type UpdateResponse 

type UpdateResponse struct {
	// device is the device with updated revision
	Device *Device `protobuf:"bytes,1,opt,name=device,proto3" json:"device,omitempty"`
}

UpdateResponse is sent in response to an UpdateDeviceRequest

func (*UpdateResponse) Descriptor 

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

func (*UpdateResponse) GetDevice 

func (m *UpdateResponse) GetDevice() *Device

func (*UpdateResponse) Marshal 

func (m *UpdateResponse) Marshal() (dAtA []byte, err error)

func (*UpdateResponse) MarshalTo 

func (m *UpdateResponse) MarshalTo(dAtA []byte) (int, error)

func (*UpdateResponse) MarshalToSizedBuffer 

func (m *UpdateResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*UpdateResponse) ProtoMessage 

func (*UpdateResponse) ProtoMessage()

func (*UpdateResponse) Reset 

func (m *UpdateResponse) Reset()

func (*UpdateResponse) Size 

func (m *UpdateResponse) Size() (n int)

func (*UpdateResponse) String 

func (m *UpdateResponse) String() string

func (*UpdateResponse) Unmarshal 

func (m *UpdateResponse) Unmarshal(dAtA []byte) error

func (*UpdateResponse) XXX_DiscardUnknown 

func (m *UpdateResponse) XXX_DiscardUnknown()

func (*UpdateResponse) XXX_Marshal 

func (m *UpdateResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UpdateResponse) XXX_Merge 

func (m *UpdateResponse) XXX_Merge(src proto.Message)

func (*UpdateResponse) XXX_Size 

func (m *UpdateResponse) XXX_Size() int

func (*UpdateResponse) XXX_Unmarshal 

func (m *UpdateResponse) XXX_Unmarshal(b []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.