Data.Streaming.Network · streaming-commons-0.2.3.0

Types

8 declarations

datadata ServerSettings

#

Settings for a TCP server. It takes a port to listen on, and an optional hostname to bind to.

Instances3HasAfterBind, HasPort, HasReadBufferSize

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

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

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

datadata Message

#

Representation of a single UDP message

Constructors

Message
- msgData :: !ByteString
- msgSender :: !SockAddr

datadata AppData

#

The data passed to an Application.

Instances1HasReadWrite

HasReadWrite AppDataDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network

datadata ServerSettingsUnix

#

Settings for a Unix domain sockets server.

Instances3HasAfterBind, HasPath, HasReadBufferSize

HasAfterBind ServerSettingsUnixDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network
HasPath ServerSettingsUnixDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network
HasReadBufferSize ServerSettingsUnixDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network
Since 0.1.13

datadata ClientSettingsUnix

#

Settings for a Unix domain sockets client.

Instances2HasPath, HasReadBufferSize

HasPath ClientSettingsUnixDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network
HasReadBufferSize ClientSettingsUnixDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network
Since 0.1.14

datadata AppDataUnix

#

The data passed to a Unix domain sockets Application.

Instances1HasReadWrite

HasReadWrite AppDataUnixDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network

Smart constructors

valueserverSettingsTCP

:: Int
port to bind to
-> HostPreference
host binding preferences
-> ServerSettings

#

Smart constructor.

valueserverSettingsTCPSocket :: Socket -> ServerSettings

#

Create a server settings that uses an already available listening socket. Any port and host modifications made to this value will be ignored.

Since 0.1.1

valueclientSettingsTCP

:: Int
port to connect to
-> ByteString
host to connect to
-> ClientSettings

#

Smart constructor.

valueserverSettingsUDP

:: Int
port to bind to
-> HostPreference
host binding preferences
-> ServerSettings

#

Smart constructor.

valueclientSettingsUDP

:: Int
port to connect to
-> ByteString
host to connect to
-> ClientSettings

#

Smart constructor.

valueserverSettingsUnix

:: FilePath
path to bind to
-> ServerSettingsUnix

#

Smart constructor.

valueclientSettingsUnix

:: FilePath
path to connect to
-> ClientSettingsUnix

#

Smart constructor.

valuemessage :: ByteString -> SockAddr -> Message

#

Classes

classclass HasPort a where

#

Methods

portLens :: Functor f => (Int -> f Int) -> a -> f a

Instances2HasPort

HasPort ClientSettingsDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network
HasPort ServerSettingsDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network

classclass HasAfterBind a where

#

Methods

afterBindLens :: Functor f => ((Socket -> IO ()) -> f (Socket -> IO ())) -> a -> f a

Instances2HasAfterBind

HasAfterBind ServerSettingsDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network
HasAfterBind ServerSettingsUnixDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network

classclass HasReadWrite a where

#

Methods

readLens :: Functor f => (IO ByteString -> f (IO ByteString)) -> a -> f a
writeLens :: Functor f => ((ByteString -> IO ()) -> f (ByteString -> IO ())) -> a -> f a

Instances2HasReadWrite

HasReadWrite AppDataDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network
HasReadWrite AppDataUnixDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network

classclass HasReadBufferSize a where

#

Since 0.1.13

Methods

readBufferSizeLens :: Functor f => (Int -> f Int) -> a -> f a

Instances4HasReadBufferSize

HasReadBufferSize ClientSettingsDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network
Since 0.1.13
HasReadBufferSize ClientSettingsUnixDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network
Since 0.1.14
HasReadBufferSize ServerSettingsDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network
Since 0.1.13
HasReadBufferSize ServerSettingsUnixDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network
Since 0.1.13

classclass HasPath a where

#

Methods

pathLens :: Functor f => (FilePath -> f FilePath) -> a -> f a

Instances2HasPath

HasPath ClientSettingsUnixDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network
HasPath ServerSettingsUnixDefined in streaming-commons-0.2.3.0 · Data.Streaming.Network

Setters

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

#

valuesetHost :: ByteString -> ClientSettings -> ClientSettings

#

valuesetAddrFamily :: Family -> ClientSettings -> ClientSettings

#

Set the address family for the given settings.

Since 0.1.3

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

#

valuesetNeedLocalAddr :: Bool -> ServerSettings -> ServerSettings

#

valuesetReadBufferSize :: HasReadBufferSize a => Int -> a -> a

#

Set buffer size used when reading from socket.

Since 0.1.13

valuesetPath :: HasPath a => FilePath -> a -> a

#

Getters

valuegetPort :: HasPort a => a -> Int

#

valuegetHost :: ClientSettings -> ByteString

#

valuegetAddrFamily :: ClientSettings -> Family

#

Get the address family for the given settings.

Since 0.1.3

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

#

valuegetNeedLocalAddr :: ServerSettings -> Bool

#

valuegetReadBufferSize :: HasReadBufferSize a => a -> Int

#

Get buffer size used when reading from socket.

Since 0.1.13

valuegetPath :: HasPath a => a -> FilePath

#

valueappRead :: HasReadWrite a => a -> IO ByteString

#

valueappWrite :: HasReadWrite a => a -> ByteString -> IO ()

#

valueappSockAddr :: AppData -> SockAddr

#

valueappLocalAddr :: AppData -> Maybe SockAddr

#

valueappCloseConnection :: AppData -> IO ()

#

Close the underlying connection. One possible use case is simulating connection failures in a test suite.

Since 0.1.6

valueappRawSocket :: AppData -> Maybe Socket

#

Get the raw socket for this AppData, if available.

Since 0.1.12

Functions

0 declarations

General

valuebindPortGen :: SocketType -> Int -> HostPreference -> IO Socket

#

Attempt to bind a listening Socket on the given host/port using given SocketType. If no host is given, will use the first address available.

valuebindPortGenEx

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

#

Attempt to bind a listening Socket on the given host/port using given socket options and SocketType. If no host is given, will use the first address available.

Since 0.1.17

valuebindRandomPortGen :: SocketType -> HostPreference -> IO (Int, Socket)

#

Bind to a random port number. Especially useful for writing network tests.

Since 0.1.1

valuegetSocketGen :: SocketType -> String -> Int -> IO (Socket, AddrInfo)

#

Attempt to connect to the given host/port using given SocketType.

valuegetSocketFamilyGen

:: SocketType
-> String
-> Int
-> Family
-> IO (Socket, AddrInfo)

#

Attempt to connect to the given hostportaddress family using given SocketType.

Since 0.1.3

valueacceptSafe :: Socket -> IO (Socket, SockAddr)

#

Try to accept a connection, recovering automatically from exceptions.

As reported by Kazu against Warp, "resource exhausted (Too many open files)" may be thrown by accept(). This function will catch that exception, wait a second, and then try again.

valueunassignedPorts :: UArray Int Int

#

valuegetUnassignedPort :: IO Int

#

Get a port from the IANA list of unassigned ports.

Internally, this function uses an IORef to cycle through the list of ports

TCP

valuebindPortTCP :: Int -> HostPreference -> IO Socket

#

Attempt to bind a listening Socket on the given host/port. If no host is given, will use the first address available. maxListenQueue is topically 128 which is too short for high performance servers. So, we specify 'max 2048 maxListenQueue' to the listen queue.

valuebindRandomPortTCP :: HostPreference -> IO (Int, Socket)

#

Bind a random TCP port.

See bindRandomPortGen.

Since 0.1.1

valuegetSocketTCP :: ByteString -> Int -> IO (Socket, SockAddr)

#

Attempt to connect to the given host/port.

valuegetSocketFamilyTCP :: ByteString -> Int -> Family -> IO (Socket, SockAddr)

#

Attempt to connect to the given hostportaddress family.

Since 0.1.3

valuesafeRecv :: Socket -> Int -> IO ByteString

#

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.

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

#

Run an Application by connecting to the specified server.

typetype ConnectionHandle = Socket -> SockAddr -> Maybe SockAddr -> IO ()

#

valuerunTCPServerWithHandle :: ServerSettings -> ConnectionHandle -> IO a

#

UDP

valuebindPortUDP :: Int -> HostPreference -> IO Socket

#

Attempt to bind a listening Socket on the given host/port. If no host is given, will use the first address available.

valuebindRandomPortUDP :: HostPreference -> IO (Int, Socket)

#

Bind a random UDP port.

See bindRandomPortGen

Since 0.1.1

valuegetSocketUDP :: String -> Int -> IO (Socket, AddrInfo)

#

Attempt to connect to the given host/port.

Unix

valuebindPath :: FilePath -> IO Socket

#

Attempt to bind a listening Unix domain socket at the given path.

valuegetSocketUnix :: FilePath -> IO Socket

#

Attempt to connect to the given Unix domain socket path.

valuerunUnixServer :: ServerSettingsUnix -> (AppDataUnix -> 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.

valuerunUnixClient :: ClientSettingsUnix -> (AppDataUnix -> IO a) -> IO a

#

Run an Application by connecting to the specified server.