api

package
v0.16.0 Latest Latest
Warning

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

Go to latest
Published: Oct 13, 2023 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_terminal_proto protoreflect.FileDescriptor
View Source
var GuestService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "GuestService",
	HandlerType: (*GuestServiceServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "TerminalChannel",
			Handler:       _GuestService_TerminalChannel_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "terminal.proto",
}

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

View Source
var HostService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "HostService",
	HandlerType: (*HostServiceServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "ControlChannel",
			Handler:       _HostService_ControlChannel_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
		{
			StreamName:    "DataChannel",
			Handler:       _HostService_DataChannel_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "terminal.proto",
}

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

Functions

func RegisterGuestServiceServer

func RegisterGuestServiceServer(s grpc.ServiceRegistrar, srv GuestServiceServer)

func RegisterHostServiceServer

func RegisterHostServiceServer(s grpc.ServiceRegistrar, srv HostServiceServer)

Types

type Data

type Data struct {
	Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*Data) Descriptor deprecated

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

Deprecated: Use Data.ProtoReflect.Descriptor instead.

func (*Data) GetData

func (x *Data) GetData() []byte

func (*Data) ProtoMessage

func (*Data) ProtoMessage()

func (*Data) ProtoReflect

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

func (*Data) Reset

func (x *Data) Reset()

func (*Data) String

func (x *Data) String() string

type Error

type Error struct {
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

func (*Error) Descriptor deprecated

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

Deprecated: Use Error.ProtoReflect.Descriptor instead.

func (*Error) GetMessage

func (x *Error) GetMessage() string

func (*Error) ProtoMessage

func (*Error) ProtoMessage()

func (*Error) ProtoReflect

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

func (*Error) Reset

func (x *Error) Reset()

func (*Error) String

func (x *Error) String() string

type GuestServiceClient

type GuestServiceClient interface {
	TerminalChannel(ctx context.Context, opts ...grpc.CallOption) (GuestService_TerminalChannelClient, error)
}

GuestServiceClient is the client API for GuestService 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.

type GuestServiceServer

type GuestServiceServer interface {
	TerminalChannel(GuestService_TerminalChannelServer) error
	// contains filtered or unexported methods
}

GuestServiceServer is the server API for GuestService service. All implementations must embed UnimplementedGuestServiceServer for forward compatibility

type GuestService_TerminalChannelClient

type GuestService_TerminalChannelClient interface {
	Send(*GuestTerminalRequest) error
	Recv() (*GuestTerminalResponse, error)
	grpc.ClientStream
}

type GuestService_TerminalChannelServer

type GuestService_TerminalChannelServer interface {
	Send(*GuestTerminalResponse) error
	Recv() (*GuestTerminalRequest, error)
	grpc.ServerStream
}

type GuestTerminalRequest

type GuestTerminalRequest struct {

	// Types that are assignable to Operation:
	//	*GuestTerminalRequest_Hello_
	//	*GuestTerminalRequest_ChangeDimensions
	//	*GuestTerminalRequest_Input
	Operation isGuestTerminalRequest_Operation `protobuf_oneof:"operation"`
	// contains filtered or unexported fields
}

func (*GuestTerminalRequest) Descriptor deprecated

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

Deprecated: Use GuestTerminalRequest.ProtoReflect.Descriptor instead.

func (*GuestTerminalRequest) GetChangeDimensions

func (x *GuestTerminalRequest) GetChangeDimensions() *TerminalDimensions

func (*GuestTerminalRequest) GetHello

func (*GuestTerminalRequest) GetInput

func (x *GuestTerminalRequest) GetInput() *Data

func (*GuestTerminalRequest) GetOperation

func (m *GuestTerminalRequest) GetOperation() isGuestTerminalRequest_Operation

func (*GuestTerminalRequest) ProtoMessage

func (*GuestTerminalRequest) ProtoMessage()

func (*GuestTerminalRequest) ProtoReflect

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

func (*GuestTerminalRequest) Reset

func (x *GuestTerminalRequest) Reset()

func (*GuestTerminalRequest) String

func (x *GuestTerminalRequest) String() string

type GuestTerminalRequest_ChangeDimensions

type GuestTerminalRequest_ChangeDimensions struct {
	// Used to synchronize terminal dimensions on the Host after e.g. web UI terminal size changes
	ChangeDimensions *TerminalDimensions `protobuf:"bytes,2,opt,name=change_dimensions,json=changeDimensions,proto3,oneof"`
}

type GuestTerminalRequest_Hello

type GuestTerminalRequest_Hello struct {

	// Unique Host identifier assigned by the HostService
	Locator string `protobuf:"bytes,1,opt,name=locator,proto3" json:"locator,omitempty"`
	//
	// Symmetric key used to authenticate against a Host specified by the locator above,
	// should match the Host's trusted_secret
	Secret string `protobuf:"bytes,2,opt,name=secret,proto3" json:"secret,omitempty"`
	// Dimensions of the terminal to be created on the Host
	RequestedDimensions *TerminalDimensions `protobuf:"bytes,3,opt,name=requested_dimensions,json=requestedDimensions,proto3" json:"requested_dimensions,omitempty"`
	// contains filtered or unexported fields
}

func (*GuestTerminalRequest_Hello) Descriptor deprecated

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

Deprecated: Use GuestTerminalRequest_Hello.ProtoReflect.Descriptor instead.

func (*GuestTerminalRequest_Hello) GetLocator

func (x *GuestTerminalRequest_Hello) GetLocator() string

func (*GuestTerminalRequest_Hello) GetRequestedDimensions

func (x *GuestTerminalRequest_Hello) GetRequestedDimensions() *TerminalDimensions

func (*GuestTerminalRequest_Hello) GetSecret

func (x *GuestTerminalRequest_Hello) GetSecret() string

func (*GuestTerminalRequest_Hello) ProtoMessage

func (*GuestTerminalRequest_Hello) ProtoMessage()

func (*GuestTerminalRequest_Hello) ProtoReflect

func (*GuestTerminalRequest_Hello) Reset

func (x *GuestTerminalRequest_Hello) Reset()

func (*GuestTerminalRequest_Hello) String

func (x *GuestTerminalRequest_Hello) String() string

type GuestTerminalRequest_Hello_

type GuestTerminalRequest_Hello_ struct {
	// Mandatory first message from a Guest after it opens this channel
	Hello *GuestTerminalRequest_Hello `protobuf:"bytes,1,opt,name=hello,proto3,oneof"`
}

type GuestTerminalRequest_Input

type GuestTerminalRequest_Input struct {
	// Terminal input to the Host
	Input *Data `protobuf:"bytes,3,opt,name=input,proto3,oneof"`
}

type GuestTerminalResponse

type GuestTerminalResponse struct {

	// Types that are assignable to Operation:
	//	*GuestTerminalResponse_Output
	Operation isGuestTerminalResponse_Operation `protobuf_oneof:"operation"`
	// contains filtered or unexported fields
}

func (*GuestTerminalResponse) Descriptor deprecated

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

Deprecated: Use GuestTerminalResponse.ProtoReflect.Descriptor instead.

func (*GuestTerminalResponse) GetOperation

func (m *GuestTerminalResponse) GetOperation() isGuestTerminalResponse_Operation

func (*GuestTerminalResponse) GetOutput

func (x *GuestTerminalResponse) GetOutput() *Data

func (*GuestTerminalResponse) ProtoMessage

func (*GuestTerminalResponse) ProtoMessage()

func (*GuestTerminalResponse) ProtoReflect

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

func (*GuestTerminalResponse) Reset

func (x *GuestTerminalResponse) Reset()

func (*GuestTerminalResponse) String

func (x *GuestTerminalResponse) String() string

type GuestTerminalResponse_Output

type GuestTerminalResponse_Output struct {
	// Terminal output from the Host
	Output *Data `protobuf:"bytes,1,opt,name=output,proto3,oneof"`
}

type HostControlRequest

type HostControlRequest struct {

	// Types that are assignable to Operation:
	//	*HostControlRequest_Hello_
	Operation isHostControlRequest_Operation `protobuf_oneof:"operation"`
	// contains filtered or unexported fields
}

func (*HostControlRequest) Descriptor deprecated

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

Deprecated: Use HostControlRequest.ProtoReflect.Descriptor instead.

func (*HostControlRequest) GetHello

func (*HostControlRequest) GetOperation

func (m *HostControlRequest) GetOperation() isHostControlRequest_Operation

func (*HostControlRequest) ProtoMessage

func (*HostControlRequest) ProtoMessage()

func (*HostControlRequest) ProtoReflect

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

func (*HostControlRequest) Reset

func (x *HostControlRequest) Reset()

func (*HostControlRequest) String

func (x *HostControlRequest) String() string

type HostControlRequest_Hello

type HostControlRequest_Hello struct {

	// Symmetric key, the knowledge of which by the Guest can be used to spawn a new terminal on to this Host
	TrustedSecret string `protobuf:"bytes,1,opt,name=trusted_secret,json=trustedSecret,proto3" json:"trusted_secret,omitempty"`
	// contains filtered or unexported fields
}

func (*HostControlRequest_Hello) Descriptor deprecated

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

Deprecated: Use HostControlRequest_Hello.ProtoReflect.Descriptor instead.

func (*HostControlRequest_Hello) GetTrustedSecret

func (x *HostControlRequest_Hello) GetTrustedSecret() string

func (*HostControlRequest_Hello) ProtoMessage

func (*HostControlRequest_Hello) ProtoMessage()

func (*HostControlRequest_Hello) ProtoReflect

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

func (*HostControlRequest_Hello) Reset

func (x *HostControlRequest_Hello) Reset()

func (*HostControlRequest_Hello) String

func (x *HostControlRequest_Hello) String() string

type HostControlRequest_Hello_

type HostControlRequest_Hello_ struct {
	// Mandatory first message from the Host after it opens this channel
	Hello *HostControlRequest_Hello `protobuf:"bytes,1,opt,name=hello,proto3,oneof"`
}

type HostControlResponse

type HostControlResponse struct {

	// Types that are assignable to Operation:
	//	*HostControlResponse_Hello_
	//	*HostControlResponse_DataChannelRequest_
	Operation isHostControlResponse_Operation `protobuf_oneof:"operation"`
	// contains filtered or unexported fields
}

func (*HostControlResponse) Descriptor deprecated

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

Deprecated: Use HostControlResponse.ProtoReflect.Descriptor instead.

func (*HostControlResponse) GetDataChannelRequest

func (x *HostControlResponse) GetDataChannelRequest() *HostControlResponse_DataChannelRequest

func (*HostControlResponse) GetHello

func (*HostControlResponse) GetOperation

func (m *HostControlResponse) GetOperation() isHostControlResponse_Operation

func (*HostControlResponse) ProtoMessage

func (*HostControlResponse) ProtoMessage()

func (*HostControlResponse) ProtoReflect

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

func (*HostControlResponse) Reset

func (x *HostControlResponse) Reset()

func (*HostControlResponse) String

func (x *HostControlResponse) String() string

type HostControlResponse_DataChannelRequest

type HostControlResponse_DataChannelRequest struct {

	// Token that can be used to create a new data channel
	Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"`
	// Dimensions of the new terminal that will be created and attached to the data channel
	RequestedDimensions *TerminalDimensions `protobuf:"bytes,3,opt,name=requested_dimensions,json=requestedDimensions,proto3" json:"requested_dimensions,omitempty"`
	// contains filtered or unexported fields
}

func (*HostControlResponse_DataChannelRequest) Descriptor deprecated

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

Deprecated: Use HostControlResponse_DataChannelRequest.ProtoReflect.Descriptor instead.

func (*HostControlResponse_DataChannelRequest) GetRequestedDimensions

func (x *HostControlResponse_DataChannelRequest) GetRequestedDimensions() *TerminalDimensions

func (*HostControlResponse_DataChannelRequest) GetToken

func (*HostControlResponse_DataChannelRequest) ProtoMessage

func (*HostControlResponse_DataChannelRequest) ProtoReflect

func (*HostControlResponse_DataChannelRequest) Reset

func (*HostControlResponse_DataChannelRequest) String

type HostControlResponse_DataChannelRequest_

type HostControlResponse_DataChannelRequest_ struct {
	// Emitted when a Guest opens a new terminal channel
	DataChannelRequest *HostControlResponse_DataChannelRequest `protobuf:"bytes,2,opt,name=data_channel_request,json=dataChannelRequest,proto3,oneof"`
}

type HostControlResponse_Hello

type HostControlResponse_Hello struct {

	// A unique identifier that the HostService assigns to this Host
	Locator string `protobuf:"bytes,1,opt,name=locator,proto3" json:"locator,omitempty"`
	// contains filtered or unexported fields
}

func (*HostControlResponse_Hello) Descriptor deprecated

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

Deprecated: Use HostControlResponse_Hello.ProtoReflect.Descriptor instead.

func (*HostControlResponse_Hello) GetLocator

func (x *HostControlResponse_Hello) GetLocator() string

func (*HostControlResponse_Hello) ProtoMessage

func (*HostControlResponse_Hello) ProtoMessage()

func (*HostControlResponse_Hello) ProtoReflect

func (*HostControlResponse_Hello) Reset

func (x *HostControlResponse_Hello) Reset()

func (*HostControlResponse_Hello) String

func (x *HostControlResponse_Hello) String() string

type HostControlResponse_Hello_

type HostControlResponse_Hello_ struct {
	// Mandatory reply to the Hello message sent from the Host
	Hello *HostControlResponse_Hello `protobuf:"bytes,1,opt,name=hello,proto3,oneof"`
}

type HostDataRequest

type HostDataRequest struct {

	// Types that are assignable to Operation:
	//	*HostDataRequest_Hello_
	//	*HostDataRequest_Output
	Operation isHostDataRequest_Operation `protobuf_oneof:"operation"`
	// contains filtered or unexported fields
}

func (*HostDataRequest) Descriptor deprecated

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

Deprecated: Use HostDataRequest.ProtoReflect.Descriptor instead.

func (*HostDataRequest) GetHello

func (x *HostDataRequest) GetHello() *HostDataRequest_Hello

func (*HostDataRequest) GetOperation

func (m *HostDataRequest) GetOperation() isHostDataRequest_Operation

func (*HostDataRequest) GetOutput

func (x *HostDataRequest) GetOutput() *Data

func (*HostDataRequest) ProtoMessage

func (*HostDataRequest) ProtoMessage()

func (*HostDataRequest) ProtoReflect

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

func (*HostDataRequest) Reset

func (x *HostDataRequest) Reset()

func (*HostDataRequest) String

func (x *HostDataRequest) String() string

type HostDataRequest_Hello

type HostDataRequest_Hello struct {

	// Host's locator
	Locator string `protobuf:"bytes,1,opt,name=locator,proto3" json:"locator,omitempty"`
	// Token provided to the Host in DataChannelRequest
	Token string `protobuf:"bytes,2,opt,name=token,proto3" json:"token,omitempty"`
	// contains filtered or unexported fields
}

func (*HostDataRequest_Hello) Descriptor deprecated

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

Deprecated: Use HostDataRequest_Hello.ProtoReflect.Descriptor instead.

func (*HostDataRequest_Hello) GetLocator

func (x *HostDataRequest_Hello) GetLocator() string

func (*HostDataRequest_Hello) GetToken

func (x *HostDataRequest_Hello) GetToken() string

func (*HostDataRequest_Hello) ProtoMessage

func (*HostDataRequest_Hello) ProtoMessage()

func (*HostDataRequest_Hello) ProtoReflect

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

func (*HostDataRequest_Hello) Reset

func (x *HostDataRequest_Hello) Reset()

func (*HostDataRequest_Hello) String

func (x *HostDataRequest_Hello) String() string

type HostDataRequest_Hello_

type HostDataRequest_Hello_ struct {
	// Mandatory first message to be sent by the Host
	Hello *HostDataRequest_Hello `protobuf:"bytes,1,opt,name=hello,proto3,oneof"`
}

type HostDataRequest_Output

type HostDataRequest_Output struct {
	// Terminal output to the Guest
	Output *Data `protobuf:"bytes,2,opt,name=output,proto3,oneof"`
}

type HostDataResponse

type HostDataResponse struct {

	// Types that are assignable to Operation:
	//	*HostDataResponse_ChangeDimensions
	//	*HostDataResponse_Input
	Operation isHostDataResponse_Operation `protobuf_oneof:"operation"`
	// contains filtered or unexported fields
}

func (*HostDataResponse) Descriptor deprecated

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

Deprecated: Use HostDataResponse.ProtoReflect.Descriptor instead.

func (*HostDataResponse) GetChangeDimensions

func (x *HostDataResponse) GetChangeDimensions() *TerminalDimensions

func (*HostDataResponse) GetInput

func (x *HostDataResponse) GetInput() *Data

func (*HostDataResponse) GetOperation

func (m *HostDataResponse) GetOperation() isHostDataResponse_Operation

func (*HostDataResponse) ProtoMessage

func (*HostDataResponse) ProtoMessage()

func (*HostDataResponse) ProtoReflect

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

func (*HostDataResponse) Reset

func (x *HostDataResponse) Reset()

func (*HostDataResponse) String

func (x *HostDataResponse) String() string

type HostDataResponse_ChangeDimensions

type HostDataResponse_ChangeDimensions struct {
	// Emitted when the Guest decides to change an already created terminal dimensions (e.g. when the web UI terminal size changes)
	ChangeDimensions *TerminalDimensions `protobuf:"bytes,1,opt,name=change_dimensions,json=changeDimensions,proto3,oneof"`
}

type HostDataResponse_Input

type HostDataResponse_Input struct {
	// Terminal input from the Guest
	Input *Data `protobuf:"bytes,2,opt,name=input,proto3,oneof"`
}

type HostServiceClient

type HostServiceClient interface {
	ControlChannel(ctx context.Context, opts ...grpc.CallOption) (HostService_ControlChannelClient, error)
	DataChannel(ctx context.Context, opts ...grpc.CallOption) (HostService_DataChannelClient, error)
}

HostServiceClient is the client API for HostService 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.

type HostServiceServer

type HostServiceServer interface {
	ControlChannel(HostService_ControlChannelServer) error
	DataChannel(HostService_DataChannelServer) error
	// contains filtered or unexported methods
}

HostServiceServer is the server API for HostService service. All implementations must embed UnimplementedHostServiceServer for forward compatibility

type HostService_ControlChannelClient

type HostService_ControlChannelClient interface {
	Send(*HostControlRequest) error
	Recv() (*HostControlResponse, error)
	grpc.ClientStream
}

type HostService_ControlChannelServer

type HostService_ControlChannelServer interface {
	Send(*HostControlResponse) error
	Recv() (*HostControlRequest, error)
	grpc.ServerStream
}

type HostService_DataChannelClient

type HostService_DataChannelClient interface {
	Send(*HostDataRequest) error
	Recv() (*HostDataResponse, error)
	grpc.ClientStream
}

type HostService_DataChannelServer

type HostService_DataChannelServer interface {
	Send(*HostDataResponse) error
	Recv() (*HostDataRequest, error)
	grpc.ServerStream
}

type TerminalDimensions

type TerminalDimensions struct {
	WidthColumns uint32 `protobuf:"varint,1,opt,name=width_columns,json=widthColumns,proto3" json:"width_columns,omitempty"`
	HeightRows   uint32 `protobuf:"varint,2,opt,name=height_rows,json=heightRows,proto3" json:"height_rows,omitempty"`
	// contains filtered or unexported fields
}

func (*TerminalDimensions) Descriptor deprecated

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

Deprecated: Use TerminalDimensions.ProtoReflect.Descriptor instead.

func (*TerminalDimensions) GetHeightRows

func (x *TerminalDimensions) GetHeightRows() uint32

func (*TerminalDimensions) GetWidthColumns

func (x *TerminalDimensions) GetWidthColumns() uint32

func (*TerminalDimensions) ProtoMessage

func (*TerminalDimensions) ProtoMessage()

func (*TerminalDimensions) ProtoReflect

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

func (*TerminalDimensions) Reset

func (x *TerminalDimensions) Reset()

func (*TerminalDimensions) String

func (x *TerminalDimensions) String() string

type UnimplementedGuestServiceServer

type UnimplementedGuestServiceServer struct {
}

UnimplementedGuestServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedGuestServiceServer) TerminalChannel

type UnimplementedHostServiceServer

type UnimplementedHostServiceServer struct {
}

UnimplementedHostServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedHostServiceServer) ControlChannel

func (UnimplementedHostServiceServer) DataChannel

type UnsafeGuestServiceServer

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

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

type UnsafeHostServiceServer

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

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

Jump to

Keyboard shortcuts

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