Class: JRPC::BaseClient

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/jrpc/base_client.rb

Direct Known Subclasses

TcpClient

Constant Summary collapse

ID_CHARACTERS = 
(('a'..'z').to_a + ('0'..'9').to_a + ('A'..'Z').to_a).freeze
REQUEST_TYPES = 
[:request, :notification].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(uri, options) ⇒ BaseClient

Returns a new instance of BaseClient.



19
20
21
22
 
# File 'lib/jrpc/base_client.rb', line 19

def initialize(uri, options)
  @uri = uri
  @options = options
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *params) ⇒ Object 



24
25
26
 
# File 'lib/jrpc/base_client.rb', line 24

def method_missing(method, *params)
  invoke_request(method, *params)
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.



7
8
9
 
# File 'lib/jrpc/base_client.rb', line 7

def options
  @options
end

#uri ⇒ Object (readonly)

Returns the value of attribute uri.



7
8
9
 
# File 'lib/jrpc/base_client.rb', line 7

def uri
  @uri
end

Class Method Details

.connect(uri, options) ⇒ Object 



12
13
14
15
16
17
 
# File 'lib/jrpc/base_client.rb', line 12

def self.connect(uri, options)
  client = new(uri, options)
  yield(client)
ensure
  client.close if client
end

Instance Method Details

#invoke_notification(method, *params) ⇒ Object 



53
54
55
56
57
 
# File 'lib/jrpc/base_client.rb', line 53

def invoke_notification(method, *params)
  warn '[DEPRECATION] `invoke_request` is deprecated. Please use `perform_request` instead.'
  params = nil if params.empty?
  perform_request(method, params: params, type: :notification)
end

#invoke_request(method, *params) ⇒ Object 



47
48
49
50
51
 
# File 'lib/jrpc/base_client.rb', line 47

def invoke_request(method, *params)
  warn '[DEPRECATION] `invoke_request` is deprecated. Please use `perform_request` instead.'
  params = nil if params.empty?
  perform_request(method, params: params)
end

#perform_request(method, params: nil, type: :request, read_timeout: nil, write_timeout: nil) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/jrpc/base_client.rb', line 28

def perform_request(method, params: nil, type: :request, read_timeout: nil, write_timeout: nil)
  validate_request(params, type)
  request = create_message(method.to_s, params)
  if type == :request
    id = generate_id
    request['id'] = id
    response = send_command serialize_request(request), read_timeout: read_timeout, write_timeout: write_timeout
    response = deserialize_response(response)

    validate_response(response, id)
    parse_error(response['error']) if response.has_key?('error')

    response['result']
  else
    send_notification serialize_request(request), write_timeout: write_timeout
    nil
  end
end