natskell
Safe HaskellNone
LanguageHaskell2010

API

Description

Stable public surface for the core NATS client.

Constructors are intentionally hidden. This lets clients, messages, and subscriptions acquire new capabilities without changing their public representation.

Documentation

data Client #

data Message #

Instances

Instances details
Show Message 
Instance details

Defined in Client.API

Methods

showsPrec :: Int -> Message -> ShowS #

show :: Message -> String #

showList :: [Message] -> ShowS #

Eq Message 
Instance details

Defined in Client.API

Methods

(==) :: Message -> Message -> Bool #

(/=) :: Message -> Message -> Bool #

type MsgView = Message #

data Subscription #

Instances

Instances details
Show Subscription 
Instance details

Defined in Client.API

Methods

showsPrec :: Int -> Subscription -> ShowS #

show :: Subscription -> String #

showList :: [Subscription] -> ShowS #

Eq Subscription 
Instance details

Defined in Client.API

Methods

(==) :: Subscription -> Subscription -> Bool #

(/=) :: Subscription -> Subscription -> Bool #

subscriptionSid :: Subscription -> SID #

data NatsError #

Constructors

NatsValidationError ByteString 
NatsPayloadTooLarge Int Int 
NatsSlowConsumer 
NatsConnectionClosed ClientExitReason 
NatsRequestTimedOut 
NatsNoResponders 

Instances

Instances details
Show NatsError 
Instance details

Defined in Client.API

Methods

showsPrec :: Int -> NatsError -> ShowS #

show :: NatsError -> String #

showList :: [NatsError] -> ShowS #

Eq NatsError 
Instance details

Defined in Client.API

Methods

(==) :: NatsError -> NatsError -> Bool #

(/=) :: NatsError -> NatsError -> Bool #

data ConnectionState #

Constructors

ConnectionConnecting 
ConnectionConnected 
ConnectionReconnecting 
ConnectionClosing ClientExitReason 
ConnectionClosed ClientExitReason 

Instances

Instances details
Show ConnectionState 
Instance details

Defined in State.Types

Methods

showsPrec :: Int -> ConnectionState -> ShowS #

show :: ConnectionState -> String #

showList :: [ConnectionState] -> ShowS #

Eq ConnectionState 
Instance details

Defined in State.Types

Methods

(==) :: ConnectionState -> ConnectionState -> Bool #

(/=) :: ConnectionState -> ConnectionState -> Bool #

type Subject = ByteString #

type Payload = ByteString #

type Headers = [(ByteString, ByteString)] #

type PublishOption = CallOption PublishConfig #

type SubscribeOption = CallOption SubscribeConfig #

type RequestOption = CallOption RequestConfig #

type UnsubscribeOption = CallOption UnsubscribeConfig #

type PingOption = CallOption PingConfig #

type FlushOption = CallOption FlushConfig #

type ResetOption = CallOption ResetConfig #

type CloseOption = CallOption CloseConfig #

publish :: Client -> Subject -> Payload -> [PublishOption] -> IO (Either NatsError ()) #

subscribe :: Client -> Subject -> [SubscribeOption] -> (Message -> IO ()) -> IO (Either NatsError Subscription) #

subscribeOnce :: Client -> Subject -> [SubscribeOption] -> (Message -> IO ()) -> IO (Either NatsError Subscription) #

request :: Client -> Subject -> Payload -> [RequestOption] -> IO (Either NatsError Message) #

unsubscribe :: Client -> Subscription -> [UnsubscribeOption] -> IO (Either NatsError ()) #

newInbox :: Client -> IO Subject #

ping :: Client -> [PingOption] -> IO (Either NatsError ()) #

flush :: Client -> [FlushOption] -> IO (Either NatsError ()) #

connectionState :: Client -> IO ConnectionState #

reset :: Client -> [ResetOption] -> IO () #

close :: Client -> [CloseOption] -> IO () #

subject :: Message -> Subject #

sid :: Message -> SID #

replyTo :: Message -> Maybe Subject #

payload :: Message -> Payload #

headers :: Message -> Maybe Headers #

withSubscriptionExpiry :: NominalDiffTime -> SubscribeOption #

withQueueGroup :: Subject -> SubscribeOption #

withReplyTo :: Subject -> PublishOption #

withHeaders :: Headers -> PublishOption #

withRequestTimeout :: NominalDiffTime -> RequestOption #

withRequestHeaders :: Headers -> RequestOption #

withPingTimeout :: NominalDiffTime -> PingOption #

withFlushTimeout :: NominalDiffTime -> FlushOption #