A socket that listens for incomming connections.

A connection-oriented stream socket.

An endpoint for an IPv4 socket, connection, or listener. Everything is in host byte order, and the user is not responisble for performing any conversions.

Accept a connection on the listener and run the supplied callback on it. This closes the connection when the callback finishes or if an exception is thrown. Since this function blocks the thread until the callback finishes, it is only suitable for stream socket clients that handle one connection at a time. The variant forkAcceptedUnmasked is preferrable for servers that need to handle connections concurrently (most use cases).

Establish a connection to a server.

Accept a connection on the listener and run the supplied callback in a new thread. Prefer forkAcceptedUnmasked unless the masking state needs to be preserved for the callback. Such a situation seems unlikely to the author.

Accept a connection on the listener and run the supplied callback in a new thread. The masking state is set to Unmasked when running the callback. Typically, a is instantiated to ().

Accept a connection on the listener and run the supplied callback in a new thread. The masking state is set to Unmasked when running the callback. Typically, a is instantiated to ().

Discussion

(isReady,deregister) <- threadWaitReadSTM fd
shouldReceive <- atomically $ do
  readTVar abandon >>= \case
    True -> do
      isReady
      modifyTVar' counter (+1)
      pure True
    False -> pure False

Send a ByteString over a connection.

Send a lazy ByteString over a connection.

Receive exactly the given number of bytes. If the remote application shuts down its end of the connection before sending the required number of bytes, this returns Left ReceiveShutdown.

Receive up to the given number of bytes. If the remote application shuts down its end of the connection instead of sending any bytes, this returns Left (SocketException Receive RemoteShutdown).

Receive up to the given number of bytes, using the given array and starting at the given offset.

Receive a number of bytes exactly equal to the size of the mutable byte array. If the remote application shuts down its end of the connection before sending the required number of bytes, this returns Left (SocketException Receive RemoteShutdown).

Receive exactly the given number of bytes.

Variant of receiveByteArray that support STM-style interrupts.

Receive up to the given number of bytes, using the given array and starting at the given offset. This can be interrupted by the completion of an STM transaction.

Recoverable exceptions that can occur while receiving data on a stream socket.

Discussion

Recoverable exceptions that can occur while connecting to a peer. This includes both failures while opening the socket and failures while connecting to the peer.

Discussion

Recoverable exceptions that happen when establishing an internet-domain stream listener or datagram socket.

Discussion

Recoverable exceptions that can occur while accepting an inbound connection.

Open a socket that can be used to listen for inbound connections. Requirements:

• This function may only be called in contexts where exceptions are masked.
• The caller must be sure to call unlistener on the resulting Listener exactly once to close underlying file descriptor.
• The Listener cannot be used after being given as an argument to unlistener.

Noncompliant use of this function leads to undefined behavior. Prefer withListener unless you are writing an integration with a resource-management library.

Close a listener. This throws an unrecoverable exception if the socket cannot be closed.

Close a listener. This does not check to see whether or not the operating system successfully closed the socket. It never throws exceptions of any kind. This should only be preferred to unlistener in exception-cleanup contexts where there is already an exception that will be rethrown. See the implementation of withListener for an example of appropriate use of both unlistener and unlistener_.

Open a socket and connect to a peer. Requirements:

• This function may only be called in contexts where exceptions are masked.
• The caller must be sure to call disconnect or disconnect_ on the resulting Connection exactly once to close underlying file descriptor.
• The Connection cannot be used after being given as an argument to disconnect or disconnect_.

Noncompliant use of this function leads to undefined behavior. Prefer withConnection unless you are writing an integration with a resource-management library.

Variant of connect that is interruptible using STM-style interrupts.

Close a connection gracefully, reporting a CloseException when the connection has to be terminated by sending a TCP reset. This uses a combination of shutdown, recv, close to detect when resets need to be sent.

Close a connection. This does not check to see whether or not the connection was brought down gracefully. It just calls close and is likely to cause a TCP reset to be sent. It never throws exceptions of any kind (even if close fails). This should only be preferred to disconnect in exception-cleanup contexts where there is already an exception that will be rethrown. See the implementation of withConnection for an example of appropriate use of both disconnect and disconnect_.

Listen for an inbound connection.

Listen for an inbound connection. Can be interrupted by an STM-style interrupt.