Safe Haskell	Safe-Inferred
Language	Haskell2010

Simplex.Messaging.Transport.Client

Synopsis

runTransportClient :: Transport c => TransportClientConfig -> Maybe SocksCredentials -> TransportHost -> ServiceName -> Maybe KeyHash -> (c 'TClient -> IO a) -> IO a
runTLSTransportClient :: Transport c => Supported -> Maybe CertificateStore -> TransportClientConfig -> Maybe SocksCredentials -> TransportHost -> ServiceName -> Maybe KeyHash -> (c 'TClient -> IO a) -> IO a
smpClientHandshake :: forall c. Transport c => c 'TClient -> Maybe KeyPairX25519 -> KeyHash -> VersionRangeSMP -> Bool -> Maybe (ServiceCredentials, KeyPairEd25519) -> ExceptT TransportError IO (THandleSMP c 'TClient)
defaultSMPPort :: PortNumber
defaultTcpConnectTimeout :: Int
defaultTransportClientConfig :: TransportClientConfig
defaultSocksProxyWithAuth :: SocksProxyWithAuth
defaultSocksProxy :: SocksProxy
defaultSocksHost :: (Word8, Word8, Word8, Word8)
data TransportClientConfig = TransportClientConfig {
- socksProxy :: Maybe SocksProxy
- tcpConnectTimeout :: Int
- tcpKeepAlive :: Maybe KeepAliveOpts
- logTLSErrors :: Bool
- clientCredentials :: Maybe Credential
- clientALPN :: Maybe [ALPN]
- useSNI :: Bool
}
newtype SocksProxy = SocksProxy SockAddr
data SocksProxyWithAuth = SocksProxyWithAuth SocksAuth SocksProxy
data SocksAuth
- = SocksAuthUsername {
  - username :: ByteString
  - password :: ByteString
  }
- | SocksAuthNull
- | SocksIsolateByAuth
data TransportHost
- = THIPv4 (Word8, Word8, Word8, Word8)
- | THIPv6 (Word32, Word32, Word32, Word32)
- | THOnionHost ByteString
- | THDomainName HostName
newtype TransportHosts = TransportHosts {
- thList :: NonEmpty TransportHost
}
newtype TransportHosts_ = TransportHosts_ {
- thList_ :: [TransportHost]
}
validateCertificateChain :: KeyHash -> HostName -> ByteString -> CertificateChain -> IO [FailedReason]

Documentation

runTransportClient :: Transport c => TransportClientConfig -> Maybe SocksCredentials -> TransportHost -> ServiceName -> Maybe KeyHash -> (c 'TClient -> IO a) -> IO a Source #

Connect to passed TCP host:port and pass handle to the client.

runTLSTransportClient :: Transport c => Supported -> Maybe CertificateStore -> TransportClientConfig -> Maybe SocksCredentials -> TransportHost -> ServiceName -> Maybe KeyHash -> (c 'TClient -> IO a) -> IO a Source #

smpClientHandshake :: forall c. Transport c => c 'TClient -> Maybe KeyPairX25519 -> KeyHash -> VersionRangeSMP -> Bool -> Maybe (ServiceCredentials, KeyPairEd25519) -> ExceptT TransportError IO (THandleSMP c 'TClient) Source #

Client SMP transport handshake.

See https://github.com/simplex-chat/simplexmq/blob/master/protocol/simplex-messaging.md#appendix-a

defaultSMPPort :: PortNumber Source #

defaultTcpConnectTimeout :: Int Source #

defaultTransportClientConfig :: TransportClientConfig Source #

defaultSocksProxyWithAuth :: SocksProxyWithAuth Source #

defaultSocksProxy :: SocksProxy Source #

defaultSocksHost :: (Word8, Word8, Word8, Word8) Source #

data TransportClientConfig Source #

Constructors

TransportClientConfig
Fields socksProxy :: Maybe SocksProxy tcpConnectTimeout :: Int tcpKeepAlive :: Maybe KeepAliveOpts logTLSErrors :: Bool clientCredentials :: Maybe Credential clientALPN :: Maybe [ALPN] useSNI :: Bool

Instances

Instances details

Show TransportClientConfig Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods showsPrec :: Int -> TransportClientConfig -> ShowS show :: TransportClientConfig -> String showList :: [TransportClientConfig] -> ShowS
Eq TransportClientConfig Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods (==) :: TransportClientConfig -> TransportClientConfig -> Bool (/=) :: TransportClientConfig -> TransportClientConfig -> Bool

newtype SocksProxy Source #

Constructors

SocksProxy SockAddr

Instances

Instances details

Show SocksProxy Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods showsPrec :: Int -> SocksProxy -> ShowS show :: SocksProxy -> String showList :: [SocksProxy] -> ShowS
Eq SocksProxy Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods (==) :: SocksProxy -> SocksProxy -> Bool (/=) :: SocksProxy -> SocksProxy -> Bool
StrEncoding SocksProxy Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods strEncode :: SocksProxy -> ByteString Source # strDecode :: ByteString -> Either String SocksProxy Source # strP :: Parser SocksProxy Source #

data SocksProxyWithAuth Source #

Constructors

SocksProxyWithAuth SocksAuth SocksProxy

Instances

Instances details

FromJSON SocksProxyWithAuth Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods parseJSON :: Value -> Parser SocksProxyWithAuth parseJSONList :: Value -> Parser [SocksProxyWithAuth] omittedField :: Maybe SocksProxyWithAuth
ToJSON SocksProxyWithAuth Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods toJSON :: SocksProxyWithAuth -> Value toEncoding :: SocksProxyWithAuth -> Encoding toJSONList :: [SocksProxyWithAuth] -> Value toEncodingList :: [SocksProxyWithAuth] -> Encoding omitField :: SocksProxyWithAuth -> Bool
Show SocksProxyWithAuth Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods showsPrec :: Int -> SocksProxyWithAuth -> ShowS show :: SocksProxyWithAuth -> String showList :: [SocksProxyWithAuth] -> ShowS
Eq SocksProxyWithAuth Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods (==) :: SocksProxyWithAuth -> SocksProxyWithAuth -> Bool (/=) :: SocksProxyWithAuth -> SocksProxyWithAuth -> Bool
StrEncoding SocksProxyWithAuth Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods strEncode :: SocksProxyWithAuth -> ByteString Source # strDecode :: ByteString -> Either String SocksProxyWithAuth Source # strP :: Parser SocksProxyWithAuth Source #

data SocksAuth Source #

Constructors

SocksAuthUsername
Fields username :: ByteString password :: ByteString
SocksAuthNull
SocksIsolateByAuth

Instances

Instances details

Show SocksAuth Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods showsPrec :: Int -> SocksAuth -> ShowS show :: SocksAuth -> String showList :: [SocksAuth] -> ShowS
Eq SocksAuth Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods (==) :: SocksAuth -> SocksAuth -> Bool (/=) :: SocksAuth -> SocksAuth -> Bool
StrEncoding SocksAuth Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods strEncode :: SocksAuth -> ByteString Source # strDecode :: ByteString -> Either String SocksAuth Source # strP :: Parser SocksAuth Source #

data TransportHost Source #

Constructors

THIPv4 (Word8, Word8, Word8, Word8)
THIPv6 (Word32, Word32, Word32, Word32)
THOnionHost ByteString
THDomainName HostName

Instances

Instances details

FromJSON TransportHost Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods parseJSON :: Value -> Parser TransportHost parseJSONList :: Value -> Parser [TransportHost] omittedField :: Maybe TransportHost
ToJSON TransportHost Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods toJSON :: TransportHost -> Value toEncoding :: TransportHost -> Encoding toJSONList :: [TransportHost] -> Value toEncodingList :: [TransportHost] -> Encoding omitField :: TransportHost -> Bool
IsString TransportHost Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods fromString :: String -> TransportHost
Show TransportHost Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods showsPrec :: Int -> TransportHost -> ShowS show :: TransportHost -> String showList :: [TransportHost] -> ShowS
Eq TransportHost Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods (==) :: TransportHost -> TransportHost -> Bool (/=) :: TransportHost -> TransportHost -> Bool
Ord TransportHost Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods compare :: TransportHost -> TransportHost -> Ordering (<) :: TransportHost -> TransportHost -> Bool (<=) :: TransportHost -> TransportHost -> Bool (>) :: TransportHost -> TransportHost -> Bool (>=) :: TransportHost -> TransportHost -> Bool max :: TransportHost -> TransportHost -> TransportHost min :: TransportHost -> TransportHost -> TransportHost
Encoding TransportHost Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods smpEncode :: TransportHost -> ByteString Source # smpDecode :: ByteString -> Either String TransportHost Source # smpP :: Parser TransportHost Source #
StrEncoding TransportHost Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods strEncode :: TransportHost -> ByteString Source # strDecode :: ByteString -> Either String TransportHost Source # strP :: Parser TransportHost Source #
IsString (NonEmpty TransportHost) Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods fromString :: String -> NonEmpty TransportHost
FromField (NonEmpty TransportHost) Source #
Instance details Defined in Simplex.Messaging.Agent.Store.AgentStore Methods fromField :: FieldParser (NonEmpty TransportHost) #
ToField (NonEmpty TransportHost) Source #
Instance details Defined in Simplex.Messaging.Agent.Store.AgentStore Methods toField :: NonEmpty TransportHost -> SQLData #

newtype TransportHosts Source #

Constructors

TransportHosts
Fields thList :: NonEmpty TransportHost

Instances

Instances details

StrEncoding TransportHosts Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods strEncode :: TransportHosts -> ByteString Source # strDecode :: ByteString -> Either String TransportHosts Source # strP :: Parser TransportHosts Source #

newtype TransportHosts_ Source #

Constructors

TransportHosts_
Fields thList_ :: [TransportHost]

Instances

Instances details

StrEncoding TransportHosts_ Source #
Instance details Defined in Simplex.Messaging.Transport.Client Methods strEncode :: TransportHosts_ -> ByteString Source # strDecode :: ByteString -> Either String TransportHosts_ Source # strP :: Parser TransportHosts_ Source #

validateCertificateChain :: KeyHash -> HostName -> ByteString -> CertificateChain -> IO [FailedReason] Source #