Class: OpenC3::JsonRpcErrorResponse

Inherits:

JsonRpcResponse

• Object
• JsonRpc
• JsonRpcResponse
• OpenC3::JsonRpcErrorResponse

Defined in:

lib/openc3/io/json_rpc.rb

Overview

Represents a JSON Remote Procedure Call Error Response

Class Method Summary

• .from_hash(hash) ⇒ JsonRpcErrorResponse

  Creates a JsonRpcErrorResponse object from a Hash.

Instance Method Summary

• #error ⇒ JsonRpcError

  The error object.

• #initialize(error, id) ⇒ JsonRpcErrorResponse constructor

  A new instance of JsonRpcErrorResponse.

Methods inherited from JsonRpcResponse

from_json

Methods inherited from JsonRpc

#<=>, #as_json, #to_json

Constructor Details

#initialize(error, id) ⇒ JsonRpcErrorResponse

Returns a new instance of JsonRpcErrorResponse.

Parameters:

• error (JsonRpcError) —

  The error object

• id (Integer) —

  The identifier which will be matched to the request

# File 'lib/openc3/io/json_rpc.rb', line 358

def initialize(error, id)
  super(id)
  @hash['error'.freeze] = error
end

Class Method Details

.from_hash(hash) ⇒ JsonRpcErrorResponse

Creates a JsonRpcErrorResponse object from a Hash

Parameters:

• hash (Hash) —

  Hash containing the following keys: error and id

Returns:

• (JsonRpcErrorResponse)

# File 'lib/openc3/io/json_rpc.rb', line 372

def self.from_hash(hash)
  self.new(JsonRpcError.from_hash(hash['error'.freeze]), hash['id'.freeze])
end

Instance Method Details

#error ⇒ JsonRpcError

Returns The error object.

Returns:

• (JsonRpcError) —

  The error object

# File 'lib/openc3/io/json_rpc.rb', line 364

def error
  @hash['error'.freeze]
end