Transit.Internal.Network

build hints (direct and relay) from relay url, port number and the network interfaces.

buildHints :: PortNumber -> RelayEndpoint -> IO (Set ConnectionHint)

Build a client's connection hint

buildRelayHints :: RelayEndpoint -> Set ConnectionHint

The client at the sending side and receiving side may be invoked with different relay hint urls. These get exchanged in the transit message. After successfully receiving the transit message, each client should combine the hints of the peer along with its relay hints to get the full set of hints.

parse and build transit relay hints

parseTransitRelayUri :: String -> Maybe RelayEndpoint

Parse transit url of the form tcp:hostname:port

data RelayEndpoint

Type representing a Relay Endpoint URL

Constructors

RelayEndpoint

Fields

• relayhost :: Text
• relayport :: Word16

Instances

Eq RelayEndpoint

Defined in Transit.Internal.Network

Methods

(==) :: RelayEndpoint -> RelayEndpoint -> Bool

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

Show RelayEndpoint

Defined in Transit.Internal.Network

Methods

showsPrec :: Int -> RelayEndpoint -> ShowS

show :: RelayEndpoint -> String

showList :: [RelayEndpoint] -> ShowS

low level bytestring buffer send/receive over a socket

sendBuffer :: TCPEndpoint -> ByteString -> IO Int

Low level function to send a fixed length bytestring to the peer represented by ep.

recvBuffer :: TCPEndpoint -> Int -> IO ByteString

Low level function to receive a byte buffer of specified length from the peer represented by ep.

TCP Endpoint

closeConnection :: TransitEndpoint -> IO ()

Close the peer network connection.

data TCPEndpoint

A type representing the connected TCP endpoint

Constructors

TCPEndpoint

Fields

• sock :: Socket
• conntype :: Maybe AbilityV1

Instances

Eq TCPEndpoint

Defined in Transit.Internal.Network

Methods

(==) :: TCPEndpoint -> TCPEndpoint -> Bool

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

Show TCPEndpoint

Defined in Transit.Internal.Network

Methods

showsPrec :: Int -> TCPEndpoint -> ShowS

show :: TCPEndpoint -> String

showList :: [TCPEndpoint] -> ShowS

data TransitEndpoint

A type representing an "authenticated" TCP endpoint

Constructors

TransitEndpoint

Fields

• peerEndpoint :: TCPEndpoint
• senderKey :: Key
• receiverKey :: Key

Instances

Eq TransitEndpoint

Defined in Transit.Internal.Network

Methods

(==) :: TransitEndpoint -> TransitEndpoint -> Bool

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

TCP Listener that listens on a random port, Server and Client

tcpListener :: IO Socket

Listen on all the interfaces on a randomly assigned default port

startServer :: Socket -> IO (Either CommunicationError TCPEndpoint)

Accept and return the TCP Endpoint representing the peer

startClient :: [ConnectionHint] -> IO (Either CommunicationError TCPEndpoint)

Try to concurrently connect to the given list of connection hints and return the first peer that succeeds.

Errors

data CommunicationError

Type representing the network protocol errors

Constructors

ConnectionError Text

We could not establish a socket connection.

OfferError Text

Clients could not exchange offer message.

TransitError Text

There was an error in transit protocol exchanges.

Sha256SumError Text

Sender got back a wrong sha256sum from the receiver.

UnknownPeerMessage Text

We could not identify the message from peer.

Instances

Eq CommunicationError

Defined in Transit.Internal.Network

Methods

(==) :: CommunicationError -> CommunicationError -> Bool

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

Show CommunicationError

Defined in Transit.Internal.Network

Methods

showsPrec :: Int -> CommunicationError -> ShowS

show :: CommunicationError -> String

showList :: [CommunicationError] -> ShowS