struct UNIXServer

• UNIXServer
• Struct
• Value
• Object

Overview

A local interprocess communication (UNIX socket) server socket.

Only available on UNIX and UNIX-like operating systems.

Usage example:

require "socket/unix_server"

def handle_client(client)
  message = client.gets
  client.puts message
end

UNIXServer.open("/tmp/myapp.sock") do |server|
  while client = server.accept?
    spawn handle_client(client)
  end
end

Included Modules

• Socket::Server

Defined in:

Constructors

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

  Creates a UNIXServer from a raw socket.

• .new(path : String, *, mode : File::Permissions? = nil, backlog : Int32 = 128) : UNIXServer

  Creates a named UNIX socket listening on a filesystem pathname.

• .new(address : Socket::UNIXAddress, *, mode : File::Permissions? = nil, backlog = 128) : UNIXServer

  Creates a named UNIX socket listening on address.

Class Method Summary

• .open(address : String | Socket::UNIXAddress, *, mode : File::Permissions? = nil, backlog = 128, &block)

  Creates a named UNIX socket listening on path and yields it to the block.

Instance Method Summary

• #accept : UNIXSocket

  Accepts an incoming connection and returns the client UNIXSocket.

• #accept? : UNIXSocket?

  Accepts an incoming connection.

• #close

  Closes the socket, then deletes the filesystem pathname if it exists.

• #closed? : Bool

  Returns true if this socket is closed.

• #local_address : Socket::UNIXAddress

  Returns the Socket::UNIXAddress this server listens on.

• #local_address? : Socket::UNIXAddress?

  Returns the Socket::UNIXAddress this server listens on, or nil if the socket is closed.

• #raw : Socket::Raw

  Returns the raw socket wrapped by this UNIX server.

• #sync=(value : Bool) : Bool

  Sets the sync flag on this socket.

• #sync? : Bool

  Returns the sync flag on this socket.

Constructor Detail

UNIXServer.new("/tmp/dgram.sock")

UNIXServer.new(Socket::UNIXAddress.new("/tmp/dgram.sock"))

Class Method Detail

Instance Method Detail

require "socket/unix_server"

UNIXServer.open("path/to_my_socket") do |server|
  loop do
    socket = server.accept
    # handle the client in a fiber
    spawn handle_connection(socket)
  end
end

require "socket/unix_server"

UNIXServer.open("path/to_my_socket") do |server|
  loop do
    if socket = server.accept?
      # handle the client in a fiber
      spawn handle_connection(socket)
    else
      # another fiber closed the server
      break
    end
  end
end