class TCPServer

• TCPServer
• TCPSocket
• IPSocket
• Socket
• IO
• Reference
• Object

Overview

A Transmission Control Protocol (TCP/IP) server.

NOTE To use TCPServer, you must explicitly import it with require "socket"

Usage example:

require "socket"

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

server = TCPServer.new("localhost", 1234)
while client = server.accept?
  spawn handle_client(client)
end

Options:

• host local interface to bind on, or :: to bind on all local interfaces.
• port specific port to bind on, or 0 to receive an "ephemeral" (free, assigned by kernel) port.
• backlog to specify how many pending connections are allowed.
• reuse_port to enable multiple processes to bind to the same port (SO_REUSEPORT).

Included Modules

• Socket::Server

Defined in:

Constructors

• .new(host : String, port : Int, backlog : Int = SOMAXCONN, dns_timeout = nil, reuse_port : Bool = false)

  Binds a socket to the host and port combination.

• .new(family : Family = Family::INET)

  Creates a new TCPServer, waiting to be bound.

• .new(port : Int, backlog = SOMAXCONN, reuse_port = false)

  Creates a new TCP server, listening on all local interfaces (::).

• .new(*, fd : Handle, family : Family = Family::INET)

  Creates a TCPServer from an existing system file descriptor or socket handle.

Class Method Summary

• .open(port : Int, backlog = SOMAXCONN, reuse_port = false, &)

  Creates a new TCP server, listening on all interfaces, and yields it to the block.

• .open(host, port, backlog = SOMAXCONN, reuse_port = false, &)

  Creates a new TCP server and yields it to the block.

Instance Method Summary

• #accept? : TCPSocket | Nil

  Accepts an incoming connection.

Constructor Detail

Class Method Detail

Instance Method Detail

require "socket"

server = TCPServer.new(2022)
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