- Index
- »
- fan.inet
- »
- TcpListener
TcpListener
class TcpListener : Obj
TcpListener is a server socket that listens to a local well known port for incoming TcpSockets.
Create a new, unbound TCP server socket
Bind this listener to the specified local address
Is this socket closed
Get the bound local port or null if unbound
Is this socket bound to a local address and port
Access the SocketOptions used to tune this server socket
Close this server socket
The SocketConfig being used to configure the server sockets
Get the bound local address or null if unbound
Accept the next incoming connection
TcpSocket accept()
Accept the next incoming connection. This method blocks the calling thread until a new connection is established. If this listener's SocketConfig.acceptTimeout is configured, then accept will timeout with an IOErr.
This bind(IpAddr? addr, Int? port, Int backlog)
Bind this listener to the specified local address. If addr is null then the default IpAddr for the local host is selected. If port is null an ephemeral port is selected. Throw IOErr if the port is already bound or the bind fails. Return this.
Bool close()
Close this server socket. This method is guaranteed to never throw an IOErr. Return true if the socket was closed successfully or false if the socket was closed abnormally.
SocketConfig config()
The SocketConfig being used to configure the server sockets.
Bool isBound()
Is this socket bound to a local address and port.
Bool isClosed()
Is this socket closed.
IpAddr? localAddr()
Get the bound local address or null if unbound.
Int? localPort()
Get the bound local port or null if unbound.
new make(SocketConfig config)
Create a new, unbound TCP server socket. The socket will be configured using the given socket configuration. The following configuration applies to listeners:
@Deprecated { msg="Use SocketConfig" }
SocketOptions options()
Access the SocketOptions used to tune this server socket. The following options apply to TcpListeners:
- receiveBufferSize
- reuseAddr Accessing other option fields will throw UnsupportedErr.