diags

package
v0.6.1 Latest Latest
Warning

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

 Go to latest Published: May 1, 2020 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ChangeServiceClientFactory = func(cc *grpc.ClientConn) ChangeServiceClient {
	return NewChangeServiceClient(cc)
}

ChangeServiceClientFactory : Default ChangeServiceClient creation.

View Source 
var OpStateDiagsClientFactory = func(cc *grpc.ClientConn) OpStateDiagsClient {
	return NewOpStateDiagsClient(cc)
}

OpStateDiagsClientFactory : Default OpStateDiagsClient creation.

View Source 
var Type_name = map[int32]string{
	0: "NONE",
	1: "ADDED",
	2: "UPDATED",
	3: "REMOVED",
}
View Source 
var Type_value = map[string]int32{
	"NONE":    0,
	"ADDED":   1,
	"UPDATED": 2,
	"REMOVED": 3,
}

Functions

func RegisterChangeServiceServer 

func RegisterChangeServiceServer(s *grpc.Server, srv ChangeServiceServer)

func RegisterOpStateDiagsServer 

func RegisterOpStateDiagsServer(s *grpc.Server, srv OpStateDiagsServer)

Types

type ChangeServiceClient 

type ChangeServiceClient interface {
	// List gets a stream of network change add/update/remove events for network
	// changes matching changeid
	ListNetworkChanges(ctx context.Context, in *ListNetworkChangeRequest, opts ...grpc.CallOption) (ChangeService_ListNetworkChangesClient, error)
	// List gets a stream of device change add/update/remove events for device
	// changes matching changeid
	ListDeviceChanges(ctx context.Context, in *ListDeviceChangeRequest, opts ...grpc.CallOption) (ChangeService_ListDeviceChangesClient, error)
}

ChangeServiceClient is the client API for ChangeService service.

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

func CreateChangeServiceClient 

func CreateChangeServiceClient(cc *grpc.ClientConn) ChangeServiceClient

CreateChangeServiceClient creates and returns a new change service client

func NewChangeServiceClient 

func NewChangeServiceClient(cc *grpc.ClientConn) ChangeServiceClient

type ChangeServiceServer 

type ChangeServiceServer interface {
	// List gets a stream of network change add/update/remove events for network
	// changes matching changeid
	ListNetworkChanges(*ListNetworkChangeRequest, ChangeService_ListNetworkChangesServer) error
	// List gets a stream of device change add/update/remove events for device
	// changes matching changeid
	ListDeviceChanges(*ListDeviceChangeRequest, ChangeService_ListDeviceChangesServer) error
}

ChangeServiceServer is the server API for ChangeService service.

type ChangeService_ListDeviceChangesClient 

type ChangeService_ListDeviceChangesClient interface {
	Recv() (*ListDeviceChangeResponse, error)
	grpc.ClientStream
}

type ChangeService_ListDeviceChangesServer 

type ChangeService_ListDeviceChangesServer interface {
	Send(*ListDeviceChangeResponse) error
	grpc.ServerStream
}

type ChangeService_ListNetworkChangesClient 

type ChangeService_ListNetworkChangesClient interface {
	Recv() (*ListNetworkChangeResponse, error)
	grpc.ClientStream
}

type ChangeService_ListNetworkChangesServer 

type ChangeService_ListNetworkChangesServer interface {
	Send(*ListNetworkChangeResponse) error
	grpc.ServerStream
}

type ListDeviceChangeRequest 

