rpc

package

Go to main page

Versions in this module

v0

v0.8.0

Sep 2, 2025

Changes in this version

+ func MustRegisterAs[TIn, TOut any](svc *Service, name string, handler Handler[TIn, TOut])

+ func MustRegisterBidiStreamAs[TIn, TOut any](svc *Service, name string, handler BidiStreamHandler[TIn, TOut])

+ func MustRegisterClientStreamAs[TIn, TOut any](svc *Service, name string, handler ClientStreamHandler[TIn, TOut])

+ func MustRegisterServerStreamAs[TIn, TOut any](svc *Service, name string, handler ServerStreamHandler[TIn, TOut])

+ func RegisterAs[TIn, TOut any](svc *Service, name string, handler Handler[TIn, TOut]) error

+ func RegisterBidiStreamAs[TIn, TOut any](svc *Service, name string, handler BidiStreamHandler[TIn, TOut]) error

+ func RegisterClientStreamAs[TIn, TOut any](svc *Service, name string, handler ClientStreamHandler[TIn, TOut]) error

+ func RegisterServerStreamAs[TIn, TOut any](svc *Service, name string, handler ServerStreamHandler[TIn, TOut]) error

+ type ContextHelper struct

+ func Context(ctx context.Context) *ContextHelper

+ func (c *ContextHelper) Authorization() string

+ func (c *ContextHelper) BearerToken() string

+ func (c *ContextHelper) ClientIP() string

+ func (c *ContextHelper) Context() context.Context

+ func (c *ContextHelper) HandlerContext() *handlerContext

+ func (c *ContextHelper) HasHeader(key string) bool

+ func (c *ContextHelper) Header(key string) string

+ func (c *ContextHelper) HeaderValues(key string) []string

+ func (c *ContextHelper) Headers() map[string][]string

+ func (c *ContextHelper) IsConnect() bool

+ func (c *ContextHelper) IsGRPC() bool

+ func (c *ContextHelper) IsGRPCWeb() bool

+ func (c *ContextHelper) IsJSONRPC() bool

+ func (c *ContextHelper) Metadata(key string) string

+ func (c *ContextHelper) MustValidate()

+ func (c *ContextHelper) RequireHeader(key string) *ContextHelper

+ func (c *ContextHelper) RequireHeaders(keys ...string) *ContextHelper

+ func (c *ContextHelper) RequireMetadata(key string) *ContextHelper

+ func (c *ContextHelper) SetHeader(key, value string) *ContextHelper

+ func (c *ContextHelper) SetHeaders(headers map[string]string) *ContextHelper

+ func (c *ContextHelper) SetMetadata(key, value string) *ContextHelper

+ func (c *ContextHelper) SetTrailer(key, value string) *ContextHelper

+ func (c *ContextHelper) SetTrailers(trailers map[string]string) *ContextHelper

+ func (c *ContextHelper) UserAgent() string

+ func (c *ContextHelper) Validate() error

+ func (c *ContextHelper) WithValue(key, value any) *ContextHelper

+ type ErrorBuilder struct

+ func Aborted(message string) *ErrorBuilder

+ func AlreadyExists(message string) *ErrorBuilder

+ func Canceled(message string) *ErrorBuilder

+ func DataLoss(message string) *ErrorBuilder

+ func DeadlineExceeded(message string) *ErrorBuilder

+ func FailedPrecondition(message string) *ErrorBuilder

+ func Internal(message string) *ErrorBuilder

+ func InvalidArgument(message string) *ErrorBuilder

+ func NewErrorBuilder() *ErrorBuilder

+ func NotFound(message string) *ErrorBuilder

+ func OutOfRange(message string) *ErrorBuilder

+ func PermissionDenied(message string) *ErrorBuilder

+ func ResourceExhausted(message string) *ErrorBuilder

+ func Unauthenticated(message string) *ErrorBuilder

+ func Unavailable(message string) *ErrorBuilder

+ func Unimplemented(message string) *ErrorBuilder

+ func (e *ErrorBuilder) Build() *Error

+ func (e *ErrorBuilder) Code(c Code) *ErrorBuilder

