struct TCPServer

• TCPServer
• Struct
• Value
• Object

Overview

A Transmission Control Protocol (TCP/IP) server.

Usage example:

require "socket/tcp_server"

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

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

Options:

• backlog to specify how many pending connections are allowed.
• reuse_port to enable multiple processes to bind to the same port (SO_REUSEPORT).
• reuse_address to enable multiple processes to bind to the same address (SO_REUSEADDR).
• dns_timeout to specify the timeout for DNS lookups when binding to a hostname.

Included Modules

• Socket::Server

Defined in:

Constructors

• .new(host : String, port : Int, *, backlog : Int32 = Socket::SOMAXCONN, dns_timeout : Time::Span? = nil, reuse_port : Bool = false, reuse_address : Bool = true) : TCPServer

  Creates a TCPServer listening on port on all interfaces specified by host.

• .new(raw : Socket::Raw)

  Creates a TCPServer from a raw socket.

• .new(address : Socket::IPAddress, *, backlog : Int32 = Socket::SOMAXCONN, reuse_port : Bool = false, reuse_address : Bool = true) : TCPServer

  Creates a new TCPServer listening on address.

• .new(port : Int, *, backlog : Int32 = Socket::SOMAXCONN, reuse_port : Bool = false, reuse_address : Bool = true) : TCPServer

  Creates a new TCPServer, listening on port on all local interfaces (::).

Class Method Summary

• .open(host : String, port : Int, *, backlog : Int32 = Socket::SOMAXCONN, dns_timeout : Time::Span? = nil, reuse_port : Bool = false, reuse_address : Bool = true, &block)

  Creates a new TCPServer listenting on host and port, and yields it to the block.

• .open(address : Socket::IPAddress, *, backlog : Int32 = Socket::SOMAXCONN, reuse_port : Bool = false, reuse_address : Bool = true, &block)

  Creates a new TCPServer listening on address, and yields it to the block.

• .open(port : Int, *, backlog : Int32 = Socket::SOMAXCONN, reuse_port : Bool = false, reuse_address : Bool = true, &block)

  Creates a new TCPServer, listening on all interfaces on port, and yields it to the block.

Instance Method Summary

• #accept : TCPSocket

  Accepts an incoming connection and returns the client TCPSocket.

• #accept? : TCPSocket?

  Accepts an incoming connection.

• #close : Nil

  Closes this socket.

• #closed? : Bool

  Returns true if this socket is closed.

• #keepalive=(value : Bool) : Bool
• #keepalive? : Bool
• #local_address : Socket::IPAddress

  Returns the Socket::IPAddress this server listens on.

• #local_address? : Socket::IPAddress?

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

• #raw : Socket::Raw

  Returns the raw socket wrapped by this TCP server.

• #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.

• #reuse_address? : Bool

  Returns true if this socket has been configured to reuse the address (see SO_REUSEADDR).

• #reuse_port? : Bool

  Returns true if this socket has been configured to reuse the port (see SO_REUSEPORT).

• #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

  Sets the sync flag on this socket.

• #sync? : Bool

  Returns the sync flag on this socket.

• #tcp_keepalive_count : Int32

  Returns the number of probes sent, without response before dropping the connection.

• #tcp_keepalive_count=(value : Int32) : Int32

  Sets the number of probes sent, without response before dropping the connection.

• #tcp_keepalive_idle : Int32

  Returns the amount of time (in seconds) the connection must be idle before sending keepalive probes.

• #tcp_keepalive_idle=(value : Int32) : Int32

  Sets the amount of time (in seconds) the connection must be idle before sending keepalive probes.

• #tcp_keepalive_interval : Int32

  Returns the amount of time (in seconds) between keepalive probes.

• #tcp_keepalive_interval=(value : Int32) : Int32

  Sets the amount of time (in seconds) between keepalive probes.

• #tcp_nodelay=(value : Bool) : Bool

  Disable the Nagle algorithm when set to true, otherwise enables it.

• #tcp_nodelay? : Bool

  Returns true if the Nable algorithm is disabled.

Constructor Detail

Class Method Detail

Instance Method Detail

require "socket/tcp_server"

TCPServer.open(2022) do |server|
  loop do
    socket = server.accept
    # handle the client in a fiber
    spawn handle_connection(socket)
  end
end

require "socket/tcp_server"

TCPServer.open(2022) 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