Network.Socket.Options

Documentation is currently lacking. For now, see man 7 socket and man 7 tcp of the Linux man-pages, or look up setsockopt in MSDN.

Getting options

getAcceptConn :: HasSocket sock => sock -> IO Bool

This option is get-only.

getBroadcast :: HasSocket sock => sock -> IO Bool

getDebug :: HasSocket sock => sock -> IO Bool

getDontRoute :: HasSocket sock => sock -> IO Bool

getError :: HasSocket sock => sock -> IO Int

This option is get-only.

getKeepAlive :: HasSocket sock => sock -> IO Bool

getLinger :: HasSocket sock => sock -> IO (Maybe Seconds)

getOOBInline :: HasSocket sock => sock -> IO Bool

getRecvBuf :: HasSocket sock => sock -> IO Int

getRecvTimeout :: HasSocket sock => sock -> IO Microseconds

getReuseAddr :: HasSocket sock => sock -> IO Bool

getSendBuf :: HasSocket sock => sock -> IO Int

getSendTimeout :: HasSocket sock => sock -> IO Microseconds

getType :: HasSocket sock => sock -> IO SocketType

This option is get-only.

TCP

getTcpNoDelay :: HasSocket sock => sock -> IO Bool

Setting options

setBroadcast :: HasSocket sock => sock -> Bool -> IO ()

setDebug :: HasSocket sock => sock -> Bool -> IO ()

setDontRoute :: HasSocket sock => sock -> Bool -> IO ()

setKeepAlive :: HasSocket sock => sock -> Bool -> IO ()

setLinger :: HasSocket sock => sock -> Maybe Seconds -> IO ()

On Windows, the Seconds value is truncated to 16 bits. This means if a linger time of more than 65535 seconds (about 18.2 hours) is given, it will wrap around.

setOOBInline :: HasSocket sock => sock -> Bool -> IO ()

setRecvBuf :: HasSocket sock => sock -> Int -> IO ()

setRecvTimeout :: HasSocket sock => sock -> Microseconds -> IO ()

Note the following about timeout values:

• A value of 0 or less means the operation will never time out
• On Windows, the timeout is truncated to milliseconds, 32-bit. However, if the number of microseconds is from 1 to 999, it will be rounded up to one millisecond, to prevent it from being treated as "never time out".

setReuseAddr :: HasSocket sock => sock -> Bool -> IO ()

setSendBuf :: HasSocket sock => sock -> Int -> IO ()

setSendTimeout :: HasSocket sock => sock -> Microseconds -> IO ()

TCP

setTcpNoDelay :: HasSocket sock => sock -> Bool -> IO ()

Types

class HasSocket a where

The getters and setters in this module can be used not only on Sockets, but on raw Fds (file descriptors) as well.

Methods

getSocket :: a -> CInt

Instances

HasSocket FD

HasSocket Fd

HasSocket Socket

type Seconds = Int

type Microseconds = Int64