+ func (e *ErrorBuilder) Detail(key string, value any) *ErrorBuilder

+ func (e *ErrorBuilder) Details(details map[string]any) *ErrorBuilder

+ func (e *ErrorBuilder) Message(m string) *ErrorBuilder

+ func (e *ErrorBuilder) Messagef(format string, args ...any) *ErrorBuilder

+ func (e *ErrorBuilder) WithField(field string, reason any) *ErrorBuilder

+ type ErrorCollector struct

+ func NewErrorCollector() *ErrorCollector

+ func (c *ErrorCollector) Add(field, message string)

+ func (c *ErrorCollector) Addf(field, format string, args ...any)

+ func (c *ErrorCollector) AsError() *Error

+ func (c *ErrorCollector) Clear()

+ func (c *ErrorCollector) HasErrors() bool

+ type MethodChain struct

+ func (m *MethodChain) And(name string) *MethodChain

+ func (m *MethodChain) BidiStream(handler any) *MethodChain

+ func (m *MethodChain) Build() *Method

+ func (m *MethodChain) ClientStream(handler any) *MethodChain

+ func (m *MethodChain) MustRegister() *MethodChain

+ func (m *MethodChain) Register() error

+ func (m *MethodChain) ServerStream(handler any) *MethodChain

+ func (m *MethodChain) Unary(handler any) *MethodChain

+ func (m *MethodChain) Validate(enabled bool) *MethodChain

+ func (m *MethodChain) WithCompression(algorithm string) *MethodChain

+ func (m *MethodChain) WithDescription(description string) *MethodChain

+ func (m *MethodChain) WithInterceptors(interceptors ...Interceptor) *MethodChain

+ func (m *MethodChain) WithMaxMessageSize(size int) *MethodChain

+ func (m *MethodChain) WithRetry(maxAttempts int) *MethodChain

+ func (m *MethodChain) WithTimeout(d time.Duration) *MethodChain

+ type MethodDefinition interface

+ func BidiStreamDef[TIn, TOut any](name string, handler func(context.Context, BidiStream[TIn, TOut]) error) MethodDefinition

+ func ClientStreamDef[TIn, TOut any](name string, handler func(context.Context, ClientStream[TIn]) (*TOut, error)) MethodDefinition

+ func ServerStreamDef[TIn, TOut any](name string, handler func(context.Context, *TIn, ServerStream[TOut]) error) MethodDefinition

+ func Unary[TIn, TOut any](name string, handler func(context.Context, *TIn) (*TOut, error)) MethodDefinition

+ type MethodGroup struct

+ func TypedGroup[TContext any](s *Service) *MethodGroup[TContext]

+ func (g *MethodGroup[TContext]) Add(method MethodDefinition) *MethodGroup[TContext]

+ func (g *MethodGroup[TContext]) MustRegister()

+ func (g *MethodGroup[TContext]) Register() error

+ type ProtocolConfigBuilder struct

+ func ConfigureProtocols() *ProtocolConfigBuilder

+ func (b *ProtocolConfigBuilder) Build() ServiceOption

+ func (b *ProtocolConfigBuilder) Connect(allowJSON, allowProto bool) *ProtocolConfigBuilder

+ func (b *ProtocolConfigBuilder) GRPC(enableReflection bool) *ProtocolConfigBuilder

+ func (b *ProtocolConfigBuilder) GRPCWeb() *ProtocolConfigBuilder

+ func (b *ProtocolConfigBuilder) JSONRPC(path string, batchLimit int) *ProtocolConfigBuilder

+ type ProtocolPreset string

+ const PresetAll

+ const PresetGRPC

+ const PresetMinimal

+ const PresetREST

type Service

+ func (s *Service) AutoRegister(service any) error

+ func (s *Service) Group() *MethodGroup[any]

+ func (s *Service) Method(name string) *MethodChain

+ func (s *Service) MustRegisterAll(methods ...MethodDefinition)

+ func (s *Service) MustRegisterService(registrar ServiceRegistrar)

