Data.Conduit.Network · conduit-extra-1.3.8

HasAfterBind ServerSettingsDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network
HasPort ServerSettingsDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network
HasReadBufferSize ServerSettingsDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network
Since 0.1.13

valueserverSettings :: Int -> HostPreference -> ServerSettings

#

valuerunTCPServer :: ServerSettings -> (AppData -> IO ()) -> IO a

#

Run an Application with the given settings. This function will create a new listening socket, accept connections on it, and spawn a new thread for each connection.

valuerunTCPServerWithHandle :: ServerSettings -> ConnectionHandle -> IO a

#

valueforkTCPServer

:: MonadUnliftIO m
=> ServerSettings
-> AppData -> m ()
-> m ThreadId

#

Fork a TCP Server

Will fork the runGeneralTCPServer function but will only return from this call when the server is bound to the port and accepting incoming connections. Will return the thread id of the server

Since 1.1.4

valuerunGeneralTCPServer

:: MonadUnliftIO m
=> ServerSettings
-> AppData -> m ()
-> m a

#

Run a general TCP server

Same as runTCPServer, except monad can be any instance of MonadUnliftIO.

Note that any changes to the monadic state performed by individual client handlers will be discarded. If you have mutable state you want to share among multiple handlers, you need to use some kind of mutable variables.

Since 1.1.3

Client

datadata ClientSettings

#

Settings for a TCP client, specifying how to connect to the server.

Instances2HasPort, HasReadBufferSize

HasPort ClientSettingsDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network
HasReadBufferSize ClientSettingsDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network
Since 0.1.13

valueclientSettings :: Int -> ByteString -> ClientSettings

#

valuerunTCPClient :: ClientSettings -> (AppData -> IO a) -> IO a

#

Run an Application by connecting to the specified server.

valuerunGeneralTCPClient

:: MonadUnliftIO m
=> ClientSettings
-> AppData -> m a
-> m a

#

Run a general TCP client

Same as runTCPClient, except monad can be any instance of MonadUnliftIO.

Since 1.1.3

Getters

valuegetPort :: HasPort a => a -> Int

#

valuegetHost :: ClientSettings -> ByteString

#

valuegetAfterBind :: HasAfterBind a => a -> Socket -> IO ()

#

valuegetNeedLocalAddr :: ServerSettings -> Bool

#

Setters

valuesetPort :: HasPort a => Int -> a -> a

#

valuesetHost :: ByteString -> ClientSettings -> ClientSettings

#

valuesetAfterBind :: HasAfterBind a => (Socket -> IO ()) -> a -> a

#

valuesetNeedLocalAddr :: Bool -> ServerSettings -> ServerSettings

#

Types

1 declaration

datadata HostPreference

#

Which host to bind.

Note: The IsString instance recognizes the following special values:

* means HostAny - "any IPv4 or IPv6 hostname"
*4 means HostIPv4 - "any IPv4 or IPv6 hostname, IPv4 preferred"
!4 means HostIPv4Only - "any IPv4 hostname"
*6 means HostIPv6@ - "any IPv4 or IPv6 hostname, IPv6 preferred"
!6 means HostIPv6Only - "any IPv6 hostname"

Note that the permissive * values allow binding to an IPv4 or an IPv6 hostname, which means you might be able to successfully bind to a port more times than you expect (eg once on the IPv4 localhost 127.0.0.1 and again on the IPv6 localhost 0:0:0:0:0:0:0:1).

Any other value is treated as a hostname. As an example, to bind to the IPv4 local host only, use "127.0.0.1".

Instances5Eq, Ord, Read, Show, IsString

Eq HostPreferenceDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network.Internal
Ord HostPreferenceDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network.Internal
Read HostPreferenceDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network.Internal
Show HostPreferenceDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network.Internal
IsString HostPreferenceDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network.Internal