• Felix Lange's avatar
    rpc: implement full bi-directional communication (#18471) · 245f3146
    Felix Lange authored
    New APIs added:
    
        client.RegisterName(namespace, service) // makes service available to server
        client.Notify(ctx, method, args...)     // sends a notification
        ClientFromContext(ctx)                  // to get a client in handler method
    
    This is essentially a rewrite of the server-side code. JSON-RPC
    processing code is now the same on both server and client side. Many
    minor issues were fixed in the process and there is a new test suite for
    JSON-RPC spec compliance (and non-compliance in some cases).
    
    List of behavior changes:
    
    - Method handlers are now called with a per-request context instead of a
      per-connection context. The context is canceled right after the method
      returns.
    - Subscription error channels are always closed when the connection
      ends. There is no need to also wait on the Notifier's Closed channel
      to detect whether the subscription has ended.
    - Client now omits "params" instead of sending "params": null when there
      are no arguments to a call. The previous behavior was not compliant
      with the spec. The server still accepts "params": null.
    - Floating point numbers are allowed as "id". The spec doesn't allow
      them, but we handle request "id" as json.RawMessage and guarantee that
      the same number will be sent back.
    - Logging is improved significantly. There is now a message at DEBUG
      level for each RPC call served.
    Unverified
    245f3146
errors.go 2.22 KB
// Copyright 2015 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package rpc

import "fmt"

const defaultErrorCode = -32000

type methodNotFoundError struct{ method string }

func (e *methodNotFoundError) ErrorCode() int { return -32601 }

func (e *methodNotFoundError) Error() string {
	return fmt.Sprintf("the method %s does not exist/is not available", e.method)
}

type subscriptionNotFoundError struct{ namespace, subscription string }

func (e *subscriptionNotFoundError) ErrorCode() int { return -32601 }

func (e *subscriptionNotFoundError) Error() string {
	return fmt.Sprintf("no %q subscription in %s namespace", e.subscription, e.namespace)
}

// Invalid JSON was received by the server.
type parseError struct{ message string }

func (e *parseError) ErrorCode() int { return -32700 }

func (e *parseError) Error() string { return e.message }

// received message isn't a valid request
type invalidRequestError struct{ message string }

func (e *invalidRequestError) ErrorCode() int { return -32600 }

func (e *invalidRequestError) Error() string { return e.message }

// received message is invalid
type invalidMessageError struct{ message string }

func (e *invalidMessageError) ErrorCode() int { return -32700 }

func (e *invalidMessageError) Error() string { return e.message }

// unable to decode supplied params, or an invalid number of parameters
type invalidParamsError struct{ message string }

func (e *invalidParamsError) ErrorCode() int { return -32602 }

func (e *invalidParamsError) Error() string { return e.message }