Network.Mail.Assumpta.Internal.Net

Network operations using the connection package.

Documentation

type Port = Int

type HostName = String

data Handle

Network handle, containing enough information to both communicate a connection, and upgrade to TLS.

Constructors

Handle

Fields

• hConn :: !Connection
• hContext :: !ConnectionContext

Instances

Connection Handle

Defined in Network.Mail.Assumpta.Internal.Net

Associated Types

type Cstrt Handle :: (* -> *) -> Constraint

type Params Handle :: *

Methods

open :: Cstrt Handle m => Params Handle -> m Handle

close :: Cstrt Handle m => Handle -> m ()

send :: Cstrt Handle m => Handle -> ByteString -> m ()

recv :: Cstrt Handle m => Handle -> m ByteString

upgrade :: Cstrt Handle m => Handle -> m ()

type Params Handle

Defined in Network.Mail.Assumpta.Internal.Net

type Params Handle = ConnectionParams

type Cstrt Handle

Defined in Network.Mail.Assumpta.Internal.Net

type Cstrt Handle = MonadIO

defaultTLSSettings :: TLSSettings

default TLS settings

mkParams :: HostName -> Int -> ConnectionParams

openParams :: MonadIO m => ConnectionParams -> m Handle

Open a network Handle with the specified ConnectionParams

open :: MonadIO m => HostName -> Port -> m Handle

Open a network Handle to the specified hostname and port

openTls :: MonadIO m => HostName -> Port -> m Handle

Open a secure network Handle to the specified hostname and port using the default TLS settings (defaultTLSSettings)

close :: MonadIO m => Handle -> m ()

Close a network Handle

withHandleParams :: (MonadMask m, MonadIO m) => ConnectionParams -> (Handle -> m b) -> m b

withHandleParams p a

Given some parameters p (hostname, port etc) for opening a Handle: open a handle, run some action a with it, then close.

withHandle :: (MonadMask m, MonadIO m) => HostName -> Port -> (Handle -> m b) -> m b

withHandle hostname port a

Open a Handle to the specified hostname and port, run some action a with it, then close.

withSecureHandle :: (MonadMask m, MonadIO m) => HostName -> Port -> (Handle -> m b) -> m b

withSecureHandle hostname port a

Open a secure Handle to the specified hostname and port, run some action a with it, then close.