type ListDeviceChangeRequest 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"`
	// option to specify a specific device change - if blank or '*' then select all
	// Can support `*` (match many chars) or '?' (match one char) as wildcard
	DeviceID github_com_onosproject_onos_config_api_types_device.ID `` /* 149-byte string literal not displayed */
	// device_version is an optional device version
	DeviceVersion github_com_onosproject_onos_config_api_types_device.Version `` /* 169-byte string literal not displayed */
	// option to request only changes that happen after the call
	WithoutReplay        bool     `protobuf:"varint,4,opt,name=withoutReplay,proto3" json:"withoutReplay,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

ListDeviceChangeRequest requests a stream of changes and updates to them By default, the request requests a stream of all changes 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 changes have been sent and events that occur following the last changes will be streamed to the client until the stream is closed. If "withoutReplay" is true then only changes that happen after the call will be returned

func (*ListDeviceChangeRequest) Descriptor 

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

func (*ListDeviceChangeRequest) GetDeviceID 

func (m *ListDeviceChangeRequest) GetDeviceID() github_com_onosproject_onos_config_api_types_device.ID

func (*ListDeviceChangeRequest) GetDeviceVersion 

func (m *ListDeviceChangeRequest) GetDeviceVersion() github_com_onosproject_onos_config_api_types_device.Version

func (*ListDeviceChangeRequest) GetSubscribe 

func (m *ListDeviceChangeRequest) GetSubscribe() bool

func (*ListDeviceChangeRequest) GetWithoutReplay 

func (m *ListDeviceChangeRequest) GetWithoutReplay() bool

func (*ListDeviceChangeRequest) ProtoMessage 

func (*ListDeviceChangeRequest) ProtoMessage()

func (*ListDeviceChangeRequest) Reset 

func (m *ListDeviceChangeRequest) Reset()

func (*ListDeviceChangeRequest) String 

func (m *ListDeviceChangeRequest) String() string

func (*ListDeviceChangeRequest) XXX_DiscardUnknown 

func (m *ListDeviceChangeRequest) XXX_DiscardUnknown()

func (*ListDeviceChangeRequest) XXX_Marshal 

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

func (*ListDeviceChangeRequest) XXX_Merge 

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

func (*ListDeviceChangeRequest) XXX_Size 

func (m *ListDeviceChangeRequest) XXX_Size() int

func (*ListDeviceChangeRequest) XXX_Unmarshal 

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

type ListDeviceChangeResponse 

type ListDeviceChangeResponse struct {
	// change is the device change on which the event occurred
	Change *device.DeviceChange `protobuf:"bytes,1,opt,name=change,proto3" json:"change,omitempty"`
	// type is a qualification of the type of change being made
	Type                 Type     `protobuf:"varint,2,opt,name=type,proto3,enum=onos.config.diags.Type" json:"type,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

ListDeviceChangeResponse carries a single network change event

func (*ListDeviceChangeResponse) Descriptor 

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

func (*ListDeviceChangeResponse) GetChange 

func (m *ListDeviceChangeResponse) GetChange() *device.DeviceChange

func (*ListDeviceChangeResponse) GetType 

func (m *ListDeviceChangeResponse) GetType() Type

func (*ListDeviceChangeResponse) ProtoMessage 

func (*ListDeviceChangeResponse) ProtoMessage()

func (*ListDeviceChangeResponse) Reset 

func (m *ListDeviceChangeResponse) Reset()

func (*ListDeviceChangeResponse) String 

func (m *ListDeviceChangeResponse) String() string

func (*ListDeviceChangeResponse) XXX_DiscardUnknown 

func (m *ListDeviceChangeResponse) XXX_DiscardUnknown()

func (*ListDeviceChangeResponse) XXX_Marshal 

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

func (*ListDeviceChangeResponse) XXX_Merge 

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

func (*ListDeviceChangeResponse) XXX_Size 

func (m *ListDeviceChangeResponse) XXX_Size() int

func (*ListDeviceChangeResponse) XXX_Unmarshal 

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

type ListNetworkChangeRequest 

