Class: Async::IO::SSLEndpoint

Inherits:
Endpoint
  • Object
show all
Defined in:
lib/async/io/ssl_endpoint.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Endpoint

#accept, #bound, each, #linger, #local_address, parse, #reuse_address, #reuse_port, socket, ssl, tcp, #timeout, try_convert, udp, unix, #with

Constructor Details

#initialize(endpoint, **options) ⇒ SSLEndpoint

Returns a new instance of SSLEndpoint.


29
30
31
32
33
34
35
36
37
38
39
# File 'lib/async/io/ssl_endpoint.rb', line 29

def initialize(endpoint, **options)
	super(**options)
	
	@endpoint = endpoint
	
	if ssl_context = options[:ssl_context]
		@context = build_context(ssl_context)
	else
		@context = nil
	end
end

Instance Attribute Details

#endpointObject (readonly)

Returns the value of attribute endpoint


53
54
55
# File 'lib/async/io/ssl_endpoint.rb', line 53

def endpoint
  @endpoint
end

#optionsObject (readonly)

Returns the value of attribute options


54
55
56
# File 'lib/async/io/ssl_endpoint.rb', line 54

def options
  @options
end

Instance Method Details

#addressObject


45
46
47
# File 'lib/async/io/ssl_endpoint.rb', line 45

def address
	@endpoint.address
end

#bind {|Socket| ... } ⇒ Socket

Connect to the underlying endpoint and establish a SSL connection.

Yields:

  • (Socket)

    the socket which is being connected

Returns:

  • (Socket)

    the connected socket


78
79
80
81
82
83
84
85
86
# File 'lib/async/io/ssl_endpoint.rb', line 78

def bind
	if block_given?
		@endpoint.bind do |server|
			yield SSLServer.new(server, context)
		end
	else
		return SSLServer.new(@endpoint.bind, context)
	end
end

#build_context(context = OpenSSL::SSL::SSLContext.new) ⇒ Object


60
61
62
63
64
65
66
67
68
69
# File 'lib/async/io/ssl_endpoint.rb', line 60

def build_context(context = OpenSSL::SSL::SSLContext.new)
	if params = self.params
		context.set_params(params)
	end
	
	context.setup
	context.freeze
	
	return context
end

#connect {|Socket| ... } ⇒ Socket

Connect to the underlying endpoint and establish a SSL connection.

Yields:

  • (Socket)

    the socket which is being connected

Returns:

  • (Socket)

    the connected socket


91
92
93
# File 'lib/async/io/ssl_endpoint.rb', line 91

def connect(&block)
	SSLSocket.connect(@endpoint.connect, context, hostname, &block)
end

#contextObject


71
72
73
# File 'lib/async/io/ssl_endpoint.rb', line 71

def context
	@context ||= build_context
end

#eachObject


95
96
97
98
99
100
101
# File 'lib/async/io/ssl_endpoint.rb', line 95

def each
	return to_enum unless block_given?
	
	@endpoint.each do |endpoint|
		yield self.class.new(endpoint, **@options)
	end
end

#hostnameObject


49
50
51
# File 'lib/async/io/ssl_endpoint.rb', line 49

def hostname
	@options[:hostname] || @endpoint.hostname
end

#paramsObject


56
57
58
# File 'lib/async/io/ssl_endpoint.rb', line 56

def params
	@options[:ssl_params]
end

#to_sObject


41
42
43
# File 'lib/async/io/ssl_endpoint.rb', line 41

def to_s
	"\#<#{self.class} #{@endpoint}>"
end