Class: OpenC3::JsonRpcSuccessResponse

Inherits:

JsonRpcResponse

• Object
• JsonRpc
• JsonRpcResponse
• OpenC3::JsonRpcSuccessResponse

Defined in:

lib/openc3/io/json_rpc.rb

Overview

Represents a JSON Remote Procedure Call Success Response

Class Method Summary

• .from_hash(hash) ⇒ JsonRpcSuccessResponse

  Creates a JsonRpcSuccessResponse object from a Hash.

Instance Method Summary

• #initialize(result, id) ⇒ JsonRpcSuccessResponse constructor

  A new instance of JsonRpcSuccessResponse.

• #result ⇒ Object

  The result of the method request.

Methods inherited from JsonRpcResponse

from_json

Methods inherited from JsonRpc

#<=>, #as_json, #to_json

Constructor Details

#initialize(result, id) ⇒ JsonRpcSuccessResponse

Returns a new instance of JsonRpcSuccessResponse.

Parameters:

• id (Integer) —

  The identifier which will be matched to the request

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

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

Class Method Details

.from_hash(hash) ⇒ JsonRpcSuccessResponse

Creates a JsonRpcSuccessResponse object from a Hash

Parameters:

• hash (Hash) —

  Hash containing the following keys: result and id

Returns:

• (JsonRpcSuccessResponse)

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

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

Instance Method Details

#result ⇒ Object

Returns The result of the method request.

Returns:

• (Object) —

  The result of the method request

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

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