type ListNetworkChangeRequest 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"`
	// option to specify a specific network change - if blank or '*' then select all
	// Can support `*` (match many chars) or '?' (match one char) as wildcard
	ChangeID github_com_onosproject_onos_config_api_types_change_network.ID `` /* 141-byte string literal not displayed */
	// option to request only changes that happen after the call
	WithoutReplay        bool     `protobuf:"varint,3,opt,name=withoutReplay,proto3" json:"withoutReplay,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

ListNetworkChangeRequest requests a stream of changes and updates to them By default, the request requests a stream of all changes 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 changes have been sent and events that occur following the last changes will be streamed to the client until the stream is closed. If "withoutReplay" is true then only changes that happen after the call will be returned

func (*ListNetworkChangeRequest) Descriptor 

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

func (*ListNetworkChangeRequest) GetChangeID 

func (m *ListNetworkChangeRequest) GetChangeID() github_com_onosproject_onos_config_api_types_change_network.ID

func (*ListNetworkChangeRequest) GetSubscribe 

func (m *ListNetworkChangeRequest) GetSubscribe() bool

func (*ListNetworkChangeRequest) GetWithoutReplay 

func (m *ListNetworkChangeRequest) GetWithoutReplay() bool

func (*ListNetworkChangeRequest) ProtoMessage 

func (*ListNetworkChangeRequest) ProtoMessage()

func (*ListNetworkChangeRequest) Reset 

func (m *ListNetworkChangeRequest) Reset()

func (*ListNetworkChangeRequest) String 

func (m *ListNetworkChangeRequest) String() string

func (*ListNetworkChangeRequest) XXX_DiscardUnknown 

func (m *ListNetworkChangeRequest) XXX_DiscardUnknown()

func (*ListNetworkChangeRequest) XXX_Marshal 

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

func (*ListNetworkChangeRequest) XXX_Merge 

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

func (*ListNetworkChangeRequest) XXX_Size 

func (m *ListNetworkChangeRequest) XXX_Size() int

func (*ListNetworkChangeRequest) XXX_Unmarshal 

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

type ListNetworkChangeResponse 

type ListNetworkChangeResponse struct {
	// change is the network change on which the event occurred
	Change *network.NetworkChange `protobuf:"bytes,1,opt,name=change,proto3" json:"change,omitempty"`
	// type is a qualification of the type of change being made
	Type                 Type     `protobuf:"varint,2,opt,name=type,proto3,enum=onos.config.diags.Type" json:"type,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

ListNetworkChangeResponse carries a single network change event

func (*ListNetworkChangeResponse) Descriptor 

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

func (*ListNetworkChangeResponse) GetChange 

func (m *ListNetworkChangeResponse) GetChange() *network.NetworkChange

func (*ListNetworkChangeResponse) GetType 

func (m *ListNetworkChangeResponse) GetType() Type

func (*ListNetworkChangeResponse) ProtoMessage 

func (*ListNetworkChangeResponse) ProtoMessage()

func (*ListNetworkChangeResponse) Reset 

func (m *ListNetworkChangeResponse) Reset()

func (*ListNetworkChangeResponse) String 

func (m *ListNetworkChangeResponse) String() string

func (*ListNetworkChangeResponse) XXX_DiscardUnknown 

func (m *ListNetworkChangeResponse) XXX_DiscardUnknown()

func (*ListNetworkChangeResponse) XXX_Marshal 

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

func (*ListNetworkChangeResponse) XXX_Merge 

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

func (*ListNetworkChangeResponse) XXX_Size 

func (m *ListNetworkChangeResponse) XXX_Size() int

func (*ListNetworkChangeResponse) XXX_Unmarshal 

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

type OpStateDiagsClient 

type OpStateDiagsClient interface {
	// GetOpState returns a stream of submitted OperationalStateCache aimed at individual devices.
	// If subscribe is true keep on streaming after the initial set are finished
	GetOpState(ctx context.Context, in *OpStateRequest, opts ...grpc.CallOption) (OpStateDiags_GetOpStateClient, error)
}

OpStateDiagsClient is the client API for OpStateDiags service.

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

func CreateOpStateDiagsClient 

func CreateOpStateDiagsClient(cc *grpc.ClientConn) OpStateDiagsClient

CreateOpStateDiagsClient creates and returns a new op state diags client

func NewOpStateDiagsClient 

func NewOpStateDiagsClient(cc *grpc.ClientConn) OpStateDiagsClient

type OpStateDiagsServer 

type OpStateDiagsServer interface {
	// GetOpState returns a stream of submitted OperationalStateCache aimed at individual devices.
	// If subscribe is true keep on streaming after the initial set are finished
	GetOpState(*OpStateRequest, OpStateDiags_GetOpStateServer) error
}

OpStateDiagsServer is the server API for OpStateDiags service.

type OpStateDiags_GetOpStateClient 

type OpStateDiags_GetOpStateClient interface {
	Recv() (*OpStateResponse, error)
	grpc.ClientStream
}

type OpStateDiags_GetOpStateServer 

type OpStateDiags_GetOpStateServer interface {
	Send(*OpStateResponse) error
	grpc.ServerStream
}

type OpStateRequest 

