rc

package
v0.0.0-...-c7154f0 Latest Latest
Warning

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

Go to latest
Published: Jul 30, 2023 License: MIT Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source
const (
	RemoteControl_NetConn_FullMethodName = "/sesame.v1alpha1.RemoteControl/NetConn"
)

Variables

View Source
var File_sesame_v1alpha1_remotecontrol_proto protoreflect.FileDescriptor
View Source
var RemoteControl_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "sesame.v1alpha1.RemoteControl",
	HandlerType: (*RemoteControlServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "NetConn",
			Handler:       _RemoteControl_NetConn_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "sesame/v1alpha1/remotecontrol.proto",
}

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

Functions

func RegisterRemoteControlServer

func RegisterRemoteControlServer(s grpc.ServiceRegistrar, srv RemoteControlServer)

Types

type NetConnRequest

type NetConnRequest struct {

	// Types that are assignable to Data:
	//
	//	*NetConnRequest_Dial_
	//	*NetConnRequest_Bytes
	Data isNetConnRequest_Data `protobuf_oneof:"data"`
	// contains filtered or unexported fields
}

NetConnRequest models a message sent from a RemoteControl.NetConn client to the server. See also documentation of that method.

func (*NetConnRequest) Descriptor deprecated

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

Deprecated: Use NetConnRequest.ProtoReflect.Descriptor instead.

func (*NetConnRequest) GetBytes

func (x *NetConnRequest) GetBytes() []byte

func (*NetConnRequest) GetData

func (m *NetConnRequest) GetData() isNetConnRequest_Data

func (*NetConnRequest) GetDial

func (x *NetConnRequest) GetDial() *NetConnRequest_Dial

func (*NetConnRequest) ProtoMessage

func (*NetConnRequest) ProtoMessage()

func (*NetConnRequest) ProtoReflect

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

func (*NetConnRequest) Proto_ShallowClone

func (x *NetConnRequest) Proto_ShallowClone() (c *NetConnRequest)

Proto_ShallowClone returns a shallow copy of the receiver or nil if it's nil.

func (*NetConnRequest) Proto_ShallowCopy

func (x *NetConnRequest) Proto_ShallowCopy(v interface{})

Proto_ShallowCopy copies fields, from v to the receiver, using field getters. Note that v is of an arbitrary type, which may implement any number of the field getters, which are defined as any methods of the same signature as those generated for the receiver type, with a name starting with Get. WARNING: Optional fields may be ignored, if v is not the receiver type.

func (*NetConnRequest) Reset

func (x *NetConnRequest) Reset()

func (*NetConnRequest) String

func (x *NetConnRequest) String() string

type NetConnRequest_Bytes

type NetConnRequest_Bytes struct {
	Bytes []byte `protobuf:"bytes,2,opt,name=bytes,proto3,oneof"`
}

type NetConnRequest_Dial

