Documentation ¶
Index ¶
- Variables
- func RegisterUplinkServer(s grpc.ServiceRegistrar, srv UplinkServer)
- type RegisterRequest
- func (*RegisterRequest) Descriptor() ([]byte, []int)deprecated
- func (x *RegisterRequest) GetEd25519PublicKey() []byte
- func (x *RegisterRequest) GetPorts() []int32
- func (x *RegisterRequest) GetSignature() []byte
- func (*RegisterRequest) ProtoMessage()
- func (x *RegisterRequest) ProtoReflect() protoreflect.Message
- func (x *RegisterRequest) Reset()
- func (x *RegisterRequest) String() string
- type RegisterTrigger
- type SetupRequest
- func (*SetupRequest) Descriptor() ([]byte, []int)deprecated
- func (x *SetupRequest) GetError() *status.Status
- func (x *SetupRequest) GetIngress() *SetupRequest_Ingress
- func (x *SetupRequest) GetRedirect() *SetupRequest_Redirect
- func (m *SetupRequest) GetSetup() isSetupRequest_Setup
- func (*SetupRequest) ProtoMessage()
- func (x *SetupRequest) ProtoReflect() protoreflect.Message
- func (x *SetupRequest) Reset()
- func (x *SetupRequest) String() string
- type SetupRequest_Error
- type SetupRequest_Ingress
- func (*SetupRequest_Ingress) Descriptor() ([]byte, []int)deprecated
- func (x *SetupRequest_Ingress) GetIngress() []string
- func (*SetupRequest_Ingress) ProtoMessage()
- func (x *SetupRequest_Ingress) ProtoReflect() protoreflect.Message
- func (x *SetupRequest_Ingress) Reset()
- func (x *SetupRequest_Ingress) String() string
- type SetupRequest_Ingress_
- type SetupRequest_Redirect
- func (*SetupRequest_Redirect) Descriptor() ([]byte, []int)deprecated
- func (x *SetupRequest_Redirect) GetRedirectTo() []string
- func (*SetupRequest_Redirect) ProtoMessage()
- func (x *SetupRequest_Redirect) ProtoReflect() protoreflect.Message
- func (x *SetupRequest_Redirect) Reset()
- func (x *SetupRequest_Redirect) String() string
- type SetupRequest_Redirect_
- type SetupResponse
- type UnimplementedUplinkServer
- type UnsafeUplinkServer
- type UplinkClient
- type UplinkServer
Constants ¶
This section is empty.
Variables ¶
var File_pkg_uplink_uplinkpb_uplink_proto protoreflect.FileDescriptor
Functions ¶
func RegisterUplinkServer ¶
func RegisterUplinkServer(s grpc.ServiceRegistrar, srv UplinkServer)
Types ¶
type RegisterRequest ¶
type RegisterRequest struct { // The public key used to sign the nonce. // // existing encoding standards like pkcs#12 and pem are slow to gain support for // new ciphers; for now we'll just encode the type of the public key in the proto // schema and deal with cipher evolution by evolving the proto. Ed25519PublicKey []byte `protobuf:"bytes,1,opt,name=ed25519_public_key,json=ed25519PublicKey,proto3" json:"ed25519_public_key,omitempty"` // The signature of the nonce. Signature []byte `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"` // request that the tunnel broker has at least one of these ports open. // if the broker doesn't have (or allow) some of these ports, they won't be // present in the "ingress" repeated field of the subsequent Setup message. // The client might treat the lack of a requested port as a fatal error. Ports []int32 `protobuf:"varint,3,rep,packed,name=ports,proto3" json:"ports,omitempty"` // contains filtered or unexported fields }
func (*RegisterRequest) Descriptor
deprecated
func (*RegisterRequest) Descriptor() ([]byte, []int)
Deprecated: Use RegisterRequest.ProtoReflect.Descriptor instead.
func (*RegisterRequest) GetEd25519PublicKey ¶
func (x *RegisterRequest) GetEd25519PublicKey() []byte
func (*RegisterRequest) GetPorts ¶
func (x *RegisterRequest) GetPorts() []int32
func (*RegisterRequest) GetSignature ¶
func (x *RegisterRequest) GetSignature() []byte
func (*RegisterRequest) ProtoMessage ¶
func (*RegisterRequest) ProtoMessage()
func (*RegisterRequest) ProtoReflect ¶
func (x *RegisterRequest) ProtoReflect() protoreflect.Message
func (*RegisterRequest) Reset ¶
func (x *RegisterRequest) Reset()
func (*RegisterRequest) String ¶
func (x *RegisterRequest) String() string
type RegisterTrigger ¶
type RegisterTrigger struct { Nonce []byte `protobuf:"bytes,1,opt,name=nonce,proto3" json:"nonce,omitempty"` // contains filtered or unexported fields }
func (*RegisterTrigger) Descriptor
deprecated
func (*RegisterTrigger) Descriptor() ([]byte, []int)
Deprecated: Use RegisterTrigger.ProtoReflect.Descriptor instead.
func (*RegisterTrigger) GetNonce ¶
func (x *RegisterTrigger) GetNonce() []byte
func (*RegisterTrigger) ProtoMessage ¶
func (*RegisterTrigger) ProtoMessage()
func (*RegisterTrigger) ProtoReflect ¶
func (x *RegisterTrigger) ProtoReflect() protoreflect.Message
func (*RegisterTrigger) Reset ¶
func (x *RegisterTrigger) Reset()
func (*RegisterTrigger) String ¶
func (x *RegisterTrigger) String() string
type SetupRequest ¶
type SetupRequest struct { // Types that are assignable to Setup: // *SetupRequest_Ingress_ // *SetupRequest_Redirect_ // *SetupRequest_Error Setup isSetupRequest_Setup `protobuf_oneof:"setup"` // contains filtered or unexported fields }
func (*SetupRequest) Descriptor
deprecated
func (*SetupRequest) Descriptor() ([]byte, []int)
Deprecated: Use SetupRequest.ProtoReflect.Descriptor instead.
func (*SetupRequest) GetError ¶
func (x *SetupRequest) GetError() *status.Status
func (*SetupRequest) GetIngress ¶
func (x *SetupRequest) GetIngress() *SetupRequest_Ingress
func (*SetupRequest) GetRedirect ¶
func (x *SetupRequest) GetRedirect() *SetupRequest_Redirect
func (*SetupRequest) GetSetup ¶
func (m *SetupRequest) GetSetup() isSetupRequest_Setup
func (*SetupRequest) ProtoMessage ¶
func (*SetupRequest) ProtoMessage()
func (*SetupRequest) ProtoReflect ¶
func (x *SetupRequest) ProtoReflect() protoreflect.Message
func (*SetupRequest) Reset ¶
func (x *SetupRequest) Reset()
func (*SetupRequest) String ¶
func (x *SetupRequest) String() string
type SetupRequest_Error ¶
type SetupRequest_Error struct { // in case of any error setting up the tunnel, the server will send the // status here (because it cannot respond with an error to the RegisterResponse // response, because it's already a response). // // TODO(mkm): find a way to make go mod work with protobuf source imports. Error *status.Status `protobuf:"bytes,3,opt,name=error,proto3,oneof"` }
type SetupRequest_Ingress ¶
type SetupRequest_Ingress struct { // hostname:port pairs where the tunnel will be accessible to external clients. Ingress []string `protobuf:"bytes,1,rep,name=ingress,proto3" json:"ingress,omitempty"` // contains filtered or unexported fields }
func (*SetupRequest_Ingress) Descriptor
deprecated
func (*SetupRequest_Ingress) Descriptor() ([]byte, []int)
Deprecated: Use SetupRequest_Ingress.ProtoReflect.Descriptor instead.
func (*SetupRequest_Ingress) GetIngress ¶
func (x *SetupRequest_Ingress) GetIngress() []string
func (*SetupRequest_Ingress) ProtoMessage ¶
func (*SetupRequest_Ingress) ProtoMessage()
func (*SetupRequest_Ingress) ProtoReflect ¶
func (x *SetupRequest_Ingress) ProtoReflect() protoreflect.Message
func (*SetupRequest_Ingress) Reset ¶
func (x *SetupRequest_Ingress) Reset()
func (*SetupRequest_Ingress) String ¶
func (x *SetupRequest_Ingress) String() string
type SetupRequest_Ingress_ ¶
type SetupRequest_Ingress_ struct {
Ingress *SetupRequest_Ingress `protobuf:"bytes,1,opt,name=ingress,proto3,oneof"`
}
type SetupRequest_Redirect ¶
type SetupRequest_Redirect struct { // the tunnel request is accepted by this broker instance is not the right // endpoint the setup a durable tunnel session. // The client should try again to setup the tunnel by contact to one or more of // these host:port pairs. RedirectTo []string `protobuf:"bytes,2,rep,name=redirect_to,json=redirectTo,proto3" json:"redirect_to,omitempty"` // contains filtered or unexported fields }
func (*SetupRequest_Redirect) Descriptor
deprecated
func (*SetupRequest_Redirect) Descriptor() ([]byte, []int)
Deprecated: Use SetupRequest_Redirect.ProtoReflect.Descriptor instead.
func (*SetupRequest_Redirect) GetRedirectTo ¶
func (x *SetupRequest_Redirect) GetRedirectTo() []string
func (*SetupRequest_Redirect) ProtoMessage ¶
func (*SetupRequest_Redirect) ProtoMessage()
func (*SetupRequest_Redirect) ProtoReflect ¶
func (x *SetupRequest_Redirect) ProtoReflect() protoreflect.Message
func (*SetupRequest_Redirect) Reset ¶
func (x *SetupRequest_Redirect) Reset()
func (*SetupRequest_Redirect) String ¶
func (x *SetupRequest_Redirect) String() string
type SetupRequest_Redirect_ ¶
type SetupRequest_Redirect_ struct {
Redirect *SetupRequest_Redirect `protobuf:"bytes,2,opt,name=redirect,proto3,oneof"`
}
type SetupResponse ¶
type SetupResponse struct {
// contains filtered or unexported fields
}
func (*SetupResponse) Descriptor
deprecated
func (*SetupResponse) Descriptor() ([]byte, []int)
Deprecated: Use SetupResponse.ProtoReflect.Descriptor instead.
func (*SetupResponse) ProtoMessage ¶
func (*SetupResponse) ProtoMessage()
func (*SetupResponse) ProtoReflect ¶
func (x *SetupResponse) ProtoReflect() protoreflect.Message
func (*SetupResponse) Reset ¶
func (x *SetupResponse) Reset()
func (*SetupResponse) String ¶
func (x *SetupResponse) String() string
type UnimplementedUplinkServer ¶
type UnimplementedUplinkServer struct { }
UnimplementedUplinkServer must be embedded to have forward compatible implementations.
func (UnimplementedUplinkServer) Register ¶
func (UnimplementedUplinkServer) Register(context.Context, *RegisterTrigger) (*RegisterRequest, error)
func (UnimplementedUplinkServer) Setup ¶
func (UnimplementedUplinkServer) Setup(context.Context, *SetupRequest) (*SetupResponse, error)
type UnsafeUplinkServer ¶
type UnsafeUplinkServer interface {
// contains filtered or unexported methods
}
UnsafeUplinkServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to UplinkServer will result in compilation errors.
type UplinkClient ¶
type UplinkClient interface { Register(ctx context.Context, in *RegisterTrigger, opts ...grpc.CallOption) (*RegisterRequest, error) Setup(ctx context.Context, in *SetupRequest, opts ...grpc.CallOption) (*SetupResponse, error) }
UplinkClient is the client API for Uplink 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 NewUplinkClient ¶
func NewUplinkClient(cc grpc.ClientConnInterface) UplinkClient
type UplinkServer ¶
type UplinkServer interface { Register(context.Context, *RegisterTrigger) (*RegisterRequest, error) Setup(context.Context, *SetupRequest) (*SetupResponse, error) // contains filtered or unexported methods }
UplinkServer is the server API for Uplink service. All implementations must embed UnimplementedUplinkServer for forward compatibility