Copyright	(c) Eric Mertens 2016
License	ISC
Maintainer	emertens@gmail.com
Safe Haskell	None
Language	Haskell2010

Hookup

Contents

Configuration
Connections
Errors

Description

This module provides a uniform interface to network connections with optional support for TLS and SOCKS.

Synopsis

Configuration

data ConnectionParams Source #

Parameters for connect.

Constructors

ConnectionParams
Fields cpFamily :: Family IP Protocol family (default `AF_UNSPEC`) cpHost :: HostName Destination host cpPort :: PortNumber Destination TCP port cpSocks :: Maybe SocksParams Optional SOCKS5 parameters cpTls :: Maybe TlsParams Optional TLS parameters

data SocksParams Source #

SOCKS5 connection parameters

Constructors

SocksParams
Fields spHost :: HostName SOCKS server host spPort :: PortNumber SOCKS server port

data TlsParams Source #

TLS connection parameters. These parameters are passed to OpenSSL when making a secure connection.

Constructors

TlsParams
Fields tpClientCertificate :: Maybe FilePath Path to client certificate tpClientPrivateKey :: Maybe FilePath Path to client private key tpServerCertificate :: Maybe FilePath Path to CA certificate bundle tpCipherSuite :: String OpenSSL cipher suite name (e.g. HIGH) tpInsecure :: Bool Disables certificate checking

defaultFamily :: Family Source #

Default Family value is unspecified and allows both INET and INET6.

Connections

data Connection Source #

A connection to a network service along with its read buffer used for line-oriented protocols. The connection could be a plain network connection, SOCKS connected, or TLS.

connect :: ConnectionParams -> IO Connection Source #

Open network connection to TCP service specified by the given parameters.

Throws IOError, SocksError, ProtocolError, ConnectionFailure

recvLine :: Connection -> Int -> IO (Maybe ByteString) Source #

Receive a line from the network connection. Both "\r\n" and "\n" are recognized.

Returning Nothing means that the peer has closed its half of the connection.

Unterminated lines will raise a LineTruncated exception. This can happen if the peer transmits some data and closes its end without transmitting a line terminator.

Throws: ConnectionAbruptlyTerminated, ConnectionFailure, IOError

send :: Connection -> ByteString -> IO () Source #

Send bytes on the network connection.

Throws: IOError, ProtocolError

close :: Connection -> IO () Source #

Close network connection.

Errors

data ConnectionFailure Source #

Type for errors that can be thrown by this package.

Constructors

HostnameResolutionFailure IOError	Failure during `getAddrInfo` resolving remote host
ConnectionFailure [IOError]	Failure during `connect` to remote host
LineTooLong	Failure during `recvLine`
LineTruncated	Incomplete line during `recvLine`

Instances

Show ConnectionFailure Source #
Methods showsPrec :: Int -> ConnectionFailure -> ShowS # show :: ConnectionFailure -> String # showList :: [ConnectionFailure] -> ShowS #
Exception ConnectionFailure Source #	`displayException` implemented for prettier messages
Methods toException :: ConnectionFailure -> SomeException # fromException :: SomeException -> Maybe ConnectionFailure # displayException :: ConnectionFailure -> String #