type NetConnRequest_Dial struct {
	Address *netaddr.NetAddr     `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
	Timeout *durationpb.Duration `protobuf:"bytes,2,opt,name=timeout,proto3" json:"timeout,omitempty"`
	// contains filtered or unexported fields
}

Dial models the initial request.

func (*NetConnRequest_Dial) Descriptor deprecated

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

Deprecated: Use NetConnRequest_Dial.ProtoReflect.Descriptor instead.

func (*NetConnRequest_Dial) GetAddress

func (x *NetConnRequest_Dial) GetAddress() *netaddr.NetAddr

func (*NetConnRequest_Dial) GetTimeout

func (x *NetConnRequest_Dial) GetTimeout() *durationpb.Duration

func (*NetConnRequest_Dial) ProtoMessage

func (*NetConnRequest_Dial) ProtoMessage()

func (*NetConnRequest_Dial) ProtoReflect

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

func (*NetConnRequest_Dial) Proto_ShallowClone

func (x *NetConnRequest_Dial) Proto_ShallowClone() (c *NetConnRequest_Dial)

Proto_ShallowClone returns a shallow copy of the receiver or nil if it's nil.

func (*NetConnRequest_Dial) Proto_ShallowCopy

func (x *NetConnRequest_Dial) Proto_ShallowCopy(v interface{})

Proto_ShallowCopy copies fields, from v to the receiver, using field getters. Note that v is of an arbitrary type, which may implement any number of the field getters, which are defined as any methods of the same signature as those generated for the receiver type, with a name starting with Get. WARNING: Optional fields may be ignored, if v is not the receiver type.

func (*NetConnRequest_Dial) Reset

func (x *NetConnRequest_Dial) Reset()

func (*NetConnRequest_Dial) String

func (x *NetConnRequest_Dial) String() string

type NetConnRequest_Dial_

type NetConnRequest_Dial_ struct {
	Dial *NetConnRequest_Dial `protobuf:"bytes,1,opt,name=dial,proto3,oneof"`
}

type NetConnResponse

type NetConnResponse struct {

	// Types that are assignable to Data:
	//
	//	*NetConnResponse_Conn_
	//	*NetConnResponse_Bytes
	Data isNetConnResponse_Data `protobuf_oneof:"data"`
	// contains filtered or unexported fields
}

NetConnResponse models a message sent from a RemoteControl.NetConn server to the client. See also documentation of that method.

func (*NetConnResponse) Descriptor deprecated

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

Deprecated: Use NetConnResponse.ProtoReflect.Descriptor instead.

func (*NetConnResponse) GetBytes

func (x *NetConnResponse) GetBytes() []byte

func (*NetConnResponse) GetConn

func (x *NetConnResponse) GetConn() *NetConnResponse_Conn

func (*NetConnResponse) GetData

func (m *NetConnResponse) GetData() isNetConnResponse_Data

func (*NetConnResponse) ProtoMessage

func (*NetConnResponse) ProtoMessage()

func (*NetConnResponse) ProtoReflect

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

func (*NetConnResponse) Proto_ShallowClone

func (x *NetConnResponse) Proto_ShallowClone() (c *NetConnResponse)

Proto_ShallowClone returns a shallow copy of the receiver or nil if it's nil.

func (*NetConnResponse) Proto_ShallowCopy

func (x *NetConnResponse) Proto_ShallowCopy(v interface{})

Proto_ShallowCopy copies fields, from v to the receiver, using field getters. Note that v is of an arbitrary type, which may implement any number of the field getters, which are defined as any methods of the same signature as those generated for the receiver type, with a name starting with Get. WARNING: Optional fields may be ignored, if v is not the receiver type.

func (*NetConnResponse) Reset

func (x *NetConnResponse) Reset()

func (*NetConnResponse) String

func (x *NetConnResponse) String() string

type NetConnResponse_Bytes

type NetConnResponse_Bytes struct {
	Bytes []byte `protobuf:"bytes,2,opt,name=bytes,proto3,oneof"`
}

type NetConnResponse_Conn

type NetConnResponse_Conn struct {
	Local  *netaddr.NetAddr `protobuf:"bytes,1,opt,name=local,proto3" json:"local,omitempty"`
	Remote *netaddr.NetAddr `protobuf:"bytes,2,opt,name=remote,proto3" json:"remote,omitempty"`
	// contains filtered or unexported fields
}

Conn models the initial response.

func (*NetConnResponse_Conn) Descriptor deprecated

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

Deprecated: Use NetConnResponse_Conn.ProtoReflect.Descriptor instead.

func (*NetConnResponse_Conn) GetLocal

func (x *NetConnResponse_Conn) GetLocal() *netaddr.NetAddr

func (*NetConnResponse_Conn) GetRemote

func (x *NetConnResponse_Conn) GetRemote() *netaddr.NetAddr

func (*NetConnResponse_Conn) ProtoMessage

func (*NetConnResponse_Conn) ProtoMessage()

func (*NetConnResponse_Conn) ProtoReflect

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

func (*NetConnResponse_Conn) Proto_ShallowClone

func (x *NetConnResponse_Conn) Proto_ShallowClone() (c *NetConnResponse_Conn)

Proto_ShallowClone returns a shallow copy of the receiver or nil if it's nil.

func (*NetConnResponse_Conn) Proto_ShallowCopy

func (x *NetConnResponse_Conn) Proto_ShallowCopy(v interface{})

Proto_ShallowCopy copies fields, from v to the receiver, using field getters. Note that v is of an arbitrary type, which may implement any number of the field getters, which are defined as any methods of the same signature as those generated for the receiver type, with a name starting with Get. WARNING: Optional fields may be ignored, if v is not the receiver type.

func (*NetConnResponse_Conn) Reset

func (x *NetConnResponse_Conn) Reset()

func (*NetConnResponse_Conn) String

func (x *NetConnResponse_Conn) String() string

type NetConnResponse_Conn_

type NetConnResponse_Conn_ struct {
	Conn *NetConnResponse_Conn `protobuf:"bytes,1,opt,name=conn,proto3,oneof"`
}

type RemoteControlClient

type RemoteControlClient interface {
	// NetConn implements a remote dialer, which may be used for a variety of purposes, including forwarding to other
	// gRPC services running in the same (server) process.
	//
	// If the server doesn't support this method, it returns `UNIMPLEMENTED`.
	//
	// The message flow is:
	//
	//  1. NetConnRequest.dial
	//  2. NetConnResponse.conn
	//  3. Any number of NetConnRequest.bytes and NetConnResponse.bytes
	//  4. Termination
	//     i. Graceful (client initiated)
	//     a. Initiated by grpc.ClientStream.CloseSend
	//     b. After processing all received messages the server initiates (full) connection close of the
	//     proxy target
	//     c. All data read from the proxy target is sent to the client
	//     d. The connection is closed by the server
	//     ii. Proxy target initiated
	//     a. The proxy target connection closes
	//     b. All buffered data received from the proxy target is sent to the client
	//     c. An error is propagated to the client
	//     iii. Server initiated
	//     a. The server encounters an error (e.g. due to context cancel)
	//     b. The proxy target connection is closed
	//     c. An error is propagated to the client (though there are common cases where it's already gone)
	NetConn(ctx context.Context, opts ...grpc.CallOption) (RemoteControl_NetConnClient, error)
}

RemoteControlClient is the client API for RemoteControl 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 RemoteControlServer

type RemoteControlServer interface {
	// NetConn implements a remote dialer, which may be used for a variety of purposes, including forwarding to other
	// gRPC services running in the same (server) process.
	//
	// If the server doesn't support this method, it returns `UNIMPLEMENTED`.
	//
	// The message flow is:
	//
	//  1. NetConnRequest.dial
	//  2. NetConnResponse.conn
	//  3. Any number of NetConnRequest.bytes and NetConnResponse.bytes
	//  4. Termination
	//     i. Graceful (client initiated)
	//     a. Initiated by grpc.ClientStream.CloseSend
	//     b. After processing all received messages the server initiates (full) connection close of the
	//     proxy target
	//     c. All data read from the proxy target is sent to the client
	//     d. The connection is closed by the server
	//     ii. Proxy target initiated
	//     a. The proxy target connection closes
	//     b. All buffered data received from the proxy target is sent to the client
	//     c. An error is propagated to the client
	//     iii. Server initiated
	//     a. The server encounters an error (e.g. due to context cancel)
	//     b. The proxy target connection is closed
	//     c. An error is propagated to the client (though there are common cases where it's already gone)
	NetConn(RemoteControl_NetConnServer) error
	// contains filtered or unexported methods
}

RemoteControlServer is the server API for RemoteControl service. All implementations must embed UnimplementedRemoteControlServer for forward compatibility

type RemoteControl_NetConnClient

type RemoteControl_NetConnClient interface {
	Send(*NetConnRequest) error
	Recv() (*NetConnResponse, error)
	grpc.ClientStream
}

type RemoteControl_NetConnServer

type RemoteControl_NetConnServer interface {
	Send(*NetConnResponse) error
	Recv() (*NetConnRequest, error)
	grpc.ServerStream
}

type UnimplementedRemoteControlServer

type UnimplementedRemoteControlServer struct {
}

UnimplementedRemoteControlServer must be embedded to have forward compatible implementations.

func (UnimplementedRemoteControlServer) NetConn

type UnsafeRemoteControlServer

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

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

Directories

Path Synopsis
Package netconn provides both client and server implementations using/for rc.RemoteControlClient's NetConn method.
Package netconn provides both client and server implementations using/for rc.RemoteControlClient's NetConn method.

Jump to

Keyboard shortcuts

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