http

Documentation

Index

• Variables
• func HttpHandler(h jsonrpc.Handler) http.Handler
• func JrpcToHttp(h jsonrpc.Handler) http.Handler
• func NewCodec(w http.ResponseWriter, r *http.Request) (jsonrpc.ReaderWriter, error)
• func ServerMaker() (jsonrpc.Handler, jrpctest.ClientMaker, func())
• type Client
  • func Dial(ctx context.Context, client *http.Client, target string) (*Client, error)
  • func DialH2C(target string) (*Client, error)
  • func DialHTTP(target string) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) Closed() <-chan struct{}
  • func (c *Client) Do(ctx context.Context, result any, method string, params any) error
  • func (c *Client) Mount(h jsonrpc.Middleware)
  • func (c *Client) Notify(ctx context.Context, method string, params any) error
  • func (c *Client) SetHeader(key string, value string)
• type HttpCodec
  • func NewGetCodec(w http.ResponseWriter, r *http.Request) *HttpCodec
  • func NewPostCodec(w http.ResponseWriter, r *http.Request) (*HttpCodec, error)
  • func (c *HttpCodec) Close() error
  • func (c *HttpCodec) Closed() <-chan struct{}
  • func (c *HttpCodec) Flush() error
  • func (c *HttpCodec) PeerInfo() jsonrpc.PeerInfo
  • func (c *HttpCodec) ReadBatch(ctx context.Context) ([]*jsonrpc.Message, bool, error)
  • func (c *HttpCodec) RemoteAddr() string
  • func (c *HttpCodec) Write(p []byte) (n int, err error)
• type SseCodec
  • func NewSseCodec(w http.ResponseWriter, r *http.Request) (*SseCodec, error)
  • func (c *SseCodec) Close() error
  • func (c *SseCodec) Closed() <-chan struct{}
  • func (c *SseCodec) Flush() error
  • func (c *SseCodec) PeerInfo() jsonrpc.PeerInfo
  • func (c *SseCodec) ReadBatch(ctx context.Context) ([]*jsonrpc.Message, bool, error)
  • func (c *SseCodec) RemoteAddr() string
  • func (c *SseCodec) Write(p []byte) (n int, err error)

Variables

var (
	ErrClientQuit                = errors.New("client is closed")
	ErrNoResult                  = errors.New("no result in JSON-RPC response")
	ErrSubscriptionQueueOverflow = errors.New("subscription queue overflow")
)

var DefaultH2CClient = &http.Client{
	Transport: &http2.Transport{

		AllowHTTP: true,

		DialTLSContext: func(ctx context.Context, network, addr string, cfg *tls.Config) (net.Conn, error) {
			var d net.Dialer
			return d.DialContext(ctx, network, addr)
		},
	},
}

var ErrInvalidContentType = errors.New("invalid content type")

Functions

func HttpHandler

func HttpHandler(h jsonrpc.Handler) http.Handler

func JrpcToHttp

func JrpcToHttp(h jsonrpc.Handler) http.Handler

func NewCodec

func NewCodec(w http.ResponseWriter, r *http.Request) (jsonrpc.ReaderWriter, error)

func ServerMaker

func ServerMaker() (jsonrpc.Handler, jrpctest.ClientMaker, func())

Types

type Client

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

Client represents a connection to an RPC server.

func Dial

func Dial(ctx context.Context, client *http.Client, target string) (*Client, error)

func DialH2C

func DialH2C(target string) (*Client, error)

func DialHTTP

func DialHTTP(target string) (*Client, error)

func (*Client) Close

func (c *Client) Close() error

func (*Client) Closed

func (c *Client) Closed() <-chan struct{}

func (*Client) Do

func (c *Client) Do(ctx context.Context, result any, method string, params any) error

func (*Client) Mount

func (c *Client) Mount(h jsonrpc.Middleware)

func (*Client) Notify

func (c *Client) Notify(ctx context.Context, method string, params any) error

func (*Client) SetHeader

func (c *Client) SetHeader(key string, value string)

type HttpCodec

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

func NewGetCodec

func NewGetCodec(w http.ResponseWriter, r *http.Request) *HttpCodec

func NewPostCodec

func NewPostCodec(w http.ResponseWriter, r *http.Request) (*HttpCodec, error)

func (*HttpCodec) Close

func (c *HttpCodec) Close() error

func (*HttpCodec) Closed

func (c *HttpCodec) Closed() <-chan struct{}

Closed returns a channel which is closed when the connection is closed.

func (*HttpCodec) Flush

func (c *HttpCodec) Flush() error

func (*HttpCodec) PeerInfo

func (c *HttpCodec) PeerInfo() jsonrpc.PeerInfo

gets the peer info

func (*HttpCodec) ReadBatch

func (c *HttpCodec) ReadBatch(ctx context.Context) ([]*jsonrpc.Message, bool, error)

func (*HttpCodec) RemoteAddr

func (c *HttpCodec) RemoteAddr() string

RemoteAddr returns the peer address of the connection.

func (*HttpCodec) Write

func (c *HttpCodec) Write(p []byte) (n int, err error)

closes the connection

type SseCodec

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

SseCodec is used for subscriptions over http. note that every message is buffered multiple times - it's a bit inefficient. if you need more efficient streaming of large blobs, consider using a different interface

func NewSseCodec

func NewSseCodec(w http.ResponseWriter, r *http.Request) (*SseCodec, error)

func (*SseCodec) Close

func (c *SseCodec) Close() error

func (*SseCodec) Closed

func (c *SseCodec) Closed() <-chan struct{}

Closed returns a channel which is closed when the connection is closed.

func (*SseCodec) Flush

func (c *SseCodec) Flush() error

func (*SseCodec) PeerInfo

func (c *SseCodec) PeerInfo() jsonrpc.PeerInfo

gets the peer info

func (*SseCodec) ReadBatch

func (c *SseCodec) ReadBatch(ctx context.Context) ([]*jsonrpc.Message, bool, error)

func (*SseCodec) RemoteAddr

func (c *SseCodec) RemoteAddr() string

RemoteAddr returns the peer address of the connection.

func (*SseCodec) Write

func (c *SseCodec) Write(p []byte) (n int, err error)

closes the connection