Reflex.Backend.Socket.Accept

Use accept to create listen sockets, and get an Event t Socket of new connections.

Documentation

accept

Arguments

:: (Reflex t, PerformEvent t m, PostBuild t m, TriggerEvent t m, MonadIO (Performable m), MonadIO m)

=> AcceptConfig t

-> m (Event t (Either SetupError (Accept t)))

This event will fire exactly once.

Create a listening socket. Sockets are accepted in a background thread.

Listen socket configuration

data AcceptConfig t

Configuration of a listen socket.

Constructors

AcceptConfig

Fields

• _acHostname :: Maybe HostName

  The hostname to bind to. This will often be Nothing, to bind all interfaces.

• _acService :: Maybe ServiceName

  The port number or service name to listen on. See the manpage for getaddrinfo.

• _acListenQueue :: Int

  The length of the "pending connections" queue. See the manpage for listen.

• _acSocketOptions :: [(SocketOption, Int)]

  List of socket options, passed one at a time to setSocketOption. Many people will want [(ReuseAddr, 1)] here.

• _acClose :: Event t ()

  Close the listen socket when this event fires. If you plan to run forever, use never.

Results of accept

data Accept t

Events produced by a running listen socket.

Constructors

Accept

Fields

• _aAcceptSocket :: Event t (Socket, SockAddr)

  A new connection was accepted, including its remote address.

• _aClose :: Event t ()

  The socket has closed. This will fire exactly once when the socket closes for any reason, including if your _acClose event fires or if the socket closes in response to a caught exception.

• _aError :: Event t IOException

  An exception occurred. Treat the socket as closed after you see this. You will see the _aClose event fire as well, but not necessarily in the same frame.

Lenses

AcceptConfig

acHostname :: forall t. Lens' (AcceptConfig t) (Maybe HostName)

acService :: forall t. Lens' (AcceptConfig t) (Maybe ServiceName)

acListenQueue :: forall t. Lens' (AcceptConfig t) Int

acSocketOptions :: forall t. Lens' (AcceptConfig t) [(SocketOption, Int)]

acClose :: forall t t. Lens (AcceptConfig t) (AcceptConfig t) (Event t ()) (Event t ())

Accept

aAcceptSocket :: forall t. Lens' (Accept t) (Event t (Socket, SockAddr))

aClose :: forall t. Lens' (Accept t) (Event t ())

aError :: forall t. Lens' (Accept t) (Event t IOException)