v1

Documentation

Index

• Variables
• func RegisterStreamServer(s grpc.ServiceRegistrar, srv StreamServer)
• type EventType
  • func (EventType) Descriptor() protoreflect.EnumDescriptor
  • func (x EventType) Enum() *EventType
  • func (EventType) EnumDescriptor() ([]byte, []int)
  • func (x EventType) Number() protoreflect.EnumNumber
  • func (x EventType) String() string
  • func (EventType) Type() protoreflect.EnumType
• type StreamClient
  • func NewStreamClient(cc grpc.ClientConnInterface) StreamClient
• type StreamEvent
  • func (*StreamEvent) Descriptor() ([]byte, []int)
  • func (x *StreamEvent) GetType() EventType
  • func (*StreamEvent) ProtoMessage()
  • func (x *StreamEvent) ProtoReflect() protoreflect.Message
  • func (x *StreamEvent) Reset()
  • func (x *StreamEvent) String() string
• type StreamServer
• type Stream_ConnectClient
• type Stream_ConnectServer
• type UnimplementedStreamServer
  • func (UnimplementedStreamServer) Connect(Stream_ConnectServer) error
  • func (UnimplementedStreamServer) Notify(context.Context, *StreamEvent) (*emptypb.Empty, error)
• type UnsafeStreamServer

Variables

var (
	EventType_name = map[int32]string{
		0: "Unknown",
		1: "DiscoveryComplete",
	}
	EventType_value = map[string]int32{
		"Unknown":           0,
		"DiscoveryComplete": 1,
	}
)

Enum value maps for EventType.

var File_github_com_rancher_opni_pkg_apis_stream_v1_stream_proto protoreflect.FileDescriptor

var Stream_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "stream.Stream",
	HandlerType: (*StreamServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Notify",
			Handler:    _Stream_Notify_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Connect",
			Handler:       _Stream_Connect_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "github.com/rancher/opni/pkg/apis/stream/v1/stream.proto",
}

Stream_ServiceDesc is the grpc.ServiceDesc for Stream service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterStreamServer

func RegisterStreamServer(s grpc.ServiceRegistrar, srv StreamServer)

Types

type EventType

type EventType int32

const (
	EventType_Unknown           EventType = 0
	EventType_DiscoveryComplete EventType = 1
)

func (EventType) Descriptor

func (EventType) Descriptor() protoreflect.EnumDescriptor

func (EventType) Enum

func (x EventType) Enum() *EventType

func (EventType) EnumDescriptor

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

Deprecated: Use EventType.Descriptor instead.

func (EventType) Number

func (x EventType) Number() protoreflect.EnumNumber

func (EventType) String

func (x EventType) String() string

func (EventType) Type

func (EventType) Type() protoreflect.EnumType

type StreamClient

type StreamClient interface {
	Connect(ctx context.Context, opts ...grpc.CallOption) (Stream_ConnectClient, error)
	// Used for implementation-specific events. No guarantees are made about
	// whether events will be sent or when.
	Notify(ctx context.Context, in *StreamEvent, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

StreamClient is the client API for Stream service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewStreamClient

func NewStreamClient(cc grpc.ClientConnInterface) StreamClient

type StreamEvent

type StreamEvent struct {
	Type EventType `protobuf:"varint,1,opt,name=type,proto3,enum=stream.EventType" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*StreamEvent) Descriptor

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

Deprecated: Use StreamEvent.ProtoReflect.Descriptor instead.

func (*StreamEvent) GetType

func (x *StreamEvent) GetType() EventType

func (*StreamEvent) ProtoMessage

func (*StreamEvent) ProtoMessage()

func (*StreamEvent) ProtoReflect

func (x *StreamEvent) ProtoReflect() protoreflect.Message

func (*StreamEvent) Reset

func (x *StreamEvent) Reset()

func (*StreamEvent) String

func (x *StreamEvent) String() string

type StreamServer

type StreamServer interface {
	Connect(Stream_ConnectServer) error
	// Used for implementation-specific events. No guarantees are made about
	// whether events will be sent or when.
	Notify(context.Context, *StreamEvent) (*emptypb.Empty, error)
	// contains filtered or unexported methods
}

StreamServer is the server API for Stream service. All implementations must embed UnimplementedStreamServer for forward compatibility

type Stream_ConnectClient

type Stream_ConnectClient interface {
	Send(*totem.RPC) error
	Recv() (*totem.RPC, error)
	grpc.ClientStream
}

type Stream_ConnectServer

type Stream_ConnectServer interface {
	Send(*totem.RPC) error
	Recv() (*totem.RPC, error)
	grpc.ServerStream
}

type UnimplementedStreamServer

type UnimplementedStreamServer struct {
}

UnimplementedStreamServer must be embedded to have forward compatible implementations.

func (UnimplementedStreamServer) Connect

func (UnimplementedStreamServer) Connect(Stream_ConnectServer) error

func (UnimplementedStreamServer) Notify

func (UnimplementedStreamServer) Notify(context.Context, *StreamEvent) (*emptypb.Empty, error)

type UnsafeStreamServer

type UnsafeStreamServer interface {
	// contains filtered or unexported methods
}

UnsafeStreamServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to StreamServer will result in compilation errors.