Modulenetwork-run-0.6.0Haskell2010

Network.Run.TCP

Simple functions to run TCP clients and servers.

2 types
17 values

Packagenetwork-run-0.6.0
Exports19
LanguageHaskell2010
LicenceBSD-3-Clause
SourceTCP.hs

Server

10 declarations

valuerunTCPServer :: Maybe HostName -> ServiceName -> (Socket -> IO a) -> IO a

Running a TCP server with an accepted socket.

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
-> Maybe HostName
-> ServiceName
-> Socket -> IO a
-> IO a

Running a TCP server with the given settings.

valuerunTCPServerWithSocket

:: Socket
A listening socket created by openTCPServerSocket.
-> (Socket -> IO a)
Called for each incoming connection, in a new thread
-> IO a

Running a TCP server on a given listen socket.

valuerunTCPServerWithSocketAndSettings

:: ServerSettings
-> Socket
A listening socket created by openTCPServerSocket.
-> (Socket -> IO a)
Called for each incoming connection, in a new thread
-> IO a

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

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.

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.

valueresolve

Client

9 declarations

valuerunTCPClient :: HostName -> ServiceName -> (Socket -> IO a) -> IO a

Running a TCP client with a connected socket.

This is the same as:

runTCPClientWithSettings defaultSettings

datadata Settings

Settings for client.

valuedefaultSettings :: Settings

Default settings.

valuesettingsOpenClientSocket :: Settings -> AddrInfo -> IO Socket

Opening a socket. Use openClientSocketWithOptions to specify SocketOption

valuesettingsSelectAddrInfo :: Settings -> NonEmpty AddrInfo -> AddrInfo

Selecting AddrInfo.

valuerunTCPClientWithSettings

:: Settings
-> HostName
-> ServiceName
-> Socket -> IO a
-> IO a

Running a TCP client with a connected socket.

valueopenClientSocket :: AddrInfo -> IO Socket

This is the same as

openClientSocketWithOptions []

valueopenClientSocketWithOptions

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

Open a client socket with the given options

The options are set before connect. This is equivalent to

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

valueopenClientSocketWithOpts

Open a client socket with the given options

This must be used rather than openClientSocketWithOptions for options such as Linger which require a composite value (StructLinger).

The options are set before connect.