module socket
private import socket_c
-intrude import standard::stream
+intrude import core::stream
-# A general TCP socket, either a `TCPStream` or a `TCPServer`
+# A general Socket, either TCP or UDP
abstract class Socket
# Underlying C socket
private var native: NativeSocket is noinit
+ # Is this socket closed?
+ var closed = false
+
+ # Set whether calls to `accept` are blocking
+ fun blocking=(value: Bool)
+ do
+ # We use the opposite from the native version as the native API
+ # is closer to the C API. In the Nity API, we use a positive version
+ # of the name.
+ native.non_blocking = not value
+ end
+end
+
+# A general TCP socket, either a `TCPStream` or a `TCPServer`
+abstract class TCPSocket
+ super Socket
+
# Port used by the socket
var port: Int
#
# Formatted as xxx.xxx.xxx.xxx.
var address: String is noinit
-
- # Is this socket closed?
- var closed = false
end
# Simple communication stream with a remote socket
class TCPStream
- super Socket
- super BufferedReader
- super Writer
+ super TCPSocket
super PollableReader
+ super Duplex
# Real canonical name of the host to which `self` is connected
var host: String
private var addrin: NativeSocketAddrIn is noinit
- redef var end_reached = false
+ redef var closed = false
# TODO make init private
# Creates a socket connection to host `host` on port `port`
init connect(host: String, port: Int)
do
- _buffer = new NativeString(1024)
- _buffer_pos = 0
native = new NativeSocket.socket(new NativeSocketAddressFamilies.af_inet,
- new NativeSocketTypes.sock_stream, new NativeSocketProtocolFamilies.pf_null)
+ new NativeSocketTypes.sock_stream, new NativeSocketProtocolFamilies.pf_unspec)
if native.address_is_null then
- end_reached = true
closed = true
return
end
if not native.setsockopt(new NativeSocketOptLevels.socket, new NativeSocketOptNames.reuseaddr, 1) then
- end_reached = true
closed = true
return
end
- var hostname = sys.gethostbyname(host.to_cstring)
- if hostname.address_is_null then
+ var hostent = sys.gethostbyname(host.to_cstring)
+ if hostent.address_is_null then
# Error in name lookup
- var err = sys.h_errno
- last_error = new IOError(err.to_s)
+ last_error = new IOError.from_h_errno
closed = true
- end_reached = true
return
end
- addrin = new NativeSocketAddrIn.with_hostent(hostname, port)
- address = addrin.address
- init(addrin.port, hostname.h_name)
+ addrin = new NativeSocketAddrIn
+ addrin.fill_from_hostent hostent
+ addrin.port = port
+
+ address = addrin.address.to_s
+ init(addrin.port, hostent.h_name.to_s)
closed = not internal_connect
- end_reached = closed
if closed then
# Connection failed
- last_error = new IOError(errno.strerror)
+ last_error = new IOError.from_errno
end
end
# Creates a client socket, this is meant to be used by accept only
private init server_side(h: SocketAcceptResult)
do
- _buffer = new NativeString(1024)
- _buffer_pos = 0
native = h.socket
addrin = h.addr_in
- address = addrin.address
+ address = addrin.address.to_s
init(addrin.port, address)
end
#
# timeout : Time in milliseconds before stopping listening for events on this socket
private fun pollin(event_types: Array[NativeSocketPollValues], timeout: Int): Array[NativeSocketPollValues] do
- if end_reached then return new Array[NativeSocketPollValues]
- return native.socket_poll(new PollFD(native.descriptor, event_types), timeout)
+ if closed then return new Array[NativeSocketPollValues]
+ return native.socket_poll(new PollFD.from_poll_values(native.descriptor, event_types), timeout)
end
# Easier use of pollin to check for something to read on all channels of any priority
# timeout : Time in milliseconds before stopping to wait for events
fun ready_to_read(timeout: Int): Bool
do
- if _buffer_pos < _buffer_length then return true
- if end_reached then return false
var events = [new NativeSocketPollValues.pollin]
return pollin(events, timeout).length != 0
end
- # Checks if the socket still is connected
+ # Is this socket still connected?
fun connected: Bool
do
if closed then return false
- var events = [new NativeSocketPollValues.pollhup, new NativeSocketPollValues.pollerr]
- if pollin(events, 0).length == 0 then
+ if native.poll_hup_err == 0 then
return true
else
closed = true
end
end
- redef fun is_writable do return not end_reached
+ redef fun is_writable do return not closed
# Establishes a connection to socket addrin
#
return native.connect(addrin) >= 0
end
+ redef fun raw_read_byte do
+ var rd = native.read(write_buffer, 1)
+ if rd < 1 then return -1
+ return write_buffer[0].to_i
+ end
+
+ redef fun raw_read_bytes(ns, max) do
+ var rd = native.read(ns, max)
+ print "Read {rd} bytes"
+ if rd < 0 then return -1
+ return rd
+ end
+
# If socket.end_reached, nothing will happen
redef fun write(msg)
do
if closed then return
- native.write(msg.to_s)
+ native.write(msg.to_cstring, msg.length)
end
redef fun write_byte(value)
native.write_byte value
end
- redef fun write_bytes(s) do
+ redef fun write_bytes_from_cstring(ns, len) do
if closed then return
- native.write(s.to_s)
+ native.write(ns, len)
end
+ # Write `msg`, with a trailing `\n`
fun write_ln(msg: Text)
do
- if end_reached then return
- write(msg.to_s)
- write("\n")
- end
-
- redef fun fill_buffer
- do
- _buffer_length = 0
- _buffer_pos = 0
- if not connected then return
- var read = native.read
- if read.length == 0 then
- close
- end_reached = true
- end
- enlarge(_buffer_length + read.length)
- read.copy_to_native(_buffer, read.length, 0, 0)
- _buffer_length = read.length
- end
-
- fun enlarge(len: Int) do
- if _buffer_capacity >= len then return
- while _buffer_capacity < len do _buffer_capacity = _buffer_capacity * 2 + 2
- var ns = new NativeString(_buffer_capacity)
- _buffer.copy_to(ns, _buffer_length - _buffer_pos, _buffer_pos, 0)
- _buffer = ns
+ if closed then return
+ write msg.to_s
+ write "\n"
end
redef fun close
if closed then return
if native.close >= 0 then
closed = true
- end_reached = true
end
end
#
# Create streams to communicate with clients using `accept`.
class TCPServer
- super Socket
+ super TCPSocket
private var addrin: NativeSocketAddrIn is noinit
init
do
native = new NativeSocket.socket(new NativeSocketAddressFamilies.af_inet,
- new NativeSocketTypes.sock_stream, new NativeSocketProtocolFamilies.pf_null)
+ new NativeSocketTypes.sock_stream, new NativeSocketProtocolFamilies.pf_unspec)
assert not native.address_is_null
if not native.setsockopt(new NativeSocketOptLevels.socket, new NativeSocketOptNames.reuseaddr, 1) then
closed = true
return
end
- addrin = new NativeSocketAddrIn.with_port(port, new NativeSocketAddressFamilies.af_inet)
- address = addrin.address
+
+ addrin = new NativeSocketAddrIn
+ addrin.family = new NativeSocketAddressFamilies.af_inet
+ addrin.port = port
+ addrin.address_any
+
+ address = addrin.address.to_s
# Bind it
closed = not bind
return new TCPStream.server_side(native)
end
- # Set whether calls to `accept` are blocking
- fun blocking=(value: Bool)
- do
- # We use the opposite from the native version as the native API
- # is closer to the C API. In the Nity API, we use a positive version
- # of the name.
- native.non_blocking = not value
- end
-
# Close this socket
fun close
do
class SocketObserver
private var native = new NativeSocketObserver
+ # Set of file descriptors on which to watch read events
var read_set: nullable SocketSet = null
+ # Set of file descriptors on which to watch write events
var write_set: nullable SocketSet = null
+ # Set of file descriptors on which to watch exception events
var except_set: nullable SocketSet = null
- init(read: Bool, write: Bool, except: Bool)
- is old_style_init do
+ # Initialize a socket observer
+ init with_sets(read: Bool, write: Bool, except: Bool) do
if read then read_set = new SocketSet
if write then write_set = new SocketSet
if except then except_set = new SocketSet
end
+ # Watch for changes in the states of several sockets.
fun select(max: Socket, seconds: Int, microseconds: Int): Bool
do
# FIXME this implementation (see the call to nullable attributes below) and
# `NativeSockectObserver::select` is not stable.
var timeval = new NativeTimeval(seconds, microseconds)
- return native.select(max.native, read_set.native, write_set.native, except_set.native, timeval) > 0
+ var rd = if read_set != null then read_set.as(not null).native else null
+ var wrt = if write_set != null then write_set.as(not null).native else null
+ var expt = if except_set != null then except_set.as(not null).native else null
+ return native.select(max.native, rd, wrt, expt, timeval) > 0
+ end
+end
+
+# Socket over UDP, sends and receive data without the need for a connection
+class UDPSocket
+ super Socket
+
+ # Last error raised by this socket
+ var error: nullable Error = null
+
+ init do native = new NativeSocket.socket(
+ new NativeSocketAddressFamilies.af_inet,
+ new NativeSocketTypes.sock_dgram,
+ new NativeSocketProtocolFamilies.pf_unspec)
+
+ # Bind this socket to an `address`, on `port` (to all addresses if `null`)
+ #
+ # On error, sets `error` appropriately.
+ fun bind(address: nullable Text, port: Int)
+ do
+ var addr_in = new NativeSocketAddrIn
+ addr_in.port = port
+ if address != null then
+ # FIXME replace all use of gethostbyname with something not obsolete
+ var hostent = sys.gethostbyname(address.to_cstring)
+ if hostent.address_is_null then
+ error = new IOError.from_h_errno
+ addr_in.free
+ return
+ end
+
+ addr_in.fill_from_hostent hostent
+ else
+ addr_in.family = new NativeSocketAddressFamilies.af_inet
+ addr_in.address_any
+ end
+
+ if native.bind(addr_in) != 0 then error = new IOError.from_errno
+
+ addr_in.free
+ end
+
+ # Receive `length` bytes of data from any sender
+ #
+ # On error, returns an empty string and sets `error` appropriately.
+ fun recv(length: Int): String
+ do
+ var buf = new CString(length)
+ var len = native.recvfrom(buf, length, 0, new NativeSocketAddrIn.nul)
+ if len == -1 then
+ error = new IOError.from_errno
+ return ""
+ end
+ return buf.to_s_unsafe(len, copy=false)
end
+
+ # Receive `length` bytes of data from any sender and store the sender info in `sender.item`
+ #
+ # On error, returns an empty string and sets `error` appropriately.
+ fun recv_from(length: Int, sender: Ref[nullable SocketAddress]): String
+ do
+ var src = new NativeSocketAddrIn
+ var buf = new CString(length)
+
+ var len = native.recvfrom(buf, length, 0, src)
+ if len == -1 then
+ error = new IOError.from_errno
+ src.free
+ return ""
+ end
+
+ sender.item = new SocketAddress(src)
+ return buf.to_s_unsafe(len, copy=false)
+ end
+
+ # Send `data` to `dest_address` on `port`
+ #
+ # On error, sets `error` appropriately.
+ fun send_to(dest_address: Text, port: Int, data: Text)
+ do
+ var hostent = sys.gethostbyname(dest_address.to_cstring)
+ if hostent.address_is_null then
+ error = new IOError.from_h_errno
+ return
+ end
+
+ var dest = new NativeSocketAddrIn
+ dest.fill_from_hostent hostent
+ dest.port = port
+ native.setsockopt(new NativeSocketOptLevels.socket, new NativeSocketOptNames.broadcast, 1)
+
+ var buf = data.to_cstring
+ if native.sendto(buf, data.length, 0, dest) == -1 then
+ error = new IOError.from_errno
+ end
+ dest.free
+ end
+
+ # Enable broadcasting for this socket
+ #
+ # On error, sets `error` appropriately.
+ fun enable_broadcast=(value: Bool) do
+ var res = native.setsockopt(new NativeSocketOptLevels.socket, new NativeSocketOptNames.broadcast, value.to_i)
+ if res == -1 then error = new IOError.from_errno
+ end
+
+ # Broadcast `data` on the network on `port`
+ #
+ # On error, sets `error` appropriately.
+ #
+ # Require: setting `enable_broadcast = true`
+ fun broadcast(port: Int, data: Text)
+ do
+ var addr_in = new NativeSocketAddrIn
+ addr_in.port = port
+ addr_in.family = new NativeSocketAddressFamilies.af_inet
+ addr_in.address_broadcast
+
+ var buf = data.to_cstring
+ if native.sendto(buf, data.length, 0, addr_in) == -1 then
+ error = new IOError.from_errno
+ end
+
+ addr_in.free
+ end
+end
+
+# Address of a socket in the Internet namespace
+#
+# Used in one of the out parameters of `UDPSocket::recv_from`.
+class SocketAddress
+ super FinalizableOnce
+
+ # FIXME make init private
+
+ private var native: NativeSocketAddrIn
+
+ init
+ do
+ address = native.address.to_s
+ port = native.port
+ end
+
+ # Internet address
+ var address: String is noinit
+
+ # Port of the socket
+ var port: Int is noinit
+
+ redef fun ==(o) do return o isa SocketAddress and o.address == address and o.port == port
+
+ redef fun finalize_once do native.free
+end
+
+redef class IOError
+ # Fill a new `IOError` from the message of `errno`
+ init from_errno do init errno.strerror
+
+ # Fill a new `IOError` from the message of `h_errno`
+ #
+ # Used with `gethostbyname`.
+ init from_h_errno do init h_errno.to_s
end
nitlanguage / nit.git / blobdiff