Safe Haskell	Safe-Inferred
Language	Haskell2010

Simplex.Messaging.Notifications.Transport

Synopsis

data NTFVersion
type VersionRangeNTF = VersionRange NTFVersion
pattern VersionNTF :: Word16 -> VersionNTF
type THandleNTF c p = THandle NTFVersion c p
invalidReasonNTFVersion :: VersionNTF
supportedClientNTFVRange :: VersionRangeNTF
supportedServerNTFVRange :: VersionRangeNTF
alpnSupportedNTFHandshakes :: [ALPN]
ntfServerHandshake :: forall c. Transport c => APrivateSignKey -> c 'TServer -> KeyPairX25519 -> KeyHash -> VersionRangeNTF -> ExceptT TransportError IO (THandleNTF c 'TServer)
ntfClientHandshake :: forall c. Transport c => c 'TClient -> KeyHash -> VersionRangeNTF -> Bool -> Maybe (ServiceCredentials, KeyPairEd25519) -> ExceptT TransportError IO (THandleNTF c 'TClient)

Documentation

data NTFVersion Source #

Instances

Instances details

VersionScope NTFVersion Source #
Instance details Defined in Simplex.Messaging.Notifications.Transport
Protocol NTFVersion ErrorType NtfResponse Source #
Instance details Defined in Simplex.Messaging.Notifications.Protocol Associated Types type ProtoCommand NtfResponse = (cmd :: Type) Source # type ProtoType NtfResponse = (sch :: ProtocolType) Source # Methods protocolClientHandshake :: Transport c => c 'TClient -> Maybe KeyPairX25519 -> KeyHash -> VersionRange NTFVersion -> Bool -> Maybe (ServiceCredentials, KeyPairEd25519) -> ExceptT TransportError IO (THandle NTFVersion c 'TClient) Source # useServiceAuth :: ProtoCommand NtfResponse -> Bool Source # protocolPing :: ProtoCommand NtfResponse Source # protocolError :: NtfResponse -> Maybe ErrorType Source #
ProtocolEncoding NTFVersion ErrorType NtfCmd Source #
Instance details Defined in Simplex.Messaging.Notifications.Protocol Associated Types type Tag NtfCmd Source # Methods encodeProtocol :: Version NTFVersion -> NtfCmd -> ByteString Source # protocolP :: Version NTFVersion -> Tag NtfCmd -> Parser NtfCmd Source # fromProtocolError :: ProtocolErrorType -> ErrorType Source # checkCredentials :: Maybe TAuthorizations -> EntityId -> NtfCmd -> Either ErrorType NtfCmd Source #
ProtocolEncoding NTFVersion ErrorType NtfResponse Source #
Instance details Defined in Simplex.Messaging.Notifications.Protocol Associated Types type Tag NtfResponse Source # Methods encodeProtocol :: Version NTFVersion -> NtfResponse -> ByteString Source # protocolP :: Version NTFVersion -> Tag NtfResponse -> Parser NtfResponse Source # fromProtocolError :: ProtocolErrorType -> ErrorType Source # checkCredentials :: Maybe TAuthorizations -> EntityId -> NtfResponse -> Either ErrorType NtfResponse Source #
NtfEntityI e => ProtocolEncoding NTFVersion ErrorType (NtfCommand e) Source #
Instance details Defined in Simplex.Messaging.Notifications.Protocol Associated Types type Tag (NtfCommand e) Source # Methods encodeProtocol :: Version NTFVersion -> NtfCommand e -> ByteString Source # protocolP :: Version NTFVersion -> Tag (NtfCommand e) -> Parser (NtfCommand e) Source # fromProtocolError :: ProtocolErrorType -> ErrorType Source # checkCredentials :: Maybe TAuthorizations -> EntityId -> NtfCommand e -> Either ErrorType (NtfCommand e) Source #

type VersionRangeNTF = VersionRange NTFVersion Source #

pattern VersionNTF :: Word16 -> VersionNTF Source #

type THandleNTF c p = THandle NTFVersion c p Source #

invalidReasonNTFVersion :: VersionNTF Source #

supportedClientNTFVRange :: VersionRangeNTF Source #

supportedServerNTFVRange :: VersionRangeNTF Source #

alpnSupportedNTFHandshakes :: [ALPN] Source #

ntfServerHandshake :: forall c. Transport c => APrivateSignKey -> c 'TServer -> KeyPairX25519 -> KeyHash -> VersionRangeNTF -> ExceptT TransportError IO (THandleNTF c 'TServer) Source #

Notifcations server transport handshake.

ntfClientHandshake :: forall c. Transport c => c 'TClient -> KeyHash -> VersionRangeNTF -> Bool -> Maybe (ServiceCredentials, KeyPairEd25519) -> ExceptT TransportError IO (THandleNTF c 'TClient) Source #

Notifcations server client transport handshake.