class Socket

Direct Known Subclasses

Defined in:

socket.cr

Class Method Summary

Instance Method Summary

Instance methods inherited from class IO::FileDescriptor

blocking blocking, blocking=(value) blocking=, close_on_exec=(arg : Bool) close_on_exec=, close_on_exec? close_on_exec?, closed? : Bool closed?, cooked(&block) cooked, cooked! cooked!, fcntl(cmd, arg = 0) fcntl, fd : Int32 fd, finalize finalize, inspect(io) inspect, noecho(&block) noecho, noecho! noecho!, pos pos, pos=(value) pos=, raw(&block) raw, raw! raw!, read_timeout=(read_timeout : Time::Span)
read_timeout=(read_timeout : Nil)
read_timeout=(read_timeout : Number)
read_timeout=
, reopen(other : IO::FileDescriptor) reopen, seek(offset, whence : Seek = Seek::Set, &block)
seek(offset, whence : Seek = Seek::Set)
seek
, stat stat, tell tell, tty? tty?, write_timed_out : Bool write_timed_out, write_timed_out=(write_timed_out : Bool) write_timed_out=, write_timeout=(write_timeout : Time::Span)
write_timeout=(write_timeout : Nil)
write_timeout=(write_timeout : Number)
write_timeout=

Class methods inherited from class IO::FileDescriptor

fcntl(fd, cmd, arg = 0) fcntl, new(fd : Int32, blocking = false, edge_triggerable = false) new

Instance methods inherited from module IO::Buffered

close close, flush flush, flush_on_newline=(flush_on_newline) flush_on_newline=, flush_on_newline? flush_on_newline?, read(slice : Slice(UInt8)) read, rewind rewind, sync=(sync) sync=, sync? sync?, unbuffered_close unbuffered_close, unbuffered_flush unbuffered_flush, unbuffered_read(slice : Slice(UInt8)) unbuffered_read, unbuffered_rewind unbuffered_rewind, unbuffered_write(slice : Slice(UInt8)) unbuffered_write, write(slice : Slice(UInt8)) write

Instance methods inherited from module IO

<<(obj) : self <<, close close, closed? closed?, each_byte
each_byte(&block)
each_byte
, each_char(&block)
each_char
each_char
, each_line(*args, **options, &block)
each_line(*args, **options)
each_line
, encoding : String encoding, flush flush, gets : String | Nil
gets(delimiter : String) : String | Nil
gets(delimiter : Char) : String | Nil
gets(limit : Int) : String | Nil
gets(delimiter : Char, limit : Int) : String | Nil
gets
, gets_to_end : String gets_to_end, print(obj) : Nil
print(*objects : _) : Nil
print
, printf(format_string, *args) : Nil
printf(format_string, args : Array | Tuple) : Nil
printf
, puts(*objects : _) : Nil
puts(string : String) : Nil
puts(obj) : Nil
puts : Nil
puts
, read(slice : Slice(UInt8)) read, read_byte : UInt8 | Nil read_byte, read_bytes(type, format : IO::ByteFormat = IO::ByteFormat::SystemEndian) read_bytes, read_char : Char | Nil read_char, read_fully(slice : Slice(UInt8)) read_fully, read_line(*args, **options) : String | Nil read_line, read_utf8(slice : Slice(UInt8)) read_utf8, read_utf8_byte read_utf8_byte, rewind rewind, set_encoding(encoding : String, invalid : Symbol | Nil = nil) set_encoding, skip(bytes_count : Int) : Nil skip, tty? : Bool tty?, write(slice : Slice(UInt8)) : Nil write, write_byte(byte : UInt8) write_byte, write_bytes(object, format : IO::ByteFormat = IO::ByteFormat::SystemEndian) write_bytes, write_utf8(slice : Slice(UInt8)) write_utf8

Class methods inherited from module IO

copy(src, dst, limit : Int)
copy(src, dst)
copy
, pipe(read_blocking = false, write_blocking = false)
pipe(read_blocking = false, write_blocking = false, &block)
pipe
, select(read_ios, write_ios, error_ios, timeout_sec : LibC::TimeT | Int | Float | Nil)
select(read_ios, write_ios = nil, error_ios = nil)
select

Instance methods inherited from module JSON::Builder

json_array(&block) json_array, json_object(&block) json_object

Instance methods inherited from class Reference

==(other : self)
==(other)
==
, dup dup, hash hash, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, same?(other : Reference)
same?(other : Nil)
same?
, to_s(io : IO) : Nil to_s

Class methods inherited from class Reference

new new

Instance methods inherited from class Object

!=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)
===(other : YAML::Any)
===(other)
===
, =~(other) =~, class class, crystal_type_id crystal_type_id, dup dup, hash hash, inspect(io : IO)
inspect
inspect
, itself itself, not_nil! not_nil!, tap(&block) tap, to_json to_json, to_pretty_json(indent : String = " ")
to_pretty_json(io : IO, indent : String = " ")
to_pretty_json
, to_s
to_s(io : IO)
to_s
, to_yaml(io : IO)
to_yaml
to_yaml
, try(&block) try

Class methods inherited from class Object

==(other : Class) ==, ===(other) ===, cast(other) : self cast, clone clone, dup dup, from_json(string_or_io, root : String) : self
from_json(string_or_io) : self
from_json
, from_yaml(string : String) : self from_yaml, hash hash, inspect(io) inspect, name : String name, nilable? nilable?, to_s(io) to_s, |(other : U.class) forall U |

Class Method Detail

def self.ip?(string : String) #

Returns true if the string represents a valid IPv4 or IPv6 address.


[View source]
def self.new(fd, blocking = false) #

[View source]

Instance Method Detail

def broadcast=(val : Bool) #

[View source]
def broadcast? #

[View source]
def close_read #

Calls shutdown(2) with SHUT_RD


[View source]
def close_write #

Calls shutdown(2) with SHUT_WR


[View source]
def getsockopt(optname, optval, level = LibC::SOL_SOCKET) #

returns the modified optval


[View source]
def inspect(io) #

[View source]
def keepalive=(val : Bool) #

[View source]
def keepalive? #

[View source]
def linger #

[View source]
def linger=(val : Int | Nil) #

WARNING: The behavior of SO_LINGER is platform specific. Bad things may happen especially with nonblocking sockets. See https://www.nybek.com/blog/2015/04/29/so_linger-on-non-blocking-sockets/ for more information.

nil => disable SO_LINGER Int => enable SO_LINGER and set timeout to Int seconds.

0 => abort on close (socket buffer is discarded and RST sent to peer). Depends on platform and whether shutdown() was called first. >=1 => abort after Num seconds on close. Linux and Cygwin may block on close.


[View source]
def recv_buffer_size #

[View source]
def recv_buffer_size=(val : Int32) #

[View source]
def reuse_address=(val : Bool) #

[View source]
def reuse_address? #

[View source]
def send_buffer_size #

[View source]
def send_buffer_size=(val : Int32) #

[View source]
def setsockopt(optname, optval, level = LibC::SOL_SOCKET) #

optval is restricted to Int32 until sizeof works on variables


[View source]