+ func (s *Service) RegisterAll(methods ...MethodDefinition) error

+ func (s *Service) RegisterService(registrar ServiceRegistrar) error

type ServiceOption

+ func DisableConnect() ServiceOption

+ func DisableGRPC() ServiceOption

+ func DisableGRPCWeb() ServiceOption

+ func DisableJSONRPC() ServiceOption

+ func EnableAllProtocols() ServiceOption

+ func EnableGRPCProtocols() ServiceOption

+ func EnableRESTProtocols() ServiceOption

+ func WithConnect(allowJSON, allowProto bool) ServiceOption

+ func WithGRPC(enableReflection bool) ServiceOption

+ func WithGRPCWeb() ServiceOption

+ func WithPreset(preset ProtocolPreset) ServiceOption

+ type ServiceRegistrar interface

+ RegisterMethods func(*Service) error

v0.7.1

Aug 12, 2025

v0.7.0

Aug 11, 2025

Changes in this version

+ func MustRegisterBidiStream[TIn, TOut any](s *Service, name string, handler BidiStreamHandler[TIn, TOut])

+ func MustRegisterClientStream[TIn, TOut any](s *Service, name string, handler ClientStreamHandler[TIn, TOut])

+ func RegisterBidiStream[TIn, TOut any](s *Service, name string, handler BidiStreamHandler[TIn, TOut]) error

+ func RegisterClientStream[TIn, TOut any](s *Service, name string, handler ClientStreamHandler[TIn, TOut]) error

+ type StreamProtocol interface

+ FormatError func(err *Error) []byte

+ ParseError func(data []byte) *Error

+ ReadFrame func(r io.Reader, maxMessageSize int) ([]byte, bool, bool, error)

+ SetResponseHeaders func(h http.Header, compressed bool, compressionType string)

+ SetStreamHeaders func(h http.Header, contentType, compressionType string)

+ SupportsTrailers func() bool

+ WriteEndOfStream func(w io.Writer) error

+ WriteFrame func(w io.Writer, data []byte, compressed bool) error

v0.6.1

Aug 10, 2025

Changes in this version

+ func NewHandler(services ...*Service) (http.Handler, error)

v0.6.0

Aug 10, 2025

Changes in this version

+ const DefaultJSONRPCBatchLimit

+ const DefaultJSONRPCPath

+ type ConnectOption func(*connectProtocol)

+ func WithConnectJSON(allow bool) ConnectOption

+ func WithConnectProto(allow bool) ConnectOption

+ type ConnectSettings struct

+ AllowJSON bool

+ AllowProto bool

+ type GRPCOption func(*grpcProtocol)

+ func WithGRPCReflection(enable bool) GRPCOption

+ type GRPCSettings struct

+ EnableReflection bool

+ type GRPCWebSettings struct

+ type JSONRPCOption func(*jsonrpcProtocol)

+ func WithBatchLimit(limit int) JSONRPCOption

+ type JSONRPCSettings struct

+ BatchLimit int

+ Path string

+ type Protocol interface

+ Config func() ProtocolConfig

+ Name func() string

+ func Connect(opts ...ConnectOption) Protocol

+ func Defaults() []Protocol

+ func GRPC(opts ...GRPCOption) Protocol

+ func GRPCWeb() Protocol

+ func JSONRPC(path string, opts ...JSONRPCOption) Protocol

+ func WithDefaults(additional ...Protocol) []Protocol

+ type ProtocolConfig struct

+ Enabled bool

+ Name string

+ Settings interface{}

type ServiceOption

+ func WithProtocols(protocols ...Protocol) ServiceOption

+ func WithoutConnect() ServiceOption

+ func WithoutGRPC() ServiceOption

+ func WithoutGRPCWeb() ServiceOption

type ServiceOptions

+ EnabledProtocols map[string]ProtocolConfig

v0.5.0

Aug 10, 2025

Changes in this version

+ const CompressionBrotli

+ const CompressionZstd

+ const DefaultMaxReceiveMessageSize

+ const DefaultMaxSendMessageSize

+ type BrotliCompressor struct