type OpStateRequest struct {
	// The request is always in the context of a Device ID. If the device does
	// not exist or is disconnected an error will be returned.
	DeviceId string `protobuf:"bytes,1,opt,name=deviceId,proto3" json:"deviceId,omitempty"`
	// subscribe indicates whether to subscribe to events (e.g. ADD, UPDATE, and REMOVE) that occur
	// after all paths for the device have been streamed to the client
	Subscribe            bool     `protobuf:"varint,2,opt,name=subscribe,proto3" json:"subscribe,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

OpStateRequest is a message for specifying GetOpState query parameters.

func (*OpStateRequest) Descriptor 

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

func (*OpStateRequest) GetDeviceId 

func (m *OpStateRequest) GetDeviceId() string

func (*OpStateRequest) GetSubscribe 

func (m *OpStateRequest) GetSubscribe() bool

func (*OpStateRequest) ProtoMessage 

func (*OpStateRequest) ProtoMessage()

func (*OpStateRequest) Reset 

func (m *OpStateRequest) Reset()

func (*OpStateRequest) String 

func (m *OpStateRequest) String() string

func (*OpStateRequest) XXX_DiscardUnknown 

func (m *OpStateRequest) XXX_DiscardUnknown()

func (*OpStateRequest) XXX_Marshal 

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

func (*OpStateRequest) XXX_Merge 

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

func (*OpStateRequest) XXX_Size 

func (m *OpStateRequest) XXX_Size() int

func (*OpStateRequest) XXX_Unmarshal 

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

type OpStateResponse 

type OpStateResponse struct {
	// type is the type of the event
	Type admin.Type `protobuf:"varint,1,opt,name=type,proto3,enum=onos.config.admin.Type" json:"type,omitempty"`
	// device is the device on which the event occurred
	Pathvalue            *device.PathValue `protobuf:"bytes,2,opt,name=pathvalue,proto3" json:"pathvalue,omitempty"`
	XXX_NoUnkeyedLiteral struct{}          `json:"-"`
	XXX_unrecognized     []byte            `json:"-"`
	XXX_sizecache        int32             `json:"-"`
}

func (*OpStateResponse) Descriptor 

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

func (*OpStateResponse) GetPathvalue 

func (m *OpStateResponse) GetPathvalue() *device.PathValue

func (*OpStateResponse) GetType 

func (m *OpStateResponse) GetType() admin.Type

func (*OpStateResponse) ProtoMessage 

func (*OpStateResponse) ProtoMessage()

func (*OpStateResponse) Reset 

func (m *OpStateResponse) Reset()

func (*OpStateResponse) String 

func (m *OpStateResponse) String() string

func (*OpStateResponse) XXX_DiscardUnknown 

func (m *OpStateResponse) XXX_DiscardUnknown()

func (*OpStateResponse) XXX_Marshal 

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

func (*OpStateResponse) XXX_Merge 

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

func (*OpStateResponse) XXX_Size 

func (m *OpStateResponse) XXX_Size() int

func (*OpStateResponse) XXX_Unmarshal 

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

type Type 

type Type int32

Change (Network or Device) event type 

const (
	// NONE indicates this response does not represent a modification of the Change
	Type_NONE Type = 0
	// ADDED is an event which occurs when a Change is added to the topology
	Type_ADDED Type = 1
	// UPDATED is an event which occurs when a Change is updated
	Type_UPDATED Type = 2
	// REMOVED is an event which occurs when a Change is removed from the configuration
	Type_REMOVED Type = 3
)

func (Type) EnumDescriptor 

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

func (Type) String 

func (x Type) String() string

type UnimplementedChangeServiceServer 

type UnimplementedChangeServiceServer struct {
}

UnimplementedChangeServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedChangeServiceServer) ListDeviceChanges 

func (*UnimplementedChangeServiceServer) ListDeviceChanges(req *ListDeviceChangeRequest, srv ChangeService_ListDeviceChangesServer) error

func (*UnimplementedChangeServiceServer) ListNetworkChanges 

func (*UnimplementedChangeServiceServer) ListNetworkChanges(req *ListNetworkChangeRequest, srv ChangeService_ListNetworkChangesServer) error

type UnimplementedOpStateDiagsServer 

type UnimplementedOpStateDiagsServer struct {
}

UnimplementedOpStateDiagsServer can be embedded to have forward compatible implementations.

func (*UnimplementedOpStateDiagsServer) GetOpState 

func (*UnimplementedOpStateDiagsServer) GetOpState(req *OpStateRequest, srv OpStateDiags_GetOpStateServer) 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.