Class: RJR::Messages::Request
Overview
Message sent from client to server to invoke a JSON-RPC method
Instance Attribute Summary collapse
-
#headers ⇒ Object
Optional headers to add to json outside of standard json-rpc request.
-
#jr_args ⇒ Object
Arguments source is passing to destination method.
-
#jr_method ⇒ Object
Method source is invoking on the destination.
-
#json_message ⇒ Object
Message string received from the source.
-
#msg_id ⇒ Object
ID of the message in accordance w/ json-rpc specification.
Class Method Summary collapse
-
.is_request_message?(message) ⇒ true, false
Class helper to determine if the specified string is a valid json-rpc method request.
Instance Method Summary collapse
-
#initialize(args = {}) ⇒ Request
constructor
RJR Request Message initializer.
-
#to_json(*a) ⇒ Object
Convert request message to json.
-
#to_s ⇒ Object
Convert request to string format.
Constructor Details
#initialize(args = {}) ⇒ Request
RJR Request Message initializer
38 39 40 |
# File 'lib/rjr/messages/request.rb', line 38 def initialize(args = {}) parse_args(args) end |
Instance Attribute Details
#headers ⇒ Object
Optional headers to add to json outside of standard json-rpc request
27 28 29 |
# File 'lib/rjr/messages/request.rb', line 27 def headers @headers end |
#jr_args ⇒ Object
Arguments source is passing to destination method
21 22 23 |
# File 'lib/rjr/messages/request.rb', line 21 def jr_args @jr_args end |
#jr_method ⇒ Object
Method source is invoking on the destination
18 19 20 |
# File 'lib/rjr/messages/request.rb', line 18 def jr_method @jr_method end |
#json_message ⇒ Object
Message string received from the source
15 16 17 |
# File 'lib/rjr/messages/request.rb', line 15 def @json_message end |
#msg_id ⇒ Object
ID of the message in accordance w/ json-rpc specification
24 25 26 |
# File 'lib/rjr/messages/request.rb', line 24 def msg_id @msg_id end |
Class Method Details
.is_request_message?(message) ⇒ true, false
Class helper to determine if the specified string is a valid json-rpc method request
75 76 77 78 79 80 81 82 83 |
# File 'lib/rjr/messages/request.rb', line 75 def self.() begin # FIXME log error parsed = JSONParser.parse() parsed.has_key?('method') && parsed.has_key?('id') rescue Exception => e false end end |
Instance Method Details
#to_json(*a) ⇒ Object
Convert request message to json
86 87 88 89 90 91 |
# File 'lib/rjr/messages/request.rb', line 86 def to_json(*a) {'jsonrpc' => '2.0', 'id' => @msg_id, 'method' => @jr_method, 'params' => @jr_args}.merge(@headers).to_json(*a) end |
#to_s ⇒ Object
Convert request to string format
94 95 96 |
# File 'lib/rjr/messages/request.rb', line 94 def to_s to_json.to_s end |