class Socket::Raw

• Socket::Raw
• IO
• Reference
• Object

Overview

This class represents a raw network socket.

It is an object oriented wrapper for BSD-style socket API provided by POSIX operating systems and Windows.

This class is not intended to be used for typical network applications. There are more specific implementations TCPSocket, UDPSocket, UNIXSocket, TCPServer, and UNIXServer. It allows finer-grained control over socket parameters than the protocol-specific classes and only needs to be employed for less common tasks that need low-level access to the OS sockets.

Included Modules

• IO::Buffered
• IO::Syscall

Defined in:

Constructors

• .new(family : Family, type : Type, protocol : Protocol = Protocol::IP, *, blocking : Bool = false)

  Creates a new raw socket.

• .new(fd : Int32, family, type, protocol = Protocol::IP, *, blocking : Bool = false)

Class Method Summary

• .fcntl(fd, cmd, arg = 0)

Instance Method Summary

• #accept

  Accepts an incoming connection.

• #accept?

  Accepts an incoming connection.

• #bind(addr : Address | Addrinfo, &block)

  Tries to bind the socket to a local address.

• #bind(addr : Address | Addrinfo)

  Binds the socket to a local address.

• #bind(port : Int)

  Binds the socket on port to all local interfaces.

• #bind(host : String, port : Int)

  Binds the socket to a local IP socket address specified by host and port.

• #blocking
• #blocking=(value)
• #close_on_exec=(arg : Bool)
• #close_on_exec?
• #close_read

  Calls shutdown(2) with SHUT_RD

• #close_write

  Calls shutdown(2) with SHUT_WR

• #closed? : Bool
• #connect(address : Address | Addrinfo, *, connect_timeout = nil, &block : IO::Timeout | Errno -> )

  Connects the socket to a socket address specified by address.

• #connect(address : Address | Addrinfo, *, connect_timeout = nil) : Nil

  Connects the socket to a socket address specified by address.

• #connect(host : String, port : Int, *, dns_timeout = nil, connect_timeout = nil)

  Connects the socket to a IP socket address specified by host and port.

• #family : Family
• #fcntl(cmd, arg = 0)
• #fd : Int32

  The raw file-descriptor.

• #finalize
• #getsockopt(optname, optval, level = LibC::SOL_SOCKET)

  Returns the modified optval.

• #getsockopt_bool(optname, level = LibC::SOL_SOCKET)
• #inspect(io)
• #listen(*, backlog : Int32 = SOMAXCONN, &block)

  Tries to listen for connections on the previously bound socket.

• #listen(*, backlog : Int32 = SOMAXCONN)

  Tells the previously bound socket to listen for incoming connections.

• #local_address : Address

  Returns the Address for the local end of the socket.

• #protocol : Protocol
• #receive(*, max_message_size = 512) : Tuple(String, Address)

  Receives a text message from the previously bound address.

• #receive(message : Bytes) : Tuple(Int32, Address)

  Receives a binary message from the previously bound address.

• #remote_address : Address

  Returns the Address for the remote end of the socket.

• #send(message, *, to addr : Address)

  Sends a message to the specified remote address.

• #send(message)

  Sends a message to a previously connected remote address.

• #setsockopt(optname, optval, level = LibC::SOL_SOCKET)

  NOTE optval is restricted to Int32 until sizeof works on variables.

• #setsockopt_bool(optname, optval : Bool, level = LibC::SOL_SOCKET)
• #tty?
• #type : Type

Constructor Detail

Class Method Detail

Instance Method Detail

require "socket"

server = TCPServer.new(2202)
socket = server.accept
socket.puts Time.now
socket.close

require "socket"

server = TCPServer.new(2202)
if socket = server.accept?
  socket.puts Time.now
  socket.close
end

sock = Socket::Raw.udp(Socket::Family::INET)
sock.bind Socket::IPAddress.new("192.168.1.25", 80)

sock = Socket::Raw.tcp(Socket::Family::INET6)
sock.bind 1234

sock = Socket::Raw.tcp(Socket::Family::INET)
sock.bind "localhost", 1234

sock = Socket::Raw.unix
sock.connect Socket::UNIXAddress.new("/tmp/service.sock")

sock = Socket::Raw.tcp(Socket::Family::INET)
sock.connect "crystal-lang.org", 80

server = Socket::Raw.udp(Socket::Family::INET)
server.bind("localhost", 1234)

message, client_addr = server.receive

server = Socket::Raw.udp(Socket::Family::INET)
server.bind("localhost", 1234)

message = Bytes.new(32)
bytes_read, client_addr = server.receive(message)

server = Socket::IPAddress.new("10.0.3.1", 2022)
sock = Socket::Raw.udp(Socket::Family::INET)
sock.connect("example.com", 2000)
sock.send("text query", to: server)

sock = Socket::Raw.udp(Socket::Family::INET)
sock.connect("example.com", 2000)
sock.send("text message")

sock = Socket::Raw.unix(Socket::Type::DGRAM)
sock.connect Socket::UNIXAddress.new("/tmp/service.sock")
sock.send(Bytes[0])