verrpc

package
v0.0.0-...-dfc2b99 Latest Latest
Warning

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

 Go to latest Published: Jan 23, 2024 License: ISC, MIT Imports: 18 Imported by: 0

Documentation

Overview

Package verrpc is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source 
var Versioner_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "verrpc.Versioner",
	HandlerType: (*VersionerServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetVersion",
			Handler:    _Versioner_GetVersion_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "verrpc/verrpc.proto",
}

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

Functions

func RegisterVersionerHandler 

func RegisterVersionerHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterVersionerHandler registers the http handlers for service Versioner to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterVersionerHandlerClient 

func RegisterVersionerHandlerClient(ctx context.Context, mux *runtime.ServeMux, client VersionerClient) error

RegisterVersionerHandlerClient registers the http handlers for service Versioner to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "VersionerClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "VersionerClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "VersionerClient" to call the correct interceptors.

func RegisterVersionerHandlerFromEndpoint 

func RegisterVersionerHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterVersionerHandlerFromEndpoint is same as RegisterVersionerHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterVersionerServer 

func RegisterVersionerServer(s grpc.ServiceRegistrar, srv VersionerServer)

Types

type Server 

type Server struct{}

Server is an rpc server that supports querying for information about the running binary.

func (*Server) GetVersion 

func (s *Server) GetVersion(_ context.Context,
	_ *VersionRequest) (*Version, error)

GetVersion returns information about the compiled binary.

func (*Server) Name 

func (s *Server) Name() string

Name returns a unique string representation of the sub-server. This can be used to identify the sub-server and also de-duplicate them.

NOTE: This is part of the lnrpc.SubServer interface.

func (*Server) RegisterWithRestServer 

func (s *Server) RegisterWithRestServer(ctx context.Context,
	mux *runtime.ServeMux, dest string, opts []grpc.DialOption) er.R

RegisterWithRestServer will be called by the root REST mux to direct a sub RPC server to register itself with the main REST mux server. Until this is called, each sub-server won't be able to have requests routed towards it.

NOTE: This is part of the lnrpc.SubServer interface.

func (*Server) RegisterWithRootServer 

func (s *Server) RegisterWithRootServer(grpcServer *grpc.Server) er.R

RegisterWithRootServer will be called by the root gRPC server to direct a sub RPC server to register itself with the main gRPC root server. Until this is called, each sub-server won't be able to have requests routed towards it.

NOTE: This is part of the lnrpc.SubServer interface.

func (*Server) Start 

func (s *Server) Start() er.R

Start launches any helper goroutines required for the rpcServer to function.

NOTE: This is part of the lnrpc.SubServer interface.

func (*Server) Stop 

func (s *Server) Stop() er.R

Stop signals any active goroutines for a graceful closure.

NOTE: This is part of the lnrpc.SubServer interface.

type UnimplementedVersionerServer 

type UnimplementedVersionerServer struct {
}

UnimplementedVersionerServer should be embedded to have forward compatible implementations.

func (UnimplementedVersionerServer) GetVersion 

func (UnimplementedVersionerServer) GetVersion(context.Context, *VersionRequest) (*Version, error)

type UnsafeVersionerServer 

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

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

type Version 

type Version struct {
	// A verbose description of the daemon's commit.
	Commit string `protobuf:"bytes,1,opt,name=commit,proto3" json:"commit,omitempty"`
	// The SHA1 commit hash that the daemon is compiled with.
	CommitHash string `protobuf:"bytes,2,opt,name=commit_hash,json=commitHash,proto3" json:"commit_hash,omitempty"`
	// The semantic version.
	Version string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`
	// The major application version.
	AppMajor uint32 `protobuf:"varint,4,opt,name=app_major,json=appMajor,proto3" json:"app_major,omitempty"`
	// The minor application version.
	AppMinor uint32 `protobuf:"varint,5,opt,name=app_minor,json=appMinor,proto3" json:"app_minor,omitempty"`
	// The application patch number.
	AppPatch uint32 `protobuf:"varint,6,opt,name=app_patch,json=appPatch,proto3" json:"app_patch,omitempty"`
	// The application pre-release modifier, possibly empty.
	AppPreRelease string `protobuf:"bytes,7,opt,name=app_pre_release,json=appPreRelease,proto3" json:"app_pre_release,omitempty"`
	// The list of build tags that were supplied during compilation.
	BuildTags []string `protobuf:"bytes,8,rep,name=build_tags,json=buildTags,proto3" json:"build_tags,omitempty"`
	// The version of go that compiled the executable.
	GoVersion            string   `protobuf:"bytes,9,opt,name=go_version,json=goVersion,proto3" json:"go_version,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*Version) Descriptor 

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

func (*Version) GetAppMajor 

func (m *Version) GetAppMajor() uint32

func (*Version) GetAppMinor 

func (m *Version) GetAppMinor() uint32

func (*Version) GetAppPatch 

func (m *Version) GetAppPatch() uint32

func (*Version) GetAppPreRelease 

func (m *Version) GetAppPreRelease() string

func (*Version) GetBuildTags 

func (m *Version) GetBuildTags() []string

func (*Version) GetCommit 

func (m *Version) GetCommit() string

func (*Version) GetCommitHash 

func (m *Version) GetCommitHash() string

func (*Version) GetGoVersion 

func (m *Version) GetGoVersion() string

func (*Version) GetVersion 

func (m *Version) GetVersion() string

func (*Version) ProtoMessage 

func (*Version) ProtoMessage()

func (*Version) Reset 

func (m *Version) Reset()

func (*Version) String 

func (m *Version) String() string

func (*Version) XXX_DiscardUnknown 

func (m *Version) XXX_DiscardUnknown()

func (*Version) XXX_Marshal 

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

func (*Version) XXX_Merge 

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

func (*Version) XXX_Size 

func (m *Version) XXX_Size() int

func (*Version) XXX_Unmarshal 

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

type VersionRequest 

type VersionRequest struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*VersionRequest) Descriptor 

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

func (*VersionRequest) ProtoMessage 

func (*VersionRequest) ProtoMessage()

func (*VersionRequest) Reset 

func (m *VersionRequest) Reset()

func (*VersionRequest) String 

func (m *VersionRequest) String() string

func (*VersionRequest) XXX_DiscardUnknown 

func (m *VersionRequest) XXX_DiscardUnknown()

func (*VersionRequest) XXX_Marshal 

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

func (*VersionRequest) XXX_Merge 

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

func (*VersionRequest) XXX_Size 

func (m *VersionRequest) XXX_Size() int

func (*VersionRequest) XXX_Unmarshal 

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

type VersionerClient 

type VersionerClient interface {
	//
	//$pld.category: `Meta`
	//$pld.short_description: `Display pldctl and pld version info`
	//
	//GetVersion returns the current version and build information of the running
	//daemon.
	GetVersion(ctx context.Context, in *VersionRequest, opts ...grpc.CallOption) (*Version, error)
}

VersionerClient is the client API for Versioner 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 NewVersionerClient 

func NewVersionerClient(cc grpc.ClientConnInterface) VersionerClient

type VersionerServer 

type VersionerServer interface {
	//
	//$pld.category: `Meta`
	//$pld.short_description: `Display pldctl and pld version info`
	//
	//GetVersion returns the current version and build information of the running
	//daemon.
	GetVersion(context.Context, *VersionRequest) (*Version, error)
}

VersionerServer is the server API for Versioner service. All implementations should embed UnimplementedVersionerServer for forward compatibility

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.