Class: Async::IO::Socket

Inherits:
BasicSocket show all
Includes:
Server, Socket::Constants
Defined in:
lib/async/io/socket.rb

Constant Summary

Constants inherited from Generic

Generic::WRAPPERS

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Server

#accept_each

Methods inherited from BasicSocket

#type

Methods included from Peer

#connected?

Methods inherited from Generic

#connected?, #nonblock, #nonblock?, #read, #wait, wrap, wrap_blocking_method, wraps, #write

Class Method Details

.accept(*args, backlog: SOMAXCONN, &block) ⇒ Object

Bind to a local address and accept connections in a loop.



192
193
194
195
196
197
198
 
# File 'lib/async/io/socket.rb', line 192

def self.accept(*args, backlog: SOMAXCONN, &block)
	bind(*args) do |server, task|
		server.listen(backlog) if backlog
		
		server.accept_each(task: task, &block)
	end
end

.bind(local_address, protocol: 0, reuse_port: false, task: Task.current, **options, &block) ⇒ Object

Bind to a local address.

Examples:

socket = Async::IO::Socket.bind(Async::IO::Address.tcp("0.0.0.0", 9090))

Parameters:

  • local_address (Address) —

    The local address to bind to.

  • protocol (Hash) (defaults to: 0) —

    a customizable set of options

  • reuse_port (Hash) (defaults to: false) —

    a customizable set of options

Options Hash (protocol:):

  • The (Integer) —

    socket protocol to use.

Options Hash (reuse_port:):

  • Allow (Boolean) —

    this port to be bound in multiple processes.



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/async/io/socket.rb', line 169

def self.bind(local_address, protocol: 0, reuse_port: false, task: Task.current, **options, &block)
	Async.logger.debug(self) {"Binding to #{local_address.inspect}"}
	
	wrapper = build(local_address.afamily, local_address.socktype, protocol, **options) do |socket|
		socket.setsockopt(::Socket::SOL_SOCKET, ::Socket::SO_REUSEADDR, true)
		socket.setsockopt(::Socket::SOL_SOCKET, ::Socket::SO_REUSEPORT, true) if reuse_port
		socket.bind(local_address.to_sockaddr)
	end
	
	return wrapper unless block_given?
	
	task.async do |task|
		task.annotate "binding to #{wrapper.local_address.inspect}"
		
		begin
			yield wrapper, task
		ensure
			wrapper.close
		end
	end
end

.build(*args, task: Task.current) ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/async/io/socket.rb', line 113

def self.build(*args, task: Task.current)
	socket = wrapped_klass.new(*args)
	
	yield socket
	
	return self.new(socket, task.reactor)
rescue Exception
	socket.close if socket
	
	raise
end

.connect(remote_address, local_address = nil, reuse_port: false, task: Task.current, **options) ⇒ Object

Establish a connection to a given remote_address.

Examples:

socket = Async::IO::Socket.connect(Async::IO::Address.tcp("8.8.8.8", 53))

Parameters:

  • remote_address (Addrinfo) —

    The remote address to connect to.

  • local_address (Addrinfo) (defaults to: nil) —

    The local address to bind to before connecting.

  • protcol (Hash) —

    a customizable set of options



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/async/io/socket.rb', line 131

def self.connect(remote_address, local_address = nil, reuse_port: false, task: Task.current, **options)
	Async.logger.debug(self) {"Connecting to #{remote_address.inspect}"}
	
	task.annotate "connecting to #{remote_address.inspect}"
	
	wrapper = build(remote_address.afamily, remote_address.socktype, remote_address.protocol, **options) do |socket|
		socket.setsockopt(::Socket::SOL_SOCKET, ::Socket::SO_REUSEADDR, reuse_port)
		
		if local_address
			socket.bind(local_address.to_sockaddr)
		end

		self.new(socket, task.reactor)
	end
	
	begin
		wrapper.connect(remote_address.to_sockaddr)
		task.annotate "connected to #{remote_address.inspect}"
	rescue Exception
		wrapper.close
		raise
	end
	
	return wrapper unless block_given?
	
	begin
		yield wrapper, task
	ensure
		wrapper.close
	end
end

.pair(*args) ⇒ Object 



202
203
204
 
# File 'lib/async/io/socket.rb', line 202

def self.pair(*args)
	::Socket.pair(*args).map(&self.method(:new))
end

Instance Method Details

#accept(task: Task.current) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/async/io/socket.rb', line 91

def accept(task: Task.current)
	peer, address = async_send(:accept_nonblock)
	wrapper = Socket.new(peer, task.reactor)
	
	return wrapper, address unless block_given?
	
	task.async do |task|
		task.annotate "incoming connection #{address.inspect}"
		
		begin
			yield wrapper, address
		rescue
			Async.logger.error(self) {$!}
		ensure
			wrapper.close
		end
	end
end

#accept_nonblock ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/async/io/socket.rb', line 110

def accept(task: Task.current)
	peer, address = async_send(:accept_nonblock)
	wrapper = Socket.new(peer, task.reactor)
	
	return wrapper, address unless block_given?
	
	task.async do |task|
		task.annotate "incoming connection #{address.inspect}"
		
		begin
			yield wrapper, address
		rescue
			Async.logger.error(self) {$!}
		ensure
			wrapper.close
		end
	end
end

#connect(*args) ⇒ Object 



81
82
83
84
85
86
87
 
# File 'lib/async/io/socket.rb', line 81

def connect(*args)
	begin
		async_send(:connect_nonblock, *args)
	rescue Errno::EISCONN
		# We are now connected.
	end
end

#connect_nonblock ⇒ Object 



89
90
91
92
93
94
95
 
# File 'lib/async/io/socket.rb', line 89

def connect(*args)
	begin
		async_send(:connect_nonblock, *args)
	rescue Errno::EISCONN
		# We are now connected.
	end
end

#sysaccept ⇒ Object 



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/async/io/socket.rb', line 111

def accept(task: Task.current)
	peer, address = async_send(:accept_nonblock)
	wrapper = Socket.new(peer, task.reactor)
	
	return wrapper, address unless block_given?
	
	task.async do |task|
		task.annotate "incoming connection #{address.inspect}"
		
		begin
			yield wrapper, address
		rescue
			Async.logger.error(self) {$!}
		ensure
			wrapper.close
		end
	end
end