class UNIXSocket

• UNIXSocket
• IO
• Reference
• Object

Overview

A local interprocess communication (UNIX socket) client socket.

Only available on UNIX and UNIX-like operating systems.

Usage example:

require "socket"

UNIXSocket.open("/tmp/myapp.sock") do |socket|
  socket.puts "message"
  response = socket.gets
end

Defined in:

Constructors

• .new(raw : Socket::Raw, address : Socket::UNIXAddress)

  Creates a UNIXServer from a raw socket.

• .new(address : Socket::UNIXAddress) : UNIXSocket

  Connects a named UNIX socket, bound to a filesystem pathname.

• .new(path : String) : UNIXSocket

  Connects a named UNIX socket, bound to a filesystem pathname.

Class Method Summary

• .open(path : Socket::UNIXAddress | String, &block : UNIXSocket -> )

  Connects a named UNIX socket, bound to a filesystem pathname and yields it to the block.

• .pair : Tuple(UNIXSocket, UNIXSocket)

  Returns a pair of unamed UNIX sockets.

• .pair(&block : UNIXSocket, UNIXSocket -> )

  Creates a pair of unamed UNIX sockets (see .pair) and yields them to the block.

Instance Method Summary

• #close : Nil

  Closes this socket.

• #close_read : Nil

  Closes this socket for reading.

• #close_write : Nil

  Closes this socket for writing.

• #closed? : Bool

  Returns true if this socket is closed.

• #flush
• #local_address : Socket::UNIXAddress

  Returns the UNIXAddress for the local end of the UNIX socket.

• #local_address? : Socket::UNIXAddress?

  Returns the UNIXAddress for the local end of the UNIX socket, or nil if the socket is closed.

• #peek
• #raw : Socket::Raw

  Returns the raw socket wrapped by this UNIX socket.

• #read(slice : Bytes) : Int32
• #read_buffering=(read_buffering)
• #read_buffering?
• #read_timeout : Time::Span?

  Returns the read timeout for this socket.

• #read_timeout=(timeout : Time::Span | Number?)

  Sets the read timeout for this socket.

• #recv_buffer_size : Int32

  Returns the receive buffer size for this socket.

• #recv_buffer_size=(value : Int32) : Int32

  Sets the receive buffer size for this socket.

• #remote_address : Socket::UNIXAddress

  Returns the UNIXAddress for the remote end of the UNIX socket.

• #remote_address? : Socket::UNIXAddress?

  Returns the UNIXAddress for the remote end of the UNIX socket, or nil if the socket is closed.

• #send_buffer_size : Int32

  Returns the send buffer size for this socket.

• #send_buffer_size=(value : Int32) : Int32

  Sets the send buffer size for this socket.

• #sync=(value : Bool) : Bool
• #sync? : Bool
• #write(slice : Bytes) : Nil
• #write_timeout : Time::Span?

  Returns the write timeout for this socket.

• #write_timeout=(timeout : Time::Span | Number?)

  Sets the write timeout for this socket.

Constructor Detail

Class Method Detail

left, right = UNIXSocket.pair

spawn do
  # echo server
  message = right.gets
  right.puts message
end

left.puts "message"
left.gets # => "message"
left.close
right.close

UNIXSocket.pair do |left, right|
  spawn do
    # echo server
    message = right.gets
    right.puts message
  end

  left.puts "message"
  left.gets # => "message"
end

Instance Method Detail