Network.Nats.Protocol.Types

Documentation

makeMessageParseError :: String -> ProtocolError

Create a MessageParseError with the given reason

makeSubject :: ByteString -> Subject

Create a Subject with the given ByteString as message

maxPayloadSize :: NatsServerInfo -> Int

Retrieve the maximum payload size, in bytes

data NatsServerInfo

Server information returned on connection

Constructors

NatsServerInfo

Fields

• _srv_server_id :: Text

  Server ID

• _srv_version :: Text

  Server version

• _srv_go :: Text

  Version of Go (https://www.golang.org) the server was compiled against

• _srv_host :: Text

  Server hostname

• _srv_port :: Int

  Server port

• _srv_auth_required :: Maybe Bool

  Server requires authentication

• _srv_ssl_required :: Maybe Bool

  Server requires SSL connections

• _srv_max_payload :: Int

  Maximum message payload size accepted by server

Instances

Show NatsServerInfo

Methods

showsPrec :: Int -> NatsServerInfo -> ShowS

show :: NatsServerInfo -> String

showList :: [NatsServerInfo] -> ShowS

Generic NatsServerInfo

Associated Types

type Rep NatsServerInfo :: * -> *

Methods

from :: NatsServerInfo -> Rep NatsServerInfo x

to :: Rep NatsServerInfo x -> NatsServerInfo

ToJSON NatsServerInfo

Methods

toJSON :: NatsServerInfo -> Value

toEncoding :: NatsServerInfo -> Encoding

toJSONList :: [NatsServerInfo] -> Value

toEncodingList :: [NatsServerInfo] -> Encoding

FromJSON NatsServerInfo

Methods

parseJSON :: Value -> Parser NatsServerInfo

parseJSONList :: Value -> Parser [NatsServerInfo]

type Rep NatsServerInfo

type Rep NatsServerInfo = D1 * (MetaData "NatsServerInfo" "Network.Nats.Protocol.Types" "nats-client-0.1.0.0-20bVBsmSA7R41L4fHZanJf" False) (C1 * (MetaCons "NatsServerInfo" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_srv_server_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_srv_version") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_srv_go") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_srv_host") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_srv_port") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_srv_auth_required") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_srv_ssl_required") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_srv_max_payload") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int))))))

data NatsConnectionOptions

Client connection options sent when issuing a CONNECT to the server See http://nats.io/documentation/internals/nats-protocol/

Constructors

NatsConnectionOptions

Fields

• clnt_verbose :: Bool

  Should server reply with an acknowledgment to every message?

• clnt_pedantic :: Bool

  Turn on strict format checking

• clnt_ssl_required :: Bool

  Require an SSL connection

• clnt_name :: Text

  Client name

• clnt_lang :: Text

  Client implementation language

• clnt_version :: Text

  Client version

• clnt_protocol :: Int

  Client protocol

Instances

Show NatsConnectionOptions

Methods

showsPrec :: Int -> NatsConnectionOptions -> ShowS

show :: NatsConnectionOptions -> String

showList :: [NatsConnectionOptions] -> ShowS

Generic NatsConnectionOptions

Associated Types

type Rep NatsConnectionOptions :: * -> *

Methods

from :: NatsConnectionOptions -> Rep NatsConnectionOptions x

to :: Rep NatsConnectionOptions x -> NatsConnectionOptions

ToJSON NatsConnectionOptions

Methods

toJSON :: NatsConnectionOptions -> Value

toEncoding :: NatsConnectionOptions -> Encoding

toJSONList :: [NatsConnectionOptions] -> Value

toEncodingList :: [NatsConnectionOptions] -> Encoding

FromJSON NatsConnectionOptions

Methods

parseJSON :: Value -> Parser NatsConnectionOptions

parseJSONList :: Value -> Parser [NatsConnectionOptions]

Default NatsConnectionOptions

Methods

def :: NatsConnectionOptions

type Rep NatsConnectionOptions

type Rep NatsConnectionOptions = D1 * (MetaData "NatsConnectionOptions" "Network.Nats.Protocol.Types" "nats-client-0.1.0.0-20bVBsmSA7R41L4fHZanJf" False) (C1 * (MetaCons "NatsConnectionOptions" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "clnt_verbose") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Bool)) ((:*:) * (S1 * (MetaSel (Just Symbol "clnt_pedantic") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Bool)) (S1 * (MetaSel (Just Symbol "clnt_ssl_required") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Bool)))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "clnt_name") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "clnt_lang") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "clnt_version") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "clnt_protocol") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int))))))

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

data Subscription

A subscription to a Subject

Instances

Show Subscription

Methods

showsPrec :: Int -> Subscription -> ShowS

show :: Subscription -> String

showList :: [Subscription] -> 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 ProtocolError

Type for unexpected protocol errors

Constructors

MessageParseError String

The message from the server could not be parsed.

Instances

Show ProtocolError

Methods

showsPrec :: Int -> ProtocolError -> ShowS

show :: ProtocolError -> String

showList :: [ProtocolError] -> ShowS

Exception ProtocolError

Methods

toException :: ProtocolError -> SomeException

fromException :: SomeException -> Maybe ProtocolError

displayException :: ProtocolError -> String