Class: OpenC3::JsonRpc

Inherits:
Object show all
Includes:
Comparable
Defined in:
lib/openc3/io/json_rpc.rb

Overview

Base class for all JSON Remote Procedure Calls. Provides basic comparison and Hash to JSON conversions.

Direct Known Subclasses

JsonRpcError, JsonRpcRequest, JsonRpcResponse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ JsonRpc

Returns a new instance of JsonRpc.



198
199
200
 
# File 'lib/openc3/io/json_rpc.rb', line 198

def initialize
  @hash = {}
end

Instance Method Details

#<=>(other) ⇒ Object

Parameters:

  • other (JsonRpc) —

    Another JsonRpc to compare hash values with



203
204
205
206
207
 
# File 'lib/openc3/io/json_rpc.rb', line 203

def <=>(other)
  return nil unless other.respond_to?(:as_json)

  self.as_json() <=> other.as_json()
end

#as_json(*a) ⇒ Hash

Returns Hash representing the object.

Parameters:

  • a (Array) —

    Array of options

Returns:

  • (Hash) —

    Hash representing the object



211
212
213
 
# File 'lib/openc3/io/json_rpc.rb', line 211

def as_json(*a)
  @hash.as_json(*a)
end

#to_json(*a) ⇒ String

Returns The JSON encoded String.

Parameters:

  • a (Array) —

    Array of options

Returns:

  • (String) —

    The JSON encoded String



217
218
219
 
# File 'lib/openc3/io/json_rpc.rb', line 217

def to_json(*a)
  as_json(*a).to_json(*a)
end