gorpc

package module

Go to main page

Versions in this module

v1

v1.0.0-rc.2

Jul 20, 2026

v1.0.0-rc.1

Jul 8, 2026

v0

v0.5.0

Jul 6, 2026

Changes in this version

+ func MustRegisterBidiStream[Recv, Send any](target any, function string, fn BidiStreamHandlerFunc[Recv, Send])

+ func MustRegisterClientStream[Item, Resp any](target any, function string, fn ClientStreamHandlerFunc[Item, Resp])

+ func MustRegisterServerStream[Req, Item any](target any, function string, fn ServerStreamHandlerFunc[Req, Item])

+ func RegisterBidiStream[Recv, Send any](target any, function string, fn BidiStreamHandlerFunc[Recv, Send]) error

+ func RegisterClientStream[Item, Resp any](target any, function string, fn ClientStreamHandlerFunc[Item, Resp]) error

+ func RegisterServerStream[Req, Item any](target any, function string, fn ServerStreamHandlerFunc[Req, Item]) error

+ type BidiStreamHandle struct

+ func BidiStream[Send, Recv any](ctx context.Context, target any, function string) (*BidiStreamHandle[Send, Recv], error)

+ func (s *BidiStreamHandle[Send, Recv]) Cancel() error

+ func (s *BidiStreamHandle[Send, Recv]) CloseSend() error

+ func (s *BidiStreamHandle[Send, Recv]) Recv() (Recv, error)

+ func (s *BidiStreamHandle[Send, Recv]) Send(item Send) error

+ func (s *BidiStreamHandle[Send, Recv]) Stream() *Stream

+ type BidiStreamHandlerFunc func(*Context, *BidiStreamHandle[Send, Recv]) error

+ type ClientStreamHandle struct

+ func ClientStream[Item, Resp any](ctx context.Context, target any, function string) (*ClientStreamHandle[Item, Resp], error)

+ func (s *ClientStreamHandle[Item, Resp]) Cancel() error

+ func (s *ClientStreamHandle[Item, Resp]) CloseAndRecv() (Resp, error)

+ func (s *ClientStreamHandle[Item, Resp]) Send(item Item) error

+ func (s *ClientStreamHandle[Item, Resp]) Stream() *Stream

+ type ClientStreamHandlerFunc func(*Context, *StreamReader[Item]) (Resp, error)

type Context

+ func (c *Context) IsStream() bool

+ func (c *Context) StreamKind() StreamKind

type Frame

+ StreamKind StreamKind

type FrameType

+ const FrameStreamStart

+ type ServerStreamHandlerFunc func(*Context, Req, *StreamWriter[Item]) error

+ type Stream struct

+ func (s *Stream) Cancel() error

+ func (s *Stream) CloseSend() error

+ func (s *Stream) Context() context.Context

+ func (s *Stream) Function() string

+ func (s *Stream) Recv(item any) error

+ func (s *Stream) RequestID() uint64

+ func (s *Stream) Send(item any) error

+ type StreamKind uint8

+ const StreamKindBidi

+ const StreamKindClient

+ const StreamKindServer

+ func (k StreamKind) String() string

+ type StreamReader struct

+ func ServerStream[Req, Item any](ctx context.Context, target any, function string, req Req) (*StreamReader[Item], error)

+ func (r *StreamReader[T]) Cancel() error

+ func (r *StreamReader[T]) Recv() (T, error)

+ func (r *StreamReader[T]) Stream() *Stream

+ type StreamWriter struct

+ func (w *StreamWriter[T]) Close() error

+ func (w *StreamWriter[T]) Send(item T) error

+ func (w *StreamWriter[T]) Stream() *Stream

v0.4.0

Jul 5, 2026

Changes in this version

+ func MustRegisterNotify[Req any](target any, function string, fn NotifyHandlerFunc[Req])

+ func Notify[Req any](ctx context.Context, client *Client, function string, req Req) error

+ func RegisterNotify[Req any](target any, function string, fn NotifyHandlerFunc[Req]) error

type Client

+ func (c *Client) Notify(function string, req any) error

+ func (c *Client) NotifyContext(ctx context.Context, function string, req any) error

+ func (c *Client) NotifyWithTimeout(function string, req any, timeout time.Duration) error

type Conn

+ func (c *Conn) Notify(function string, req any) error

+ func (c *Conn) NotifyContext(ctx context.Context, function string, req any) error

+ func (c *Conn) NotifyWithTimeout(function string, req any, timeout time.Duration) error

type Context

+ func (c *Context) IsNotify() bool

+ func (c *Context) Notify(function string, req any) error

+ func (c *Context) NotifyContext(ctx context.Context, function string, req any) error

+ func (c *Context) NotifyWithTimeout(function string, req any, timeout time.Duration) error

type FrameType

+ const FrameNotify

+ type NotifyFunc func(context.Context, Req) error

+ func Notification[Req any](client *Client, function string) NotifyFunc[Req]

+ type NotifyHandlerFunc func(*Context, Req) error

v0.3.0

Jul 5, 2026

Changes in this version

type Client

+ func NewClient(network, address string, opts ClientOptions) *Client

+ func NewTCPClient(address, clientName string, opts ...ClientOptions) *Client

+ func NewUnixClient(path, clientName string, opts ...ClientOptions) *Client

+ func NewUnixPacketClient(path, clientName string, opts ...ClientOptions) *Client

+ func (c *Client) Connect(ctx context.Context) error

+ type Conn struct

+ func (c *Conn) AsyncCall(function string, req any, handler any, correlationID string) error

+ func (c *Conn) AsyncCallContext(ctx context.Context, function string, req any, handler any, ...) error

+ func (c *Conn) AsyncCallWithTimeout(function string, req any, handler any, correlationID string, ...) error

+ func (c *Conn) Call(function string, req any, resp any) error

+ func (c *Conn) CallContext(ctx context.Context, function string, req any, resp any) error

+ func (c *Conn) CallWithTimeout(function string, req any, resp any, timeout time.Duration) error

+ func (c *Conn) ClientName() string

+ func (c *Conn) Close() error

+ func (c *Conn) LocalAddr() net.Addr

+ func (c *Conn) RemoteAddr() net.Addr

type Context

+ func (c *Context) Call(function string, req any, resp any) error

+ func (c *Context) CallContext(ctx context.Context, function string, req any, resp any) error

+ func (c *Context) CallWithTimeout(function string, req any, resp any, timeout time.Duration) error

+ func (c *Context) Conn() *Conn

type Server

+ func (s *Server) Connections() []*Conn

type ServerOptions

+ OnConnect func(*Conn)

+ OnDisconnect func(*Conn)

+ WriteTimeout time.Duration

v0.2.0

Jun 26, 2026

Changes in this version

+ const DefaultDialTimeout

+ const DefaultPingInterval

+ const DefaultPingTimeout

+ const DefaultReconnectJitter

+ const DefaultReconnectMaxDelay

+ const DefaultReconnectMinDelay

+ const DefaultWriteTimeout

+ const ErrorCodeUnauthorized

+ var ErrAuthentication = errors.New("gorpc: authentication failed")

+ var ErrDuplicateFunction = errors.New("gorpc: duplicate function")

+ var ErrInvalidFunction = errors.New("gorpc: invalid function")

+ var ErrInvalidHandler = errors.New("gorpc: invalid handler")

+ var ErrInvalidResponse = errors.New("gorpc: invalid response")

+ var ErrUnavailable = errors.New("gorpc: unavailable")

+ type Auth struct

+ func SharedSecret(secret string) Auth

type Client

+ func TCPDial(address, clientName string, opts ...ClientOptions) (*Client, error)

+ func UnixDial(path, clientName string, opts ...ClientOptions) (*Client, error)

+ func UnixPacketDial(path, clientName string, opts ...ClientOptions) (*Client, error)

+ func (c *Client) AsyncCall(function string, req any, handler any, correlationID string) error

+ func (c *Client) AsyncCallContext(ctx context.Context, function string, req any, handler any, ...) error

+ func (c *Client) AsyncCallWithTimeout(function string, req any, handler any, correlationID string, ...) error

+ func (c *Client) Call(function string, req any, resp any) error

+ func (c *Client) CallContext(ctx context.Context, function string, req any, resp any) error

+ func (c *Client) CallWithTimeout(function string, req any, resp any, timeout time.Duration) error

+ func (c *Client) WaitReady(ctx context.Context) error

+ type ClientContext interface

+ CorrelationID func() string

+ Error func() error

+ Function func() string

+ RequestID func() uint64

+ type ClientFunc func(context.Context, Req) (Resp, error)

+ func Function[Req, Resp any](client *Client, function string) ClientFunc[Req, Resp]

type ClientOptions

+ Auth Auth

+ DialTimeout time.Duration

+ PingInterval time.Duration

+ PingTimeout time.Duration

+ ReconnectJitter float64

+ ReconnectMaxDelay time.Duration

+ ReconnectMinDelay time.Duration

+ WriteTimeout time.Duration

+ type Context struct

+ func (c *Context) ClientName() string

+ func (c *Context) Function() string

+ func (c *Context) LocalAddr() net.Addr

+ func (c *Context) RemoteAddr() net.Addr

+ func (c *Context) RequestID() uint64

type Frame

+ Function string

type FrameType

+ const FrameAuth

+ const FrameAuthAck

type Server

+ func (s *Server) ServeListener(ln net.Listener) error

+ func (s *Server) ServeTCP(address string) error

+ func (s *Server) ServeUnix(path string) error

+ func (s *Server) ServeUnixPacket(path string) error

type ServerOptions

+ Auth Auth

v0.1.0

Jun 25, 2026

Changes in this version

+ const CodecMessagePack

+ const DefaultHandshakeTimeout

+ const DefaultMaxFrameSize

+ const ErrorCodeCanceled

+ const ErrorCodeDeadlineExceeded

+ const ErrorCodeInternal

+ const ErrorCodeInvalidRequest

+ const ErrorCodeNotFound

+ const ErrorCodeUnavailable

+ const ProtocolVersion

+ var ErrClosed = errors.New("gorpc: closed")

+ var ErrDuplicateRoute = errors.New("gorpc: duplicate route")

+ var ErrFrameTooLarge = errors.New("gorpc: frame too large")

+ var ErrInvalidRoute = errors.New("gorpc: invalid route")

+ var ErrProtocol = errors.New("gorpc: protocol error")

+ func Call[Req, Resp any](ctx context.Context, client *Client, service, method string, req Req) (Resp, error)

+ func MustRegister[Req, Resp any](s *Server, service, method string, fn HandlerFunc[Req, Resp])

+ func Register[Req, Resp any](s *Server, service, method string, fn HandlerFunc[Req, Resp]) error

+ type Client struct

+ func Dial(ctx context.Context, network, address string, opts ClientOptions) (*Client, error)

+ func (c *Client) Close() error

+ func (c *Client) RemoteService() string

+ type ClientOptions struct

+ ClientName string

+ Codec Codec

+ Dialer *net.Dialer

+ ExpectedServiceName string

+ HandshakeTimeout time.Duration

+ Logger *slog.Logger

+ MaxFrameSize int64

+ type Codec interface

+ Marshal func(v any) ([]byte, error)

+ Name func() string

+ Unmarshal func(data []byte, v any) error

+ type Frame struct

+ DeadlineUnixNano int64

+ Method string

+ Payload []byte

+ RequestID uint64

+ Service string

+ Type FrameType

+ Version uint16

+ type FrameType uint8

+ const FrameCancel

+ const FrameError

+ const FrameHello

+ const FrameHelloAck

+ const FramePing

+ const FramePong

+ const FrameRequest

+ const FrameResponse

+ const FrameStreamEnd

+ const FrameStreamItem

+ func (t FrameType) String() string

+ type HandlerFunc func(context.Context, Req) (Resp, error)

+ func Method[Req, Resp any](client *Client, service, method string) HandlerFunc[Req, Resp]

+ type MessagePackCodec struct

+ func (MessagePackCodec) Marshal(v any) ([]byte, error)

+ func (MessagePackCodec) Name() string

+ func (MessagePackCodec) Unmarshal(data []byte, v any) error

+ type RemoteError struct

+ Code string

+ Details map[string]any

+ Message string

+ func NewRemoteError(code, message string, details map[string]any) *RemoteError

+ func (e *RemoteError) Error() string

+ type Server struct

+ func NewServer(opts ServerOptions) *Server

+ func (s *Server) ListenAndServe(ctx context.Context, network, address string) error

+ func (s *Server) Serve(ctx context.Context, ln net.Listener) error

+ func (s *Server) Shutdown(ctx context.Context) error

+ type ServerOptions struct

+ Codec Codec

+ HandshakeTimeout time.Duration

+ Logger *slog.Logger

+ MaxFrameSize int64

+ ServiceName string

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