Network.Nats.Protocol

Documentation

class (Monad m, MonadIO m) => Connection m where

Connection context for abstracting away IO

Minimal complete definition

receiveRawMessage, sendRawMessage

Methods

receiveRawMessage :: Handle -> Int -> m ByteString

sendRawMessage :: Handle -> Builder -> m ()

Instances

Connection IO

Default IO implementation using bytestrings

Methods

receiveRawMessage :: Handle -> Int -> IO ByteString

sendRawMessage :: Handle -> Builder -> IO ()

newtype Subject

Name of a NATS subject. Must be a dot-separated alphanumeric string, with ">" and "." as wildcard characters. See http://nats.io/documentation/internals/nats-protocol/

Constructors

Subject ByteString

Instances

Show Subject

Methods

showsPrec :: Int -> Subject -> ShowS

show :: Subject -> String

showList :: [Subject] -> ShowS

newtype SubscriptionId

A Subscription identifier

Constructors

SubscriptionId ByteString

Instances

Eq SubscriptionId

Methods

(==) :: SubscriptionId -> SubscriptionId -> Bool

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

Ord SubscriptionId

Methods

compare :: SubscriptionId -> SubscriptionId -> Ordering

(<) :: SubscriptionId -> SubscriptionId -> Bool

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

(>) :: SubscriptionId -> SubscriptionId -> Bool

(>=) :: SubscriptionId -> SubscriptionId -> Bool

max :: SubscriptionId -> SubscriptionId -> SubscriptionId

min :: SubscriptionId -> SubscriptionId -> SubscriptionId

Show SubscriptionId

Methods

showsPrec :: Int -> SubscriptionId -> ShowS

show :: SubscriptionId -> String

showList :: [SubscriptionId] -> ShowS

data QueueGroup

Type for representing Queue Groups, used to implement round-robin receivers

Instances

Show QueueGroup

Methods

showsPrec :: Int -> QueueGroup -> ShowS

show :: QueueGroup -> String

showList :: [QueueGroup] -> ShowS

defaultConnectionOptions :: NatsConnectionOptions

Default client connection options, for convenience.

defaultTimeout :: Int

Default client timeout, in millisseconds

receiveMessage :: (MonadThrow m, Connection m) => Handle -> Int -> m Message

Receive a Message from the server

receiveServerBanner :: Connection m => Handle -> m (Either String NatsServerInfo)

Receive the initial server banner from an INFO message, or an error message if it cannot be parsed.

sendConnect :: Connection m => Handle -> NatsConnectionOptions -> m ()

Send a CONNECT message to the server

sendPong :: Connection m => Handle -> m ()

Send a PONG message to the server, typically in reply to a PING challenge.

sendPub :: Connection m => Handle -> Subject -> Int -> ByteString -> m ()

Send a publish request to the server

sendSub :: Connection m => Handle -> Subject -> SubscriptionId -> Maybe QueueGroup -> m ()

Send a Subscription request to a Subject, with a SubscriptionId and optionally a QueueGroup.

sendUnsub :: Connection m => Handle -> SubscriptionId -> Maybe Int -> m ()

Send an unsubscription request with a SubscriptionId and optionally a maximum number of messages that will still be listened to.

data Message

Messages received from the NATS server

Constructors

Message ByteString

A published message, containing a payload

OKMsg

Acknowledgment from server after a client request

ErrorMsg ByteString

Error message from server after a client request

Banner ByteString

Server "banner" received via an INFO message

Ping

Server ping challenge

Instances

Show Message

Methods

showsPrec :: Int -> Message -> ShowS

show :: Message -> String

showList :: [Message] -> ShowS

parseMessage :: MonadThrow m => ByteString -> m Message

Parses a Message from a ByteString

parseServerBanner :: ByteString -> Either String NatsServerInfo

Specialized parsed to return a NatsServerInfo

parseSubject :: ByteString -> Either String Subject

Parse a ByteString into a Subject or return an error message. See http://nats.io/documentation/internals/nats-protocol/

module Network.Nats.Protocol.Types