+ func (b *BrotliCompressor) Compress(data []byte) ([]byte, error)

+ func (b *BrotliCompressor) Decompress(data []byte) ([]byte, error)

+ func (b *BrotliCompressor) Name() string

type Service

+ func (s *Service) ExportAllProtosWithOptions(options ...hyperproto.ExportOption) (map[string]string, error)

+ func (s *Service) ExportProtoWithOptions(options ...hyperproto.ExportOption) (string, error)

type ServiceOption

+ func WithMaxReceiveMessageSize(size int) ServiceOption

+ func WithMaxSendMessageSize(size int) ServiceOption

type ServiceOptions

+ MaxReceiveMessageSize int

+ MaxSendMessageSize int

+ type ZstdCompressor struct

+ func NewZstdCompressor() (*ZstdCompressor, error)

+ func (z *ZstdCompressor) Compress(data []byte) ([]byte, error)

+ func (z *ZstdCompressor) Decompress(data []byte) ([]byte, error)

+ func (z *ZstdCompressor) Name() string

v0.4.0

Aug 3, 2025

Changes in this version

+ const JSONRPCInternalError

+ const JSONRPCInvalidParams

+ const JSONRPCInvalidRequest

+ const JSONRPCMethodNotFound

+ const JSONRPCParseError

+ const JSONRPCServerError

+ func IsBatchRequest(data []byte) bool

+ type JSONRPCError struct

+ Code int

+ Data interface{}

+ Message string

+ func NewJSONRPCError(err *Error) *JSONRPCError

+ type JSONRPCRequest struct

+ ID interface{}

+ JSONRPC string

+ Method string

+ Params json.RawMessage

+ func (r *JSONRPCRequest) IsNotification() bool

+ type JSONRPCResponse struct

+ Error *JSONRPCError

+ ID interface{}

+ JSONRPC string

+ Result json.RawMessage

type Service

+ func (s *Service) EnableJSONRPC(path string)

+ func (s *Service) JSONRPCHandler() http.Handler

type ServiceOption

+ func WithJSONRPC(path string) ServiceOption

+ func WithJSONRPCBatchLimit(limit int) ServiceOption

type ServiceOptions

+ EnableJSONRPC bool

+ JSONRPCBatchLimit int

+ JSONRPCPath string

v0.3.2

Aug 3, 2025

v0.3.1

Aug 2, 2025

v0.3.0

Jul 29, 2025

Changes in this version

+ func GetHandlerContext(ctx context.Context) *handlerContext

+ func MustRegisterServerStream[TIn, TOut any](svc *Service, name string, handler ServerStreamHandler[TIn, TOut])

+ func RegisterServerStream[TIn, TOut any](svc *Service, name string, handler ServerStreamHandler[TIn, TOut]) error

+ type BidiStream interface

+ Context func() context.Context

+ Recv func() (*TIn, error)

+ Send func(*TOut) error

+ type BidiStreamHandler func(context.Context, BidiStream[TIn, TOut]) error

+ type ClientStream interface

+ Context func() context.Context

+ Recv func() (*T, error)

+ type ClientStreamHandler func(context.Context, ClientStream[TIn]) (*TOut, error)

+ type ErrorDetail struct

+ Type string

+ Value any

+ type ErrorWithDetails struct

+ func NewErrorWithDetails(code Code, message string, details ...*ErrorDetail) *ErrorWithDetails

+ func (e *ErrorWithDetails) AddAnyDetail(msg proto.Message) *ErrorWithDetails

+ func (e *ErrorWithDetails) AddDetail(detail *ErrorDetail) *ErrorWithDetails

+ func (e *ErrorWithDetails) Code() Code

+ func (e *ErrorWithDetails) Error() string

+ func (e *ErrorWithDetails) FormatForProtocol(protocol string) any

+ func (e *ErrorWithDetails) GetDetails() []*ErrorDetail

+ func (e *ErrorWithDetails) Message() string

+ func (e *ErrorWithDetails) ToError(protocol string) *Error

type Method

+ ProtoInput proto.Message

+ ProtoOutput proto.Message

+ StreamType StreamType

type MethodBuilder

+ func NewBidiStreamMethod[TIn, TOut any](name string, handler BidiStreamHandler[TIn, TOut]) *MethodBuilder

+ func NewClientStreamMethod[TIn, TOut any](name string, handler ClientStreamHandler[TIn, TOut]) *MethodBuilder

+ func NewServerStreamMethod[TIn, TOut any](name string, handler ServerStreamHandler[TIn, TOut]) *MethodBuilder

+ type ServerStream interface

+ Context func() context.Context

+ Send func(*T) error

+ type ServerStreamHandler func(context.Context, *TIn, ServerStream[TOut]) error

type Service

+ func (s *Service) RegisterStreamingMethod(method *Method) error

+ type StreamType int

+ const StreamTypeBidiStream

+ const StreamTypeClientStream

+ const StreamTypeServerStream

+ const StreamTypeUnary

v0.2.0

Jul 24, 2025

v0.1.2

Jul 23, 2025

v0.1.1

Jul 23, 2025

Changes in this version

+ func MustRegisterMethod(svc *Service, methods ...*MethodBuilder)

+ func RegisterMethod(svc *Service, methods ...*MethodBuilder) error

v0.1.0

Jul 22, 2025

Changes in this version

+ const CompressionGzip

+ const CompressionIdentity

+ func ClearHandlerCache()

+ func MustRegister(svc *Service, methods ...*MethodBuilder)

+ func MustRegisterTyped[TIn, TOut any](svc *Service, name string, handler Handler[TIn, TOut])

+ func NewGateway(services ...*Service) (http.Handler, error)

+ func RegisterCompressor(c Compressor)

+ func Register[TIn, TOut any](svc *Service, name string, handler Handler[TIn, TOut]) error

+ func ValidateRetryPolicy(policy *RetryPolicy) error

+ func ValidateRetryThrottling(throttling *RetryThrottling) error

+ type Code string

+ const CodeAborted

+ const CodeAlreadyExists

+ const CodeCanceled

+ const CodeDataLoss

+ const CodeDeadlineExceeded

+ const CodeFailedPrecondition

+ const CodeInternal

+ const CodeInvalidArgument

+ const CodeNotFound

+ const CodeOutOfRange

+ const CodePermissionDenied

+ const CodeResourceExhausted

+ const CodeUnauthenticated

+ const CodeUnavailable

+ const CodeUnimplemented

+ const CodeUnknown

+ func (c Code) HTTPStatusCode() int

+ type Compressor interface

+ Compress func(data []byte) ([]byte, error)

+ Decompress func(data []byte) ([]byte, error)

+ Name func() string

+ func GetCompressor(name string) (Compressor, bool)

+ type Error struct

+ Code Code

+ Details map[string]any

+ Message string

+ func ErrDeadlineExceeded(message string) *Error

+ func ErrInternal(message string) *Error

+ func ErrInvalidArgument(message string) *Error

+ func ErrNotFound(message string) *Error

+ func ErrPermissionDenied(message string) *Error

+ func ErrUnauthenticated(message string) *Error

+ func ErrUnimplemented(message string) *Error

+ func NewError(code Code, message string) *Error

+ func NewErrorf(code Code, format string, args ...any) *Error

+ func (e *Error) Error() string

+ func (e *Error) WithDetails(details map[string]any) *Error

+ type GzipCompressor struct

+ func (g *GzipCompressor) Compress(data []byte) ([]byte, error)

+ func (g *GzipCompressor) Decompress(data []byte) ([]byte, error)

+ func (g *GzipCompressor) Name() string

+ type Handler func(context.Context, *TIn) (*TOut, error)

+ type HandlerCache struct

+ type HandlerFunc func(context.Context, any) (any, error)

+ type HandlerInfo struct

+ HandlerType reflect.Type

+ HandlerValue reflect.Value

+ InputType reflect.Type

+ IsPointer bool

+ OutputType reflect.Type

+ func GetHandlerInfo(handler any) (*HandlerInfo, error)

+ type Interceptor interface

+ Intercept func(ctx context.Context, method string, req any, ...) (any, error)

+ func ChainInterceptors(interceptors ...Interceptor) Interceptor

+ type LoggingInterceptor struct

+ Logger *log.Logger

+ func (l *LoggingInterceptor) Intercept(ctx context.Context, method string, req any, ...) (any, error)

+ type Method struct

+ Handler any

+ InputType reflect.Type

+ Name string

+ Options MethodOptions

+ OutputType reflect.Type

+ type MethodBuilder struct

+ func NewMethod[TIn, TOut any](name string, handler Handler[TIn, TOut]) *MethodBuilder

+ func (m *MethodBuilder) Build() *Method

+ func (m *MethodBuilder) In(example any) *MethodBuilder

+ func (m *MethodBuilder) Out(example any) *MethodBuilder

+ func (m *MethodBuilder) Validate(enabled bool) *MethodBuilder

+ func (m *MethodBuilder) WithDescription(description string) *MethodBuilder

+ func (m *MethodBuilder) WithInterceptors(interceptors ...Interceptor) *MethodBuilder

+ type MethodConfig struct

+ Name []MethodName

+ RetryPolicy *RetryPolicy

+ Timeout string

+ type MethodName struct

+ Method string

+ Service string

+ type MethodOptions struct

+ Description string

+ Interceptors []Interceptor

+ Validate *bool

+ type MetricsInterceptor struct

+ FailureCount int64

+ RequestCount int64

+ SuccessCount int64

+ TotalDuration time.Duration

+ func (m *MetricsInterceptor) Intercept(ctx context.Context, method string, req any, ...) (any, error)

+ type RecoveryInterceptor struct

+ func (r *RecoveryInterceptor) Intercept(ctx context.Context, method string, req any, ...) (resp any, err error)

+ type RetryInterceptor struct

+ func DefaultRetryInterceptor() *RetryInterceptor

+ func NewRetryInterceptor(config *ServiceConfig) *RetryInterceptor

+ func (r *RetryInterceptor) Intercept(ctx context.Context, method string, req any, ...) (any, error)

+ type RetryPolicy struct

+ BackoffMultiplier float64

+ InitialBackoff string

+ MaxAttempts int

+ MaxBackoff string

+ RetryableStatusCodes []string

+ func AggressiveRetryPolicy() *RetryPolicy

+ func DefaultRetryPolicy() *RetryPolicy

+ type RetryThrottling struct

+ MaxTokens int

+ TokenRatio float64

+ type Service struct

+ func NewService(name string, opts ...ServiceOption) *Service

+ func (s *Service) ExportAllProtos() (map[string]string, error)

+ func (s *Service) ExportProto() (string, error)

+ func (s *Service) GetFileDescriptorSet() *descriptorpb.FileDescriptorSet

+ func (s *Service) Handlers() map[string]http.Handler

+ func (s *Service) MustRegister(method *Method)

+ func (s *Service) Name() string

+ func (s *Service) PackageName() string

+ func (s *Service) Register(method *Method) error

+ type ServiceConfig struct

+ MethodConfig []MethodConfig

+ RetryThrottling *RetryThrottling

+ func ParseServiceConfig(jsonConfig string) (*ServiceConfig, error)

+ type ServiceOption func(*ServiceOptions)

+ func WithDescription(description string) ServiceOption

+ func WithEdition(edition string) ServiceOption

+ func WithInterceptors(interceptors ...Interceptor) ServiceOption

+ func WithPackage(pkg string) ServiceOption

+ func WithReflection(enabled bool) ServiceOption

+ func WithServiceConfig(jsonConfig string) ServiceOption

+ func WithValidation(enabled bool) ServiceOption

+ type ServiceOptions struct

+ Description string

+ Edition string

+ EnableReflection bool

+ EnableValidation bool

+ Interceptors []Interceptor

+ Package string

+ ServiceConfig string

+ UseEditions bool

+ type TimeoutInterceptor struct

+ Timeout time.Duration

+ func (t *TimeoutInterceptor) Intercept(ctx context.Context, method string, req any, ...) (any, error)

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