abstract class OpenSSL::SSL::Socket
Included Modules
Direct Known Subclasses
Defined in:
openssl/ssl/socket.crInstance Method Summary
- #alpn_protocol
Returns the negotiated ALPN protocol (eg:
"h2") ofnilif no protocol was negotiated. - #cipher : String
Returns the current cipher used by this socket.
- #closed? : Bool
Returns
trueif thisIOis closed. - #finalize
- #hostname : String?
Returns the hostname provided through Server Name Indication (SNI)
- #local_address
- #peer_certificate : OpenSSL::X509::Certificate?
Returns the
OpenSSL::X509::Certificatethe peer presented, if a connection was esablished. - #read_timeout
- #read_timeout=(value)
- #remote_address
- #sync_close=(sync_close : Bool)
If
#sync_close?istrue, closing this socket will close the underlying IO. - #sync_close? : Bool
If
#sync_close?istrue, closing this socket will close the underlying IO. - #tls_version : String
Returns the name of the TLS protocol version used by this socket.
- #unbuffered_close : Nil
Closes the wrapped
IO. - #unbuffered_flush : Nil
Flushes the wrapped
IO. - #unbuffered_read(slice : Bytes) : Int32
Reads at most slice.size bytes from the wrapped
IOinto slice. - #unbuffered_rewind
Rewinds the wrapped
IO. - #unbuffered_write(slice : Bytes) : Nil
Writes at most slice.size bytes from slice into the wrapped
IO. - #write_timeout
- #write_timeout=(value)
Instance methods inherited from module IO::Buffered
buffer_size : Int32 buffer_size, buffer_size=(value) buffer_size=, close : Nil close, flush flush, flush_on_newline=(flush_on_newline) flush_on_newline=, flush_on_newline? : Bool flush_on_newline?, peek : Bytes? peek, read(slice : Bytes) : Int32 read, read_buffering=(read_buffering) read_buffering=, read_buffering? : Bool read_buffering?, rewind rewind, sync=(sync) sync=, sync? : Bool sync?, unbuffered_close unbuffered_close, unbuffered_flush unbuffered_flush, unbuffered_read(slice : Bytes) unbuffered_read, unbuffered_rewind unbuffered_rewind, unbuffered_write(slice : Bytes) unbuffered_write, write(slice : Bytes) : Nil write Instance methods inherited from class IO
<self <<, close close, closed? : Bool closed?, each_byte(&) : Nileach_byte each_byte, each_char(&) : Nil
each_char each_char, each_line(*args, **options, &block : String -> ) : Nil
each_line(*args, **options) each_line, encoding : String encoding, flush flush, gets(limit : Int, chomp = false) : String?
gets(delimiter : Char, limit : Int, chomp = false) : String?
gets(delimiter : Char, chomp = false) : String?
gets(delimiter : String, chomp = false) : String?
gets(chomp = true) : String? gets, gets_to_end : String gets_to_end, peek : Bytes? peek, pos pos, pos=(value) pos=, print(obj : _) : Nil
print(*objects : _) : Nil print, printf(format_string, args : Array | Tuple) : Nil
printf(format_string, *args) : Nil printf, puts(string : String) : Nil
puts(obj : _) : Nil
puts : Nil
puts(*objects : _) : Nil puts, read(slice : Bytes) read, read_at(offset, bytesize, & : IO -> ) read_at, read_byte : UInt8? read_byte, read_bytes(type, format : IO::ByteFormat = IO::ByteFormat::SystemEndian) read_bytes, read_char : Char? read_char, read_fully(slice : Bytes) : Int32 read_fully, read_fully?(slice : Bytes) : Int32? read_fully?, read_line(*args, **options) : String read_line, read_string(bytesize : Int) : String read_string, read_utf8(slice : Bytes) read_utf8, read_utf8_byte : UInt8? read_utf8_byte, rewind rewind, seek(offset, whence : Seek = Seek::Set) seek, set_encoding(encoding : String, invalid : Symbol? = nil) : Nil set_encoding, skip(bytes_count : Int) : Nil skip, skip_to_end : Nil skip_to_end, tell tell, tty? : Bool tty?, write(slice : Bytes) : Nil write, write_byte(byte : UInt8) : Nil write_byte, write_bytes(object, format : IO::ByteFormat = IO::ByteFormat::SystemEndian) : Nil write_bytes, write_string(slice : Bytes) : Nil write_string, write_utf8(slice : Bytes) : Nil write_utf8
Class methods inherited from class IO
copy(src, dst, limit : Int) : Int64copy(src, dst) : Int64 copy, pipe(read_blocking = false, write_blocking = false) : Tuple(IO::FileDescriptor, IO::FileDescriptor)
pipe(read_blocking = false, write_blocking = false, &) pipe, same_content?(stream1 : IO, stream2 : IO) : Bool same_content?
Instance methods inherited from class Reference
==(other : self)==(other : JSON::Any)
==(other : YAML::Any)
==(other) ==, dup dup, hash(hasher) hash, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference) : Bool
same?(other : Nil) same?, to_s(io : IO) : Nil to_s
Constructor methods inherited from class Reference
new new Instance methods inherited from class Object
! : Bool !, !=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)===(other : YAML::Any)
===(other) ===, =~(other) =~, as(type : Class) as, as?(type : Class) as?, class class, dup dup, hash(hasher)
hash hash, in?(collection : Object) : Bool
in?(*values : Object) : Bool in?, inspect(io : IO) : Nil
inspect : String inspect, is_a?(type : Class) : Bool is_a?, itself itself, nil? : Bool nil?, not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, responds_to?(name : Symbol) : Bool responds_to?, tap(&) tap, to_json(io : IO) : Nil
to_json : String to_json, to_pretty_json(indent : String = " ") : String
to_pretty_json(io : IO, indent : String = " ") : Nil to_pretty_json, to_s(io : IO) : Nil
to_s : String to_s, to_yaml(io : IO) : Nil
to_yaml : String to_yaml, try(&) try, unsafe_as(type : T.class) forall T unsafe_as
Class methods inherited from class Object
from_json(string_or_io, root : String)from_json(string_or_io) from_json, from_yaml(string_or_io : String | IO) from_yaml
Instance Method Detail
def alpn_protocolSource
Returns the negotiated ALPN protocol (eg: "h2") of nil if no protocol was negotiated.
def finalizeSource
def local_addressSource
def peer_certificate : OpenSSL::X509::Certificate?Source
Returns the OpenSSL::X509::Certificate the peer presented, if a connection was esablished.
NOTE Due to the protocol definition, a TLS/SSL server will always send a certificate, if present. A client will only send a certificate when explicitly requested to do so by the server (see SSL_CTX_set_verify(3)). If an anonymous cipher is used, no certificates are sent. That a certificate is returned does not indicate information about the verification state.
def read_timeoutSource
def read_timeout=(value)Source
def remote_addressSource
def sync_close=(sync_close : Bool)Source
If #sync_close? is true, closing this socket will close the underlying IO.
def sync_close? : BoolSource
If #sync_close? is true, closing this socket will close the underlying IO.
def unbuffered_close : NilSource
Closes the wrapped IO.
def unbuffered_flush : NilSource
Flushes the wrapped IO.
def unbuffered_read(slice : Bytes) : Int32Source
Reads at most slice.size bytes from the wrapped IO into slice. Returns the number of bytes read.
def unbuffered_rewindSource
Rewinds the wrapped IO.
def unbuffered_write(slice : Bytes) : NilSource
Writes at most slice.size bytes from slice into the wrapped IO. Returns the number of bytes written.
def write_timeoutSource
def write_timeout=(value)Source
© 2012–2021 Manas Technology Solutions.
Licensed under the Apache License, Version 2.0.
https://crystal-lang.org/api/1.2.1/OpenSSL/SSL/Socket.html