-
Notifications
You must be signed in to change notification settings - Fork 86
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
108 additions
and
2 deletions.
There are no files selected for viewing
107 changes: 107 additions & 0 deletions
107
ouroboros-network-framework/src/Ouroboros/Network/InboundGovernor/ControlChannel.hs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,107 @@ | ||
{-# LANGUAGE DataKinds #-} | ||
{-# LANGUAGE FlexibleContexts #-} | ||
{-# LANGUAGE GADTs #-} | ||
{-# LANGUAGE KindSignatures #-} | ||
{-# LANGUAGE ScopedTypeVariables #-} | ||
|
||
|
||
-- | Intended to be imported qualified. | ||
-- | ||
module Ouroboros.Network.InboundGovernor.ControlChannel | ||
( NewConnection (..) | ||
, ControlChannel (..) | ||
, ServerControlChannel | ||
, GovernorControlChannel | ||
, newControlChannel | ||
) where | ||
|
||
import Control.Concurrent.Class.MonadSTM.Strict | ||
|
||
import Data.Functor (($>)) | ||
import GHC.Natural (Natural) | ||
|
||
import Network.Mux.Types (MuxMode) | ||
|
||
import Ouroboros.Network.ConnectionHandler | ||
import Ouroboros.Network.ConnectionId (ConnectionId (..)) | ||
import Ouroboros.Network.ConnectionManager.Types | ||
import Ouroboros.Network.PeerSelection.PeerSharing (PeerSharing) | ||
|
||
|
||
-- | Announcement message for a new connection. | ||
-- | ||
data NewConnection peerAddr handle | ||
|
||
-- | Announce a new connection. /Inbound protocol governor/ will start | ||
-- responder protocols using 'StartOnDemand' strategy and monitor remote | ||
-- transitions: @PromotedToWarm^{Duplex}_{Remote}@ and | ||
-- @DemotedToCold^{dataFlow}_{Remote}@. | ||
= NewConnection | ||
!Provenance | ||
!(ConnectionId peerAddr) | ||
!DataFlow | ||
!handle | ||
|
||
instance Show peerAddr | ||
=> Show (NewConnection peerAddr handle) where | ||
show (NewConnection provenance connId dataFlow _) = | ||
concat [ "NewConnection " | ||
, show provenance | ||
, " " | ||
, show connId | ||
, " " | ||
, show dataFlow | ||
] | ||
|
||
|
||
|
||
-- | A Server control channel which instantiates to 'NewConnection' and 'Handle'. | ||
-- | ||
-- It allows to pass 'STM' transactions which will resolve to 'NewConnection'. | ||
-- Server's monitoring thread is the consumer of these messages; there are two | ||
-- producers: accept loop and connection handler for outbound connections. | ||
-- | ||
type ServerControlChannel (muxMode :: MuxMode) peerAddr versionData bytes m a b = | ||
ControlChannel (NewConnection peerAddr (Handle muxMode peerAddr versionData bytes m a b)) m | ||
|
||
-- | Control Channel between Server and Outbound Governor. | ||
-- | ||
-- Control channel that is meant to share inbound connections with the Peer | ||
-- Selection Governor. So the consumer is the Governor and Producer is the | ||
-- Server. | ||
-- | ||
type GovernorControlChannel peerAddr m = | ||
ControlChannel (peerAddr, PeerSharing) m | ||
|
||
-- | Control channel. | ||
-- | ||
data ControlChannel a m = | ||
ControlChannel { | ||
-- | Read a single value from the channel. | ||
-- | ||
readMessage :: STM m a, | ||
|
||
-- | Write a value to the channel. | ||
-- | ||
writeMessage :: a -> STM m () | ||
} | ||
|
||
|
||
newControlChannel :: forall a m. | ||
MonadLabelledSTM m | ||
=> m (ControlChannel a m) | ||
newControlChannel = do | ||
channel <- | ||
atomically $ | ||
newTBQueue cc_QUEUE_BOUND | ||
>>= \q -> labelTBQueue q "server-cc" $> q | ||
pure $ ControlChannel { | ||
readMessage = readTBQueue channel, | ||
writeMessage = writeTBQueue channel | ||
} | ||
|
||
|
||
-- | The 'ControlChannel's 'TBQueue' depth. | ||
-- | ||
cc_QUEUE_BOUND :: Natural | ||
cc_QUEUE_BOUND = 10 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters