Network.Socket.ByteString.Lazy

This module provides access to the BSD socket interface. For detailed documentation, consult your favorite POSIX socket reference. All functions communicate failures by converting the error number to an IOError.

This module is made to be imported with Network.Socket like so:

import Network.Socket
import Network.Socket.ByteString.Lazy
import Prelude hiding (getContents)

Send data to a socket

send

Arguments

:: Socket

Connected socket

-> ByteString

Data to send

-> IO Int64

Number of bytes sent

sendAll

Arguments

:: Socket

Connected socket

-> ByteString

Data to send

-> IO ()

sendWithFds

Arguments

:: Socket

Socket

-> ByteString

Data to send

-> [Fd]

File descriptors

-> IO ()

Send data and file descriptors over a UNIX-domain socket in a single system call. This function does not work on Windows.

Receive data from a socket

getContents

Arguments

:: Socket

Connected socket

-> IO ByteString

Data received

Receive data from the socket. The socket must be in a connected state. Data is received on demand, in chunks; each chunk will be sized to reflect the amount of data received by individual recv calls.

All remaining data from the socket is consumed. When there is no more data to be received, the receiving side of the socket is shut down. If there is an error and an exception is thrown, the socket is not shut down.

recv

Arguments

:: Socket

Connected socket

-> Int64

Maximum number of bytes to receive

-> IO ByteString

Data received

Receive data from the socket. The socket must be in a connected state. This function may return fewer bytes than specified. If the received data is longer than the specified length, it may be discarded depending on the type of socket. This function may block until a message arrives.

If there is no more data to be received, returns an empty ByteString.