hooks

Documentation

Overview

Package hooks implements a gRPC middleware that executes service and method hooks.

Register a hook for all methods in a service with filter /package.service or a specific method with filter /package.service/method. Registering a hook overwrites existing hooks with the same filter and name.

Hooks are executed in order of registration. Service hooks are executed before service method hooks.

Index

• type Hooks
  • func (h *Hooks) RegisterStreamHook(filter, name string, f StreamHandlerMiddleware)
  • func (h *Hooks) RegisterUnaryHook(filter, name string, f UnaryHandlerMiddleware)
  • func (h *Hooks) StreamServerInterceptor() grpc.StreamServerInterceptor
  • func (h *Hooks) UnaryServerInterceptor() grpc.UnaryServerInterceptor
  • func (h *Hooks) UnregisterStreamHook(filter, name string) bool
  • func (h *Hooks) UnregisterUnaryHook(filter, name string) bool
• type StreamHandlerMiddleware
• type UnaryHandlerMiddleware

Types

type Hooks

type Hooks struct {
	// contains filtered or unexported fields
}

func (*Hooks) RegisterStreamHook

func (h *Hooks) RegisterStreamHook(filter, name string, f StreamHandlerMiddleware)

func (*Hooks) RegisterUnaryHook

func (h *Hooks) RegisterUnaryHook(filter, name string, f UnaryHandlerMiddleware)

func (*Hooks) StreamServerInterceptor

func (h *Hooks) StreamServerInterceptor() grpc.StreamServerInterceptor

StreamServerInterceptor returns a new stream server interceptor that executes registered hooks.

func (*Hooks) UnaryServerInterceptor

func (h *Hooks) UnaryServerInterceptor() grpc.UnaryServerInterceptor

UnaryServerInterceptor returns a new unary server interceptor that executes registered hooks.

func (*Hooks) UnregisterStreamHook

func (h *Hooks) UnregisterStreamHook(filter, name string) bool

func (*Hooks) UnregisterUnaryHook

func (h *Hooks) UnregisterUnaryHook(filter, name string) bool

type StreamHandlerMiddleware

type StreamHandlerMiddleware func(grpc.StreamHandler) grpc.StreamHandler

StreamHandlerMiddleware wraps grpc.StreamHandler.

type UnaryHandlerMiddleware

type UnaryHandlerMiddleware func(grpc.UnaryHandler) grpc.UnaryHandler

UnaryHandlerMiddleware wraps grpc.UnaryHandler.