| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Network.Transport
Contents
Description
Network Transport
Synopsis
- data Transport = Transport {}
- data EndPoint = EndPoint {
- receive :: IO Event
- address :: EndPointAddress
- connect :: EndPointAddress -> Reliability -> ConnectHints -> IO (Either (TransportError ConnectErrorCode) Connection)
- newMulticastGroup :: IO (Either (TransportError NewMulticastGroupErrorCode) MulticastGroup)
- resolveMulticastGroup :: MulticastAddress -> IO (Either (TransportError ResolveMulticastGroupErrorCode) MulticastGroup)
- closeEndPoint :: IO ()
- data Connection = Connection {
- send :: [ByteString] -> IO (Either (TransportError SendErrorCode) ())
- close :: IO ()
- data Event
- type ConnectionId = Word64
- data Reliability
- data MulticastGroup = MulticastGroup {
- multicastAddress :: MulticastAddress
- deleteMulticastGroup :: IO ()
- maxMsgSize :: Maybe Int
- multicastSend :: [ByteString] -> IO ()
- multicastSubscribe :: IO ()
- multicastUnsubscribe :: IO ()
- multicastClose :: IO ()
- newtype EndPointAddress = EndPointAddress {}
- newtype MulticastAddress = MulticastAddress {}
- data ConnectHints = ConnectHints {}
- defaultConnectHints :: ConnectHints
- data TransportError error = TransportError error String
- data NewEndPointErrorCode
- data ConnectErrorCode
- data NewMulticastGroupErrorCode
- data ResolveMulticastGroupErrorCode
- data SendErrorCode
- data EventErrorCode
Types
To create a network abstraction layer, use one of the
Network.Transport.* packages.
Constructors
| Transport | |
Fields
| |
Network endpoint.
Constructors
| EndPoint | |
Fields
| |
data Connection Source #
Lightweight connection to an endpoint.
Constructors
| Connection | |
Fields
| |
Event on an endpoint.
Constructors
| Received !ConnectionId [ByteString] | Received a message |
| ConnectionClosed !ConnectionId | Connection closed |
| ConnectionOpened !ConnectionId Reliability EndPointAddress | Connection opened
|
| ReceivedMulticast MulticastAddress [ByteString] | Received multicast |
| EndPointClosed | The endpoint got closed (manually, by a call to closeEndPoint or closeTransport) |
| ErrorEvent (TransportError EventErrorCode) | An error occurred |
Instances
type ConnectionId = Word64 Source #
Connection data ConnectHintsIDs enable receivers to distinguish one connection from another.
data Reliability Source #
Reliability guarantees of a connection.
Constructors
| ReliableOrdered | |
| ReliableUnordered | |
| Unreliable |
Instances
| Generic Reliability Source # | |
Defined in Network.Transport Associated Types type Rep Reliability :: Type -> Type # | |
| Show Reliability Source # | |
Defined in Network.Transport Methods showsPrec :: Int -> Reliability -> ShowS # show :: Reliability -> String # showList :: [Reliability] -> ShowS # | |
| Binary Reliability Source # | |
Defined in Network.Transport | |
| Eq Reliability Source # | |
Defined in Network.Transport | |
| type Rep Reliability Source # | |
Defined in Network.Transport type Rep Reliability = D1 ('MetaData "Reliability" "Network.Transport" "network-transport-0.5.6-4WmRwHnr2PED3ASf68u0Pm" 'False) (C1 ('MetaCons "ReliableOrdered" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ReliableUnordered" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Unreliable" 'PrefixI 'False) (U1 :: Type -> Type))) | |
data MulticastGroup Source #
Multicast group.
Constructors
| MulticastGroup | |
Fields
| |
newtype EndPointAddress Source #
EndPointAddress of an endpoint.
Constructors
| EndPointAddress | |
Fields | |
Instances
newtype MulticastAddress Source #
EndPointAddress of a multicast group.
Constructors
| MulticastAddress | |
Fields | |
Instances
Hints
defaultConnectHints :: ConnectHints Source #
Default hints for connecting
Error codes
data TransportError error Source #
Errors returned by Network.Transport API functions consist of an error code and a human readable description of the problem
Constructors
| TransportError error String |
Instances
data NewEndPointErrorCode Source #
Errors during the creation of an endpoint
Constructors
| NewEndPointInsufficientResources | Not enough resources |
| NewEndPointFailed | Failed for some other reason |
Instances
| Show NewEndPointErrorCode Source # | |
Defined in Network.Transport Methods showsPrec :: Int -> NewEndPointErrorCode -> ShowS # show :: NewEndPointErrorCode -> String # showList :: [NewEndPointErrorCode] -> ShowS # | |
| Eq NewEndPointErrorCode Source # | |
Defined in Network.Transport Methods (==) :: NewEndPointErrorCode -> NewEndPointErrorCode -> Bool # (/=) :: NewEndPointErrorCode -> NewEndPointErrorCode -> Bool # | |
data ConnectErrorCode Source #
Connection failure
Constructors
| ConnectNotFound | Could not resolve the address |
| ConnectInsufficientResources | Insufficient resources (for instance, no more sockets available) |
| ConnectTimeout | Timeout |
| ConnectFailed | Failed for other reasons (including syntax error) |
Instances
| Show ConnectErrorCode Source # | |
Defined in Network.Transport Methods showsPrec :: Int -> ConnectErrorCode -> ShowS # show :: ConnectErrorCode -> String # showList :: [ConnectErrorCode] -> ShowS # | |
| Eq ConnectErrorCode Source # | |
Defined in Network.Transport Methods (==) :: ConnectErrorCode -> ConnectErrorCode -> Bool # (/=) :: ConnectErrorCode -> ConnectErrorCode -> Bool # | |
data NewMulticastGroupErrorCode Source #
Failure during the creation of a new multicast group
Constructors
| NewMulticastGroupInsufficientResources | Insufficient resources |
| NewMulticastGroupFailed | Failed for some other reason |
| NewMulticastGroupUnsupported | Not all transport implementations support multicast |
Instances
| Show NewMulticastGroupErrorCode Source # | |
Defined in Network.Transport Methods showsPrec :: Int -> NewMulticastGroupErrorCode -> ShowS # show :: NewMulticastGroupErrorCode -> String # showList :: [NewMulticastGroupErrorCode] -> ShowS # | |
| Eq NewMulticastGroupErrorCode Source # | |
Defined in Network.Transport Methods (==) :: NewMulticastGroupErrorCode -> NewMulticastGroupErrorCode -> Bool # (/=) :: NewMulticastGroupErrorCode -> NewMulticastGroupErrorCode -> Bool # | |
data ResolveMulticastGroupErrorCode Source #
Failure during the resolution of a multicast group
Constructors
| ResolveMulticastGroupNotFound | Multicast group not found |
| ResolveMulticastGroupFailed | Failed for some other reason (including syntax error) |
| ResolveMulticastGroupUnsupported | Not all transport implementations support multicast |
Instances
| Show ResolveMulticastGroupErrorCode Source # | |
Defined in Network.Transport Methods showsPrec :: Int -> ResolveMulticastGroupErrorCode -> ShowS # show :: ResolveMulticastGroupErrorCode -> String # showList :: [ResolveMulticastGroupErrorCode] -> ShowS # | |
| Eq ResolveMulticastGroupErrorCode Source # | |
Defined in Network.Transport | |
data SendErrorCode Source #
Failure during sending a message
Constructors
| SendClosed | Connection was closed |
| SendFailed | Send failed for some other reason |
Instances
| Show SendErrorCode Source # | |
Defined in Network.Transport Methods showsPrec :: Int -> SendErrorCode -> ShowS # show :: SendErrorCode -> String # showList :: [SendErrorCode] -> ShowS # | |
| Eq SendErrorCode Source # | |
Defined in Network.Transport Methods (==) :: SendErrorCode -> SendErrorCode -> Bool # (/=) :: SendErrorCode -> SendErrorCode -> Bool # | |
data EventErrorCode Source #
Error codes used when reporting errors to endpoints (through receive)
Constructors
| EventEndPointFailed | Failure of the entire endpoint |
| EventTransportFailed | Transport-wide fatal error |
| EventConnectionLost EndPointAddress | We lost connection to another endpoint Although Network.Transport provides multiple independent lightweight connections between endpoints, those connections cannot fail independently: once one connection has failed, all connections, in both directions, must now be considered to have failed; they fail as a "bundle" of connections, with only a single "bundle" of connections per endpoint at any point in time. That is, suppose there are multiple connections in either direction between endpoints A and B, and A receives a notification that it has lost contact with B. Then A must not be able to send any further messages to B on existing connections. Although B may not realize immediately that its connection to A has been broken, messages sent by B on existing connections should not be delivered, and B must eventually get an EventConnectionLost message, too. Moreover, this event must be posted before A has successfully reconnected (in other words, if B notices a reconnection attempt from A, it must post the EventConnectionLost before acknowledging the connection from A) so that B will not receive events about new connections or incoming messages from A without realizing that it got disconnected. If B attempts to establish another connection to A before it realized that it got disconnected from A then it's okay for this connection attempt to fail, and the EventConnectionLost to be posted at that point, or for the EventConnectionLost to be posted and for the new connection to be considered the first connection of the "new bundle". |