75 lines
2.7 KiB
Go
75 lines
2.7 KiB
Go
package jrpc2
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
|
|
"github.com/creachadair/jrpc2/metrics"
|
|
)
|
|
|
|
// ServerMetrics returns the server metrics collector associated with the given
|
|
// context, or nil if ctx does not have a collector attached. The context
|
|
// passed to a handler by *jrpc2.Server will include this value.
|
|
func ServerMetrics(ctx context.Context) *metrics.M {
|
|
return ctx.Value(serverKey{}).(*Server).metrics
|
|
}
|
|
|
|
// InboundRequest returns the inbound request associated with the given
|
|
// context, or nil if ctx does not have an inbound request. The context passed
|
|
// to the handler by *jrpc2.Server will include this value.
|
|
//
|
|
// This is mainly useful to wrapped server methods that do not have the request
|
|
// as an explicit parameter; for direct implementations of Handler.Handle the
|
|
// request value returned by InboundRequest will be the same value as was
|
|
// passed explicitly.
|
|
func InboundRequest(ctx context.Context) *Request {
|
|
if v := ctx.Value(inboundRequestKey{}); v != nil {
|
|
return v.(*Request)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
type inboundRequestKey struct{}
|
|
|
|
// PushNotify posts a server notification to the client. If ctx does not
|
|
// contain a server notifier, this reports ErrPushUnsupported. The context
|
|
// passed to the handler by *jrpc2.Server will support notifications if the
|
|
// server was constructed with the AllowPush option set true.
|
|
func PushNotify(ctx context.Context, method string, params interface{}) error {
|
|
s := ctx.Value(serverKey{}).(*Server)
|
|
if !s.allowP {
|
|
return ErrPushUnsupported
|
|
}
|
|
return s.Notify(ctx, method, params)
|
|
}
|
|
|
|
// PushCall posts a server call to the client. If ctx does not contain a server
|
|
// caller, this reports ErrPushUnsupported. The context passed to the handler
|
|
// by *jrpc2.Server will support callbacks if the server was constructed with
|
|
// the AllowPush option set true.
|
|
//
|
|
// A successful callback reports a nil error and a non-nil response. Errors
|
|
// returned by the client have concrete type *jrpc2.Error.
|
|
func PushCall(ctx context.Context, method string, params interface{}) (*Response, error) {
|
|
s := ctx.Value(serverKey{}).(*Server)
|
|
if !s.allowP {
|
|
return nil, ErrPushUnsupported
|
|
}
|
|
return s.Callback(ctx, method, params)
|
|
}
|
|
|
|
// CancelRequest requests the server associated with ctx to cancel the pending
|
|
// or in-flight request with the specified ID. If no request exists with that
|
|
// ID, this is a no-op without error.
|
|
func CancelRequest(ctx context.Context, id string) {
|
|
s := ctx.Value(serverKey{}).(*Server)
|
|
s.cancelRequests(ctx, []json.RawMessage{json.RawMessage(id)})
|
|
}
|
|
|
|
type serverKey struct{}
|
|
|
|
// ErrPushUnsupported is returned by PushNotify and PushCall if server pushes
|
|
// are not enabled in the specified context.
|
|
var ErrPushUnsupported = errors.New("server push is not enabled")
|