Codebase list golang-github-go-kit-kit / 9a1a7ad transport / http / jsonrpc / request_response_types.go
9a1a7ad

Tree @9a1a7ad (Download .tar.gz)

request_response_types.go @9a1a7adraw · history · blame

package jsonrpc

import (
	"context"
	"encoding/json"
	"net/http"
)

// Request defines a JSON RPC request from the spec
// http://www.jsonrpc.org/specification#request_object
type Request struct {
	JSONRPC string          `json:"jsonrpc"`
	Method  string          `json:"method"`
	Params  json.RawMessage `json:"params"`
	ID      *RequestID      `json:"id"`
}

// RequestID defines a request ID that can be string, number, or null.
// An identifier established by the Client that MUST contain a String,
// Number, or NULL value if included.
// If it is not included it is assumed to be a notification.
// The value SHOULD normally not be Null and
// Numbers SHOULD NOT contain fractional parts.
type RequestID struct {
	intValue    int
	intError    error
	floatValue  float32
	floatError  error
	stringValue string
	stringError error
}

// RequestFunc may take information from decoded json body and place in
// request context. In Servers, RequestFuncs are executed after json is parsed
// but prior to invoking the codec
type RequestFunc func(context.Context, *http.Request, Request) context.Context

// UnmarshalJSON satisfies json.Unmarshaler
func (id *RequestID) UnmarshalJSON(b []byte) error {
	id.intError = json.Unmarshal(b, &id.intValue)
	id.floatError = json.Unmarshal(b, &id.floatValue)
	id.stringError = json.Unmarshal(b, &id.stringValue)

	return nil
}

func (id *RequestID) MarshalJSON() ([]byte, error) {
	if id.intError == nil {
		return json.Marshal(id.intValue)
	} else if id.floatError == nil {
		return json.Marshal(id.floatValue)
	} else {
		return json.Marshal(id.stringValue)
	}
}

// Int returns the ID as an integer value.
// An error is returned if the ID can't be treated as an int.
func (id *RequestID) Int() (int, error) {
	return id.intValue, id.intError
}

// Float32 returns the ID as a float value.
// An error is returned if the ID can't be treated as an float.
func (id *RequestID) Float32() (float32, error) {
	return id.floatValue, id.floatError
}

// String returns the ID as a string value.
// An error is returned if the ID can't be treated as an string.
func (id *RequestID) String() (string, error) {
	return id.stringValue, id.stringError
}

// Response defines a JSON RPC response from the spec
// http://www.jsonrpc.org/specification#response_object
type Response struct {
	JSONRPC string          `json:"jsonrpc"`
	Result  json.RawMessage `json:"result,omitempty"`
	Error   *Error          `json:"error,omitempty"`
	ID      *RequestID      `json:"id"`
}

const (
	// Version defines the version of the JSON RPC implementation
	Version string = "2.0"

	// ContentType defines the content type to be served.
	ContentType string = "application/json; charset=utf-8"
)

type contextKey int

const (
	ContextKeyRequestMethod contextKey = iota
)