Class: Async::WebSocket::Client

Inherits:
Protocol::HTTP::Middleware
  • Object
show all
Includes:
Protocol::WebSocket::Headers
Defined in:
lib/async/websocket/client.rb

Overview

This is a basic synchronous websocket client:

Defined Under Namespace

Classes: Framer

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client, **options) ⇒ Client

Returns a new instance of Client.



66
67
68
69
70
 
# File 'lib/async/websocket/client.rb', line 66

def initialize(client, **options)
	super(client)
	
	@options = options
end

Class Method Details

.connect(endpoint, *arguments, **options, &block) ⇒ Connection

Returns an open websocket connection to the given endpoint.

Returns:

  • (Connection) —

    an open websocket connection to the given endpoint.



52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/async/websocket/client.rb', line 52

def self.connect(endpoint, *arguments, **options, &block)
	client = self.open(endpoint, *arguments)
	connection = client.connect(endpoint.authority, endpoint.path, **options)
		
	return connection unless block_given?
		
	begin
		yield connection
	ensure
		connection.close
		client.close
	end
end

.open(endpoint, **options, &block) ⇒ Client

Returns a client which can be used to establish websocket connections to the given endpoint.

Returns:

  • (Client) —

    a client which can be used to establish websocket connections to the given endpoint.



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/async/websocket/client.rb', line 39

def self.open(endpoint, **options, &block)
	client = self.new(HTTP::Client.new(endpoint, **options), mask: true)
	
	return client unless block_given?
	
	begin
		yield client
	ensure
		client.close
	end
end

Instance Method Details

#connect(authority, path, headers: nil, handler: Connection, extensions: ::Protocol::WebSocket::Extensions::Client.default, **options, &block) ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/async/websocket/client.rb', line 90

def connect(authority, path, headers: nil, handler: Connection, extensions: ::Protocol::WebSocket::Extensions::Client.default, **options, &block)
	headers = ::Protocol::HTTP::Headers[headers]
	
	extensions&.offer do |extension|
		headers.add(SEC_WEBSOCKET_EXTENSIONS, extension.join("; "))
	end
	
	request = Request.new(nil, authority, path, headers, **options)
	
	pool = @delegate.pool
	connection = pool.acquire
	
	response = request.call(connection)
	
	unless response.stream?
		raise ProtocolError, "Failed to negotiate connection: #{response.status}"
	end
	
	protocol = response.headers[SEC_WEBSOCKET_PROTOCOL]&.first
	stream = response.stream
	
	framer = Framer.new(pool, connection, stream)
	
	connection = nil
	
	if extension_headers = response.headers[SEC_WEBSOCKET_EXTENSIONS]
		extensions.accept(extension_headers)
	end
	
	response = nil
	stream = nil
	
	connction = handler.call(framer, protocol, extensions, **@options, &block)
ensure
	pool.release(connection) if connection
end