Erebos.Network.Protocol

Documentation

data TransportPacket a

Constructors

TransportPacket TransportHeader [a]

transportToObject :: PartialStorage -> TransportHeader -> PartialObject

data TransportHeader

Constructors

TransportHeader [TransportHeaderItem]

Instances

Show TransportHeader

Defined in Erebos.Network.Protocol

Methods

showsPrec :: Int -> TransportHeader -> ShowS

show :: TransportHeader -> String

showList :: [TransportHeader] -> ShowS

data TransportHeaderItem

Constructors

Acknowledged RefDigest

AcknowledgedSingle Integer

Rejected RefDigest

ProtocolVersion Text

Initiation RefDigest

CookieSet Cookie

CookieEcho Cookie

DataRequest RefDigest

DataResponse RefDigest

AnnounceSelf RefDigest

AnnounceUpdate RefDigest

TrChannelRequest RefDigest

TrChannelAccept RefDigest

ServiceType ServiceID

ServiceRef RefDigest

StreamOpen Word8

Instances

Show TransportHeaderItem

Defined in Erebos.Network.Protocol

Methods

showsPrec :: Int -> TransportHeaderItem -> ShowS

show :: TransportHeaderItem -> String

showList :: [TransportHeaderItem] -> ShowS

Eq TransportHeaderItem

Defined in Erebos.Network.Protocol

Methods

(==) :: TransportHeaderItem -> TransportHeaderItem -> Bool

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

data SecurityRequirement

Constructors

PlaintextOnly

PlaintextAllowed

EncryptedOnly

Instances

Eq SecurityRequirement

Defined in Erebos.Network.Protocol

Methods

(==) :: SecurityRequirement -> SecurityRequirement -> Bool

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

Ord SecurityRequirement

Defined in Erebos.Network.Protocol

Methods

compare :: SecurityRequirement -> SecurityRequirement -> Ordering

(<) :: SecurityRequirement -> SecurityRequirement -> Bool

(<=) :: SecurityRequirement -> SecurityRequirement -> Bool

(>) :: SecurityRequirement -> SecurityRequirement -> Bool

(>=) :: SecurityRequirement -> SecurityRequirement -> Bool

max :: SecurityRequirement -> SecurityRequirement -> SecurityRequirement

min :: SecurityRequirement -> SecurityRequirement -> SecurityRequirement

data WaitingRef

Constructors

WaitingRef

Fields

• wrefStorage :: Storage
• wrefPartial :: PartialRef
• wrefAction :: Ref -> WaitingRefCallback
• wrefStatus :: TVar (Either [RefDigest] Ref)

type WaitingRefCallback = ExceptT String IO ()

wrDigest :: WaitingRef -> RefDigest

data ChannelState

Constructors

ChannelNone

ChannelCookieWait

ChannelCookieReceived

ChannelCookieConfirmed

ChannelOurRequest (Stored ChannelRequest)

ChannelPeerRequest WaitingRef

ChannelOurAccept (Stored ChannelAccept) Channel

ChannelEstablished Channel

ChannelClosed

data ControlRequest addr

Constructors

RequestConnection addr

SendAnnounce addr

UpdateSelfIdentity UnifiedIdentity

data ControlMessage addr

Constructors

NewConnection (Connection addr) (Maybe RefDigest)

ReceivedAnnounce addr RefDigest

erebosNetworkProtocol :: (Eq addr, Ord addr, Show addr) => UnifiedIdentity -> (String -> STM ()) -> SymFlow (addr, ByteString) -> Flow (ControlRequest addr) (ControlMessage addr) -> IO ()

data Connection addr

Instances

Eq (Connection addr)

Defined in Erebos.Network.Protocol

Methods

(==) :: Connection addr -> Connection addr -> Bool

(/=) :: Connection addr -> Connection addr -> Bool

connAddress :: Connection addr -> addr

connData :: Connection addr -> Flow (Maybe (Bool, TransportPacket PartialObject)) (SecurityRequirement, TransportPacket Ref, [TransportHeaderItem])

connGetChannel :: Connection addr -> STM ChannelState

connSetChannel :: Connection addr -> ChannelState -> STM ()

connClose :: Connection addr -> STM ()

type RawStreamReader = Flow StreamPacket Void

type RawStreamWriter = Flow Void StreamPacket

connAddWriteStream :: Connection addr -> STM (Either String (TransportHeaderItem, RawStreamWriter, IO ()))

connAddReadStream :: Connection addr -> Word8 -> STM RawStreamReader

readStreamToList :: RawStreamReader -> IO (Word64, [(Word64, ByteString)])

readObjectsFromStream :: PartialStorage -> RawStreamReader -> IO (Except String [PartialObject])

writeByteStringToStream :: RawStreamWriter -> ByteString -> IO ()

data Flow r w

type SymFlow a = Flow a a

newFlow :: STM (Flow a b, Flow b a)

newFlowIO :: IO (Flow a b, Flow b a)

readFlow :: Flow r w -> STM r

tryReadFlow :: Flow r w -> STM (Maybe r)

canReadFlow :: Flow r w -> STM Bool

writeFlow :: Flow r w -> w -> STM ()

writeFlowBulk :: Flow r w -> [w] -> STM ()

tryWriteFlow :: Flow r w -> w -> STM Bool

canWriteFlow :: Flow r w -> STM Bool

readFlowIO :: Flow r w -> IO r

writeFlowIO :: Flow r w -> w -> IO ()

mapFlow :: (r -> r') -> (w' -> w) -> Flow r w -> Flow r' w'