Socket.Stream.IPv4

Types

data Listener

A socket that listens for incomming connections.

data Connection

A connection-oriented stream socket.

data Endpoint

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.

Constructors

Endpoint

Fields

• address :: !IPv4
• port :: !Word16

Instances

Eq Endpoint

Defined in Socket.IPv4

Methods

(==) :: Endpoint -> Endpoint -> Bool

(/=) :: Endpoint -> Endpoint -> Bool

Show Endpoint

Defined in Socket.IPv4

Methods

showsPrec :: Int -> Endpoint -> ShowS

show :: Endpoint -> String

showList :: [Endpoint] -> ShowS

Bracketed

withListener :: Endpoint -> (Listener -> Word16 -> IO a) -> IO (Either SocketException a)

withAccepted :: Listener -> (Connection -> Endpoint -> IO a) -> IO (Either SocketException a)

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).

withConnection

Arguments

:: Endpoint

Remote endpoint

-> (Connection -> IO a)

Callback to consume connection

-> IO (Either SocketException a)

Establish a connection to a server.

forkAccepted :: Listener -> (Either SocketException a -> IO ()) -> (Connection -> Endpoint -> IO a) -> IO (Either SocketException ThreadId)

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.

forkAcceptedUnmasked :: Listener -> (Either SocketException a -> IO ()) -> (Connection -> Endpoint -> IO a) -> IO (Either SocketException ThreadId)

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.

Communicate

sendByteArray

Arguments

:: Connection

Connection

-> ByteArray

Buffer (will be sliced)

-> IO (Either SocketException ())

sendByteArraySlice

Arguments

:: Connection

Connection

-> ByteArray

Buffer (will be sliced)

-> Int

Offset into payload

-> Int

Lenth of slice into buffer

-> IO (Either SocketException ())

sendMutableByteArray

Arguments

:: Connection

Connection

-> MutableByteArray RealWorld

Buffer (will be sliced)

-> IO (Either SocketException ())

sendMutableByteArraySlice

Arguments

:: Connection

Connection

-> MutableByteArray RealWorld

Buffer (will be sliced)

-> Int

Offset into payload

-> Int

Lenth of slice into buffer

-> IO (Either SocketException ())

receiveByteArray

Arguments

:: Connection

Connection

-> Int

Number of bytes to receive

-> IO (Either SocketException ByteArray)

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 (SocketException Receive RemoteShutdown).

receiveBoundedByteArray

Arguments

:: Connection

Connection

-> Int

Maximum number of bytes to receive

-> IO (Either SocketException ByteArray)

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).

receiveMutableByteArray :: Connection -> MutableByteArray RealWorld -> IO (Either SocketException ())

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).

Exceptions

data SocketException

Represents any unexpected behaviors that a function working on a socket, connection, or listener can exhibit.

Constructors

SocketException

Fields

• context :: Context
• reason :: Reason

Instances

Eq SocketException

Defined in Socket

Methods

(==) :: SocketException -> SocketException -> Bool

(/=) :: SocketException -> SocketException -> Bool

Show SocketException

Defined in Socket

Methods

showsPrec :: Int -> SocketException -> ShowS

show :: SocketException -> String

showList :: [SocketException] -> ShowS

Exception SocketException

Defined in Socket

Methods

toException :: SocketException -> SomeException

fromException :: SomeException -> Maybe SocketException

displayException :: SocketException -> String

data Context

The function that behaved unexpectedly.

Constructors

Accept

Bind

Close

Connect

GetName

Listen

Open

Option

Receive

Send

Shutdown

Instances

Eq Context

Defined in Socket

Methods

(==) :: Context -> Context -> Bool

(/=) :: Context -> Context -> Bool

Show Context

Defined in Socket

Methods

showsPrec :: Int -> Context -> ShowS

show :: Context -> String

showList :: [Context] -> ShowS

data Reason

A description of the unexpected behavior.

Constructors

MessageTruncated !Int !Int

The datagram did not fit in the buffer. This can happen while sending or receiving. Fields: buffer size, datagram size.

SocketAddressSize

The socket address was not the expected size. This exception indicates a bug in this library or (less likely) in the operating system.

SocketAddressFamily

The socket address had an unexpected family. This exception indicates a bug in this library or (less likely) in the operating system.

OptionValueSize

The option value was not the expected size. This exception indicates a bug in this library or (less likely) in the operating system.

NegativeBytesRequested

The user requested a negative number of bytes in a call to a receive function.

RemoteNotShutdown

The remote end sent more data when it was expected to send a shutdown.

RemoteShutdown

The remote end has shutdown its side of the full-duplex connection. This can happen receive is called on a stream socket. This is not necessarily a bad thing. Many protocols use shutdown to indicate that no more data is available. These protocols can be contrasted with protocols that send a length representing a number of expected bytes.

ErrorCode !CInt

Any error code from the operating system that this library does not expect or recognize. Consult your operating system manual for details about the error code.

Instances

Eq Reason

Defined in Socket

Methods

(==) :: Reason -> Reason -> Bool

(/=) :: Reason -> Reason -> Bool

Show Reason

Defined in Socket

Methods

showsPrec :: Int -> Reason -> ShowS

show :: Reason -> String

showList :: [Reason] -> ShowS