Class: Puppeteer::CDPSession

Inherits:
Object
  • Object
show all
Includes:
EventCallbackable
Defined in:
lib/puppeteer/cdp_session.rb

Defined Under Namespace

Classes: Error

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from EventCallbackable

#add_event_listener, #emit_event, #on_event, #remove_event_listener

Constructor Details

#initialize(connection, target_type, session_id) ⇒ CDPSession

Returns a new instance of CDPSession.

Parameters:

  • connection (!Connection)
  • targetType (string)
  • sessionId (string) 


10
11
12
13
14
15
 
# File 'lib/puppeteer/cdp_session.rb', line 10

def initialize(connection, target_type, session_id)
  @callbacks = {}
  @connection = connection
  @target_type = target_type
  @session_id = session_id
end

Instance Attribute Details

#connection ⇒ Object (readonly)

Returns the value of attribute connection.



17
18
19
 
# File 'lib/puppeteer/cdp_session.rb', line 17

def connection
  @connection
end

Instance Method Details

#async_send_message(method, params = {}) ⇒ Object

Parameters:

  • method (String)
  • params (Hash) (defaults to: {}) 


29
30
31
32
33
34
35
36
37
 
# File 'lib/puppeteer/cdp_session.rb', line 29

def async_send_message(method, params = {})
  if !@connection
    raise Error.new("Protocol error (#{method}): Session closed. Most likely the #{@target_type} has been closed.")
  end
  id = @connection.raw_send(message: { sessionId: @session_id, method: method, params: params })
  promise = resolvable_future
  @callbacks[id] = Puppeteer::Connection::MessageCallback.new(method: method, promise: promise)
  promise
end

#detach ⇒ Object 



60
61
62
63
64
65
 
# File 'lib/puppeteer/cdp_session.rb', line 60

def detach
  if !@connection
    raise Error.new("Session already detarched. Most likely the #{@target_type} has been closed.")
  end
  @connection.send_message('Target.detachFromTarget',  sessionId: @session_id)
end

#handle_closed ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/puppeteer/cdp_session.rb', line 67

def handle_closed
  @callbacks.each_value do |callback|
    callback.reject(
      Puppeteer::Connection::ProtocolError.new(
        method: callback.method,
        error_message: 'Target Closed.'))
  end
  @callbacks.clear
  @connection = nil
  emit_event 'Events.CDPSession.Disconnected'
end

#handle_message(message) ⇒ Object

Parameters:

  • object ({id?: number, method: string, params: Object, error: {message: string, data: any}, result?: *}) 


40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/puppeteer/cdp_session.rb', line 40

def handle_message(message)
  if message['id']
    if callback = @callbacks.delete(message['id'])
      if message['error']
        callback.reject(
          Puppeteer::Connection::ProtocolError.new(
            method: callback.method,
            error_message: message['error']['message'],
            error_data: message['error']['data']))
      else
        callback.resolve(message['result'])
      end
    else
      raise Error.new("unknown id: #{message['id']}")
    end
  else
    emit_event message['method'], message['params']
  end
end

#send_message(method, params = {}) ⇒ Object

Parameters:

  • method (String)
  • params (Hash) (defaults to: {}) 


22
23
24
 
# File 'lib/puppeteer/cdp_session.rb', line 22

def send_message(method, params = {})
  await async_send_message(method, params)
end