verrpc

Documentation

Index

• Constants
• func DisableLog()
• func RegisterVersionerServer(s *grpc.Server, srv VersionerServer)
• func UseLogger(logger btclog.Logger)
• type Server
  • func (s *Server) GetVersion(_ context.Context, _ *VersionRequest) (*Version, error)
  • func (s *Server) Name() string
  • func (s *Server) RegisterWithRootServer(grpcServer *grpc.Server) error
  • func (s *Server) Start() error
  • func (s *Server) Stop() error
• type Version
  • func (*Version) Descriptor() ([]byte, []int)
  • func (m *Version) GetAppMajor() uint32
  • func (m *Version) GetAppMinor() uint32
  • func (m *Version) GetAppPatch() uint32
  • func (m *Version) GetAppPreRelease() string
  • func (m *Version) GetBuildTags() []string
  • func (m *Version) GetCommit() string
  • func (m *Version) GetCommitHash() string
  • func (m *Version) GetGoVersion() string
  • func (m *Version) GetVersion() string
  • func (*Version) ProtoMessage()
  • func (m *Version) Reset()
  • func (m *Version) String() string
  • func (m *Version) XXX_DiscardUnknown()
  • func (m *Version) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *Version) XXX_Merge(src proto.Message)
  • func (m *Version) XXX_Size() int
  • func (m *Version) XXX_Unmarshal(b []byte) error
• type VersionRequest
  • func (*VersionRequest) Descriptor() ([]byte, []int)
  • func (*VersionRequest) ProtoMessage()
  • func (m *VersionRequest) Reset()
  • func (m *VersionRequest) String() string
  • func (m *VersionRequest) XXX_DiscardUnknown()
  • func (m *VersionRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *VersionRequest) XXX_Merge(src proto.Message)
  • func (m *VersionRequest) XXX_Size() int
  • func (m *VersionRequest) XXX_Unmarshal(b []byte) error
• type VersionerClient
  • func NewVersionerClient(cc *grpc.ClientConn) VersionerClient
• type VersionerServer

Constants

const Subsystem = "VRPC"

Subsystem defines the logging code for this subsystem.

Functions

func DisableLog

func DisableLog()

DisableLog disables all library log output. Logging output is disabled by default until UseLogger is called.

func RegisterVersionerServer

func RegisterVersionerServer(s *grpc.Server, srv VersionerServer)

func UseLogger

func UseLogger(logger btclog.Logger)

UseLogger uses a specified Logger to output package logging info. This should be used in preference to SetLogWriter if the caller is also using btclog.

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) RegisterWithRootServer

func (s *Server) RegisterWithRootServer(grpcServer *grpc.Server) error

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() error

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() error

Stop signals any active goroutines for a graceful closure.

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

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 {
	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://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewVersionerClient

func NewVersionerClient(cc *grpc.ClientConn) VersionerClient

type VersionerServer

type VersionerServer interface {
	GetVersion(context.Context, *VersionRequest) (*Version, error)
}

VersionerServer is the server API for Versioner service.