Modulenetwork-run-0.6.0Haskell2010

Network.Run.TCP.Timeout

Simple functions to run TCP servers.

2 types
9 values

Packagenetwork-run-0.6.0
Exports11
LanguageHaskell2010
LicenceBSD-3-Clause
SourceTimeout.hs

valuerunTCPServer

:: Int
Timeout in second.
-> Maybe HostName
-> ServiceName
-> TimeoutServer ()
-> IO ()

Running a TCP server, resolving and binding the address itself.

Only the first address returned for mhost is used, so a server created by this function listens on a single address family. Use runTCPServerWithSocket with one socket per address to serve both IPv4 and IPv6.

valuerunTCPServerWithSettings

:: ServerSettings
-> Int
Timeout in second.
-> Maybe HostName
-> ServiceName
-> TimeoutServer ()
-> IO ()

Running a TCP server with the given settings.

typetype TimeoutServer a = Manager -> Handle -> Socket -> IO a

A server type

datadata ServerSettings

Settings for servers.

Fields which do not apply to a given server (for instance the graceful close timeout for a UDP server) are ignored.

Constructors

ServerSettings
- settingsOnException :: Maybe SockAddr -> SomeException -> IO ()
  Called when an exception is caught by the library instead of being propagated. The SockAddr is Just the peer when the exception can be attributed to one. Exceptions thrown by this action itself are discarded, so it must not be relied on for anything but reporting. The default does nothing.
- settingsGracefulCloseTimeout :: Int
  Milliseconds gracefulClose waits for the peer's FIN after a connection handler returns. Zero or less uses close instead, which releases the file descriptor immediately. The default is 5000.
- settingsAcceptRetryDelay :: Int
  Microseconds to wait before retrying accept after running out of file descriptors. The default is 100000.

valuedefaultServerSettings :: ServerSettings

Default settings. settingsOnException does nothing, so the behaviour is the same as before this type was introduced.

valueresolve

Generalized API

5 declarations

valuerunTCPServerWithSocket

:: Int
Timeout in second.
-> Socket
A listening socket created by openTCPServerSocket.
-> TimeoutServer ()
-> IO ()

Running a TCP server on a given listen socket.

valuerunTCPServerWithSocketAndSettings

:: ServerSettings
-> Int
Timeout in second.
-> Socket
A listening socket created by openTCPServerSocket.
-> TimeoutServer ()
-> IO ()

Running a TCP server on a given listen socket with the given settings.

valueopenTCPServerSocket :: AddrInfo -> IO Socket

Open TCP socket for server use.

This is the same as:

openTCPServerSocketWithOptions []

valueopenTCPServerSocketWithOptions

:: [(SocketOption, Int)]
-> AddrInfo
-> IO Socket

Open socket for server use, and set the provided options before binding.

This is openServerSocketWithOpts followed by listen with a queue length of 1024. See openServerSocketWithOpts for the options which are set in addition to the given ones.

This is equivalent to

openTCPServerSocketWithOpts . map (second (SockOptValue . fromIntegral @Int @CInt))

valueopenTCPServerSocketWithOpts

Open socket for server use, and set the provided options before binding.

This is openServerSocketWithOpts followed by listen with a queue length of 1024. See openServerSocketWithOpts for the options which are set in addition to the given ones.