diff --git a/README.md b/README.md index 8025697..3dab729 100644 --- a/README.md +++ b/README.md @@ -20,21 +20,29 @@ Simple NATS client for the [Crystal](https://crystal-lang.org) programming langu ## Usage ```crystal -require "nats" +require "nats/client" -nc = NATS::Connection.new("demo.nats.io") -nc.subscribe("foo") { |msg| puts "Received '#{msg}'"} -nc.publish("foo", "Hello!") +client = NATS::Client.new("nats://localhost:4222") +client.connect -sub = nc.subscribe("req") do |msg| - msg.respond("ANSWER is 42") +client.subscribe("foo") do |msg| + puts "Received message on subject #{msg.subject}: #{msg.payload}" end -answer = nc.request("req", "Help!") -puts "Received a response '#{answer}'!" +client.publish("foo", "Hello, NATS!") -sub.close -nc.close +client.subscribe("bar") do |msg| + msg.reply "Received your message on bar: #{msg.payload}" +end + +response = client.request("bar", "Hello, bar!") +puts "Received response: #{response.payload}" + +client.request("bar") do |msg| + puts "Recieved async response: #{msg.payload}" +end + +client.close ``` ## License diff --git a/TODO b/TODO index d6e8e0a..e3be25c 100644 --- a/TODO +++ b/TODO @@ -1,8 +1,5 @@ -1. auto-unsub, max messages -2. Multiple URLs/Servers -3. Reconnect logic -4. Async INFO processing -5. Multiple servers, state logic CONNECTED/RECONNECTING/DISCONNECTED/CLOSED -6. msgs/bytes stats for connections and subscriptions -7. async request? -8. NATS 2.0 security/auth +1. Reconnect logic +2. Handle multiple servers +3. State change callbacks +4. auto-unsub, max messages (https://docs.nats.io/using-nats/developer/receiving/unsub_after) +5. msgs/bytes stats for connections and subscriptions diff --git a/bin/nats-pub.cr b/bin/nats-pub.cr deleted file mode 100644 index 3263d87..0000000 --- a/bin/nats-pub.cr +++ /dev/null @@ -1,44 +0,0 @@ -# Copyright 2019 The NATS Authors -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -require "option_parser" -require "../src/nats/connection" - -USAGE = "Usage: nats-pub [-s server] " - -def usage - STDERR.puts USAGE; exit(1) -end - -server = NATS::Connection::DEFAULT_URI -args = ARGV.dup - -OptionParser.parse(args) do |parser| - parser.banner = USAGE - parser.on("-s SERVER", "--server=SERVER", "NATS Server to connect") { |url| server = url } - parser.on("-h", "--help", "Show this help") { usage } - parser.invalid_option do |flag| - STDERR.puts "ERROR: #{flag} is not a valid option." - usage - end -end - -usage unless args.size == 2 -subject, msg = args - -nc = NATS::Connection.new(server) -at_exit { nc.close } - -nc.publish(subject, msg) -puts "Published [#{subject}] : '#{msg}'" diff --git a/bin/nats-req.cr b/bin/nats-req.cr deleted file mode 100644 index ddea19d..0000000 --- a/bin/nats-req.cr +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2019 The NATS Authors -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -require "option_parser" -require "../src/nats/connection" - -USAGE = "Usage: nats-req [-s server] " - -def usage - STDERR.puts USAGE; exit(1) -end - -server = NATS::Connection::DEFAULT_URI -args = ARGV.dup - -OptionParser.parse(args) do |parser| - parser.banner = USAGE - parser.on("-s SERVER", "--server=SERVER", "NATS Server to connect") { |url| server = url } - parser.on("-h", "--help", "Show this help") { usage } - parser.invalid_option do |flag| - STDERR.puts "ERROR: #{flag} is not a valid option." - usage - end -end - -usage unless args.size >= 1 -subject, msg = args[0], args[1]? - -nc = NATS::Connection.new(server) -puts nc.request(subject, msg) diff --git a/bin/nats-sub.cr b/bin/nats-sub.cr deleted file mode 100644 index 67102f8..0000000 --- a/bin/nats-sub.cr +++ /dev/null @@ -1,57 +0,0 @@ -# Copyright 2019 The NATS Authors -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -require "option_parser" -require "../src/nats/connection" - -USAGE = "Usage: nats-sub [-s server] [-r] [-t] [queue_group]" - -def usage - STDERR.puts USAGE; exit(1) -end - -server = NATS::Connection::DEFAULT_URI -show_time, show_raw = false, false - -args = ARGV.dup -OptionParser.parse(args) do |parser| - parser.banner = USAGE - parser.on("-s SERVER", "--server=SERVER", "NATS Server to connect") { |url| server = url } - parser.on("-t", "--time") { show_time = true } - parser.on("-r", "--raw") { show_raw = true } - parser.on("-h", "--help", "Show this help") { usage } - parser.invalid_option do |flag| - STDERR.puts "ERROR: #{flag} is not a valid option." - usage - end -end - -usage unless args.size >= 1 -subject, queue_group = args[0], args[1]? -index = 0 - -nc = NATS::Connection.new(server) -nc.on_close { STDERR.puts "Connection closed, exiting."; exit(1) } - -nc.subscribe(subject, queue_group) do |msg| - if show_raw - puts msg - else - time_prefix = "[#{Time.now}] " if show_time - puts "#{time_prefix}[\##{index += 1}] Received on [#{msg.subject}] : '#{msg}'" - end -end - -puts "Listening on [#{subject}]" unless show_raw -sleep diff --git a/docs/404.html b/docs/404.html new file mode 100644 index 0000000..ffc6cd6 --- /dev/null +++ b/docs/404.html @@ -0,0 +1,192 @@ + + + + + + + + + + + + + + + + + nats main-dev + + + + + + + +
+
+
+ +
+ +
+

+ + nats + +

+ + + main-dev + +
+
+ + + +
+ + +
+
+ + +
+

+ 404 Not Found +

+ +

+ This page is unavailable in this version of the API docs. +

+ +

+ You can use the sidebar to search for your page, or try a different + Crystal version. +

+ +
+ + diff --git a/docs/NATS.html b/docs/NATS.html index e595780..da61464 100644 --- a/docs/NATS.html +++ b/docs/NATS.html @@ -1,66 +1,167 @@ - + - + + + + - + - - - NATS - github.com/nats-io/nats.cr + + NATS - nats main-dev + + + +
-
- README +
+

+ + nats + +

+ + + main-dev +
-
+
    -
  • +
  • NATS @@ -75,7 +176,9 @@

    - module NATS + + module + NATS

    @@ -96,33 +199,79 @@

    -

    Defined in:

    + + +

    + + + + Defined in: +

    + + + nats.cr + +
    + + + nats/client.cr + +
    - - nats/nuid.cr - + nats/client/status.cr
    - - nats/msg.cr - + nats/errors.cr
    - - nats/subscription.cr - + nats/message/connect.cr
    - - nats/connection.cr - + nats/message/info.cr + +
    + + + nats/message/msg.cr + +
    + + + nats/message/pub.cr + +
    + + + nats/message/sub.cr + +
    + + + nats/message/unsub.cr + +
    + + + nats/nuid.cr + +
    + + + nats/options.cr + +
    + + + nats/subscription.cr
    @@ -130,17 +279,19 @@

    Defined in:

    -

    Constant Summary

    +

    + + + + Constant Summary +

    -
    - LANG = "crystal" -
    - -
    - VERSION = "0.0.1" + VERSION = {{ (`shards version /home/zbensley/Documents/git/nats.cr/src`).chomp.stringify }}
    @@ -148,24 +299,75 @@

    Constant Summary

    + + +

    + + + + Class Method Summary +

    + + + +
    + +
    - -
    -
    - - + +

    + + + + Class Method Detail +

    + +
    +
    + + def self.connect(uri : String | URI = Client::DEFAULT_URI) : Client + # +
    + +
    + +

    Connects to a NATS server using the provided URI.

    +

    uri: The URI of the NATS server to connect to.

    +
    + +
    +
    + +
    +
    + + +
    diff --git a/docs/NATS/AuthenticationError.html b/docs/NATS/AuthenticationError.html new file mode 100644 index 0000000..526d4e5 --- /dev/null +++ b/docs/NATS/AuthenticationError.html @@ -0,0 +1,376 @@ + + + + + + + + + + + + + + + + + NATS::AuthenticationError - nats main-dev + + + + + + + +
    +
    +
    + +
    + +
    +

    + + nats + +

    + + + main-dev + +
    +
    + + + +
    + + +
    +
    + + +
    +

    + + + class + NATS::AuthenticationError + +

    + + + + + + + +

    + + + + Overview +

    + +

    +AuthenticationError+ is raised when the NATS server indicates an authentication error.

    + + + + + + + + + + + + + + + + +

    + + + + Defined in: +

    + + + nats/errors.cr + +
    + + + + + + + +

    + + + + Constructors +

    + + + + + + + + + + +
    + + + + + + +

    Constructor methods inherited from class NATS::ERRError

    + + + + new(msg = "Unknown error") + new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + +

    + + + + Constructor Detail +

    + +
    +
    + + def self.new(msg = "Authentication failed") + + # +
    + +
    +
    + +
    +
    + + + + + + + + + + +
    + + + diff --git a/docs/NATS/Client.html b/docs/NATS/Client.html new file mode 100644 index 0000000..3e22c28 --- /dev/null +++ b/docs/NATS/Client.html @@ -0,0 +1,677 @@ + + + + + + + + + + + + + + + + + NATS::Client - nats main-dev + + + + + + + +
    +
    +
    + +
    + +
    +

    + + nats + +

    + + + main-dev + +
    +
    + + + +
    + + +
    +
    + + +
    +

    + + + class + NATS::Client + +

    + + + + + + + +

    + + + + Overview +

    + +

    NATS Client for connecting to a NATS server.
    +This client allows you to subscribe and publish messages.

    +

    Example:

    +
    require "nats/client"
+
+client = NATS::Client.new("nats://localhost:4222")
+client.connect
+
+client.subscribe("foo") do |msg|
+  puts "Received message on subject #{msg.subject}: #{msg.payload}"
+end
+
+client.publish("foo", "Hello, NATS!")
+
+client.subscribe("bar") do |msg|
+  msg.reply "Received your message on bar: #{msg.payload}"
+end
+
+response = client.request("bar", "Hello, bar!")
+puts "Received response: #{response.payload}"
+
+client.request("bar") do |msg|
+  puts "Recieved async response: #{msg.payload}"
+end
+
+client.close
    + + + + + + + + + + + + + + + + +

    + + + + Defined in: +

    + + + nats/client.cr + +
    + + + nats/client/status.cr + +
    + + + + + +

    + + + + Constant Summary +

    + +
    + +
    + BUFFER_SIZE = 32768 +
    + +
    +

    Buffer Size for the socket

    +
    + + +
    + DEFAULT_HOST = "localhost" +
    + +
    +

    Default Host for NATS Server

    +
    + + +
    + DEFAULT_PORT = 4222 +
    + +
    +

    Default Port for NATS Server

    +
    + + +
    + DEFAULT_URI = URI.parse("nats://#{DEFAULT_HOST}:#{DEFAULT_PORT}") +
    + +
    +

    Default URI for NATS Server

    +
    + + +
    + + + + +

    + + + + Constructors +

    + + + + + + + + +

    + + + + Instance Method Summary +

    + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + +

    + + + + Constructor Detail +

    + +
    +
    + + def self.new(uri : String | URI = DEFAULT_URI, options : Options = Options.new, user : String | Nil = nil, pass : String | Nil = nil, jwt : String | Nil = nil) + + # +
    + +
    +
    + +
    +
    + + + + + + + + +

    + + + + Instance Method Detail +

    + +
    +
    + + def close + + # +
    + +
    + +

    Closes the NATS connection and cleans up resources.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def connect : self + + # +
    + +
    + +

    Connects to the NATS server

    +
    + +
    +
    + +
    +
    + +
    +
    + + def connected? : Bool + + # +
    + +
    + +

    Checks if the client is connected to the NATS server.
    +Will send a PING message and wait for a PONG response.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def publish(subject : String, payload : String) + + # +
    + +
    + +

    Publishes a message to the specified subject.

    +

    subject: The subject to publish to.
    +payload: The message payload.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def request(subject : String, payload : String, timeout : Time::Span | Nil = nil) : Message::MSG + + # +
    + +
    + +

    Publishes a message to the specified subject and waits for a response.

    +

    subject: The subject to publish to.
    +payload: The message payload.
    +timeout: Optional timeout for waiting for a response. Will use Options.timeout if not set.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def request(subject : String, payload : String, &callback : Message::MSG -> Nil) + + # +
    + +
    + +

    Publishes a message to the specified subject and sends response to callback when available.

    +

    subject: The subject to publish to.
    +payload: The message payload.
    +callback: Callback to handle the response message.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def status : Status + + # +
    + +
    + +

    The current status of the client connection.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def subscribe(subject : String, queue_group : String | Nil = nil, &callback : Message::MSG -> Nil) : Subscription + + # +
    + +
    + +

    Subscribe to a subject, messages will be delivered to the provided callback.

    +

    subject: The subject to subscribe to.
    +queue_group: Optional queue group for load balancing.
    +callback: The callback to handle incoming messages.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def unsubscribe(sub : Subscription) + + # +
    + +
    + +

    Unsubscribes from a subject.

    +

    sub: The subscription to unsubscribe from.

    +
    + +
    +
    + +
    +
    + + + + +
    + + + diff --git a/docs/NATS/Client/Status.html b/docs/NATS/Client/Status.html new file mode 100644 index 0000000..6912327 --- /dev/null +++ b/docs/NATS/Client/Status.html @@ -0,0 +1,581 @@ + + + + + + + + + + + + + + + + + NATS::Client::Status - nats main-dev + + + + + + + +
    +
    +
    + +
    + +
    +

    + + nats + +

    + + + main-dev + +
    +
    + + + +
    + + +
    +
    + + +
    +

    + + + enum + NATS::Client::Status + +

    + + + + + + + + + + + + + + + + + + + + +

    + + + + Defined in: +

    + + + nats/client/status.cr + +
    + + + + + +

    + + + + Enum Members +

    + +
    + +
    + DISCONNECTED = 0 +
    + +
    +

    When the client is not actively connected.

    +
    + + +
    + CONNECTED = 1 +
    + +
    +

    When the client is connected.

    +
    + + +
    + CLOSED = 2 +
    + +
    +

    When the client will no longer attempt to connect to a NATS Server.

    +
    + + +
    + RECONNECTING = 3 +
    + +
    +

    When the client has disconnected and is attempting to reconnect.

    +
    + + +
    + CONNECTING = 4 +
    + +
    +

    When the client is attempting to connect to a NATS Server for the first time.

    +
    + + +
    + DRAINING_SUBS = 5 +
    + +
    +

    When the client is draining a connection before closing.

    +
    + + +
    + DRAINING_PUBS = 6 +
    + +
    +

    When the client is draining a connection before closing.

    +
    + + +
    + + + + + + + + + + +

    + + + + Instance Method Summary +

    + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + +

    + + + + Instance Method Detail +

    + +
    +
    + + def closed? + + # +
    + +
    + +

    Returns true if this enum value equals CLOSED

    +
    + +
    +
    + +
    +
    + +
    +
    + + def connected? + + # +
    + +
    + +

    Returns true if this enum value equals CONNECTED

    +
    + +
    +
    + +
    +
    + +
    +
    + + def connecting? + + # +
    + +
    + +

    Returns true if this enum value equals CONNECTING

    +
    + +
    +
    + +
    +
    + +
    +
    + + def disconnected? + + # +
    + +
    + +

    Returns true if this enum value equals DISCONNECTED

    +
    + +
    +
    + +
    +
    + +
    +
    + + def draining_pubs? + + # +
    + +
    + +

    Returns true if this enum value equals DRAINING_PUBS

    +
    + +
    +
    + +
    +
    + +
    +
    + + def draining_subs? + + # +
    + +
    + +

    Returns true if this enum value equals DRAINING_SUBS

    +
    + +
    +
    + +
    +
    + +
    +
    + + def reconnecting? + + # +
    + +
    + +

    Returns true if this enum value equals RECONNECTING

    +
    + +
    +
    + +
    +
    + + + + +
    + + + diff --git a/docs/NATS/ClientClosed.html b/docs/NATS/ClientClosed.html new file mode 100644 index 0000000..67b9c5e --- /dev/null +++ b/docs/NATS/ClientClosed.html @@ -0,0 +1,345 @@ + + + + + + + + + + + + + + + + + NATS::ClientClosed - nats main-dev + + + + + + + +
    +
    +
    + +
    + +
    +

    + + nats + +

    + + + main-dev + +
    +
    + + + +
    + + +
    +
    + + +
    +

    + + + class + NATS::ClientClosed + +

    + + + + + + + +

    + + + + Overview +

    + +

    +ClientClosed+ is raised when NATS::Client.status == +NATS::Client::Status::CLOSED
    +Usually due to the socket being closed.

    + + + + + + + + + + + + + + + + +

    + + + + Defined in: +

    + + + nats/errors.cr + +
    + + + + + + + +

    + + + + Constructors +

    + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + +

    + + + + Constructor Detail +

    + +
    +
    + + def self.new(msg = "Client is closed") + + # +
    + +
    +
    + +
    +
    + + + + + + + + + + +
    + + + diff --git a/docs/NATS/ClientClosedError.html b/docs/NATS/ClientClosedError.html new file mode 100644 index 0000000..4b5cefc --- /dev/null +++ b/docs/NATS/ClientClosedError.html @@ -0,0 +1,355 @@ + + + + + + + + + + + + + + + + + NATS::ClientClosedError - nats main-dev + + + + + + + +
    +
    +
    + +
    + +
    +

    + + nats + +

    + + + main-dev + +
    +
    + + + +
    + + +
    +
    + + +
    +

    + + + class + NATS::ClientClosedError + +

    + + + + + + + +

    + + + + Overview +

    + +

    +ClientClosed+ is raised when NATS::Client.status == +NATS::Client::Status::CLOSED
    +Usually due to the socket being closed.

    + + + + + + + + + + + + + + + + +

    + + + + Defined in: +

    + + + nats/errors.cr + +
    + + + + + + + +

    + + + + Constructors +

    + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + +

    + + + + Constructor Detail +

    + +
    +
    + + def self.new(msg = "Client is closed") + + # +
    + +
    +
    + +
    +
    + + + + + + + + + + +
    + + + diff --git a/docs/NATS/ERR.html b/docs/NATS/ERR.html new file mode 100644 index 0000000..9fbb4c6 --- /dev/null +++ b/docs/NATS/ERR.html @@ -0,0 +1,344 @@ + + + + + + + + + + + + + + + + + NATS::ERR - nats main-dev + + + + + + + +
    +
    +
    + +
    + +
    +

    + + nats + +

    + + + main-dev + +
    +
    + + + +
    + + +
    +
    + + +
    +

    + + + class + NATS::ERR + +

    + + + + + + + +

    + + + + Overview +

    + +

    +-ERR+ is raised when the NATS server indicates a protocol error.

    + + + + + + + + + + + + + + + + +

    + + + + Defined in: +

    + + + nats/errors.cr + +
    + + + + + + + +

    + + + + Constructors +

    + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + +

    + + + + Constructor Detail +

    + +
    +
    + + def self.new(msg = "Unknown error") + + # +
    + +
    +
    + +
    +
    + + + + + + + + + + +
    + + + diff --git a/docs/NATS/ERRError.html b/docs/NATS/ERRError.html new file mode 100644 index 0000000..750bd27 --- /dev/null +++ b/docs/NATS/ERRError.html @@ -0,0 +1,368 @@ + + + + + + + + + + + + + + + + + NATS::ERRError - nats main-dev + + + + + + + +
    +
    +
    + +
    + +
    +

    + + nats + +

    + + + main-dev + +
    +
    + + + +
    + + +
    +
    + + +
    +

    + + + class + NATS::ERRError + +

    + + + + + + + +

    + + + + Overview +

    + +

    +-ERR+ is raised when the NATS server indicates a protocol error.

    + + + + + + + + + + + +

    + + + + Direct Known Subclasses +

    + + + + + + + +

    + + + + Defined in: +

    + + + nats/errors.cr + +
    + + + + + + + +

    + + + + Constructors +

    + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + +

    + + + + Constructor Detail +

    + +
    +
    + + def self.new(msg = "Unknown error") + + # +
    + +
    +
    + +
    +
    + + + + + + + + + + +
    + + + diff --git a/docs/NATS/Error.html b/docs/NATS/Error.html new file mode 100644 index 0000000..5796379 --- /dev/null +++ b/docs/NATS/Error.html @@ -0,0 +1,320 @@ + + + + + + + + + + + + + + + + + NATS::Error - nats main-dev + + + + + + + +
    +
    +
    + +
    + +
    +

    + + nats + +

    + + + main-dev + +
    +
    + + + +
    + + +
    +
    + + +
    +

    + + + class + NATS::Error + +

    + + + + + + + +

    + + + + Overview +

    + +

    Generic NATS exception class.

    + + + + + + + + + + + +

    + + + + Direct Known Subclasses +

    + + + + + + + +

    + + + + Defined in: +

    + + + nats/errors.cr + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + +
    + + + diff --git a/docs/NATS/Exception.html b/docs/NATS/Exception.html new file mode 100644 index 0000000..456d538 --- /dev/null +++ b/docs/NATS/Exception.html @@ -0,0 +1,308 @@ + + + + + + + + + + + + + + + + + NATS::Exception - nats main-dev + + + + + + + +
    +
    +
    + +
    + +
    +

    + + nats + +

    + + + main-dev + +
    +
    + + + +
    + + +
    +
    + + +
    +

    + + + class + NATS::Exception + +

    + + + + + + + +

    + + + + Overview +

    + +

    Generic NATS exception class.

    + + + + + + + + + + + +

    + + + + Direct Known Subclasses +

    + + + + + + + +

    + + + + Defined in: +

    + + + nats/errors.cr + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + +
    + + + diff --git a/docs/NATS/MSGError.html b/docs/NATS/MSGError.html new file mode 100644 index 0000000..dbedd45 --- /dev/null +++ b/docs/NATS/MSGError.html @@ -0,0 +1,354 @@ + + + + + + + + + + + + + + + + + NATS::MSGError - nats main-dev + + + + + + + +
    +
    +
    + +
    + +
    +

    + + nats + +

    + + + main-dev + +
    +
    + + + +
    + + +
    +
    + + +
    +

    + + + class + NATS::MSGError + +

    + + + + + + + +

    + + + + Overview +

    + +

    +MSGError+ is raised when there is a problem with a +NATS::Message::MSG+.

    + + + + + + + + + + + + + + + + +

    + + + + Defined in: +

    + + + nats/errors.cr + +
    + + + + + + + +

    + + + + Constructors +

    + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + +

    + + + + Constructor Detail +

    + +
    +
    + + def self.new(msg = "MSG error") + + # +
    + +
    +
    + +
    +
    + + + + + + + + + + +
    + + + diff --git a/docs/NATS/Message.html b/docs/NATS/Message.html new file mode 100644 index 0000000..1fcea3d --- /dev/null +++ b/docs/NATS/Message.html @@ -0,0 +1,273 @@ + + + + + + + + + + + + + + + + + NATS::Message - nats main-dev + + + + + + + +
    +
    +
    + +
    + +
    +

    + + nats + +

    + + + main-dev + +
    +
    + + + +
    + + +
    +
    + + +
    +

    + + + module + NATS::Message + +

    + + + + + + + + + + + + + + + + + + + + +

    + + + + Defined in: +

    + + + nats/message/connect.cr + +
    + + + nats/message/info.cr + +
    + + + nats/message/msg.cr + +
    + + + nats/message/pub.cr + +
    + + + nats/message/sub.cr + +
    + + + nats/message/unsub.cr + +
    + + + + + + + + + + + + + + + +
    + +
    + + + + + + + + + + +
    + + + diff --git a/docs/NATS/Message/CONNECT.html b/docs/NATS/Message/CONNECT.html new file mode 100644 index 0000000..d038be2 --- /dev/null +++ b/docs/NATS/Message/CONNECT.html @@ -0,0 +1,1296 @@ + + + + + + + + + + + + + + + + + NATS::Message::CONNECT - nats main-dev + + + + + + + +
    +
    +
    + +
    + +
    +

    + + nats + +

    + + + main-dev + +
    +
    + + + +
    + + +
    +
    + + +
    +

    + + + struct + NATS::Message::CONNECT + +

    + + + + + + + +

    + + + + Overview +

    + +

    The CONNECT message is the client version of the INFO message.
    +Once the client has established a TCP/IP socket connection with the NATS server, +and an INFO message has been received from the server, +the client may send a CONNECT message to the NATS server to provide more +information about the current connection as well as security information.

    +

    SEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#connect

    + + + + + + + +

    + + + + Included Modules +

    +
      + +
    • JSON::Serializable
      • + +
    + + + + + + + + + + +

    + + + + Defined in: +

    + + + nats/message/connect.cr + +
    + + + + + + + +

    + + + + Constructors +

    + + + + + + + + +

    + + + + Instance Method Summary +

    + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + +

    + + + + Constructor Detail +

    + +
    +
    + + def self.new(pull : JSON::PullParser) + + # +
    + +
    +
    + +
    +
    + +
    +
    + + def self.new + + # +
    + +
    +
    + +
    +
    + + + + + + + + +

    + + + + Instance Method Detail +

    + +
    +
    + + def auth_token : String | Nil + + # +
    + +
    + +

    Client authorization token.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def auth_token=(auth_token : String | Nil) + + # +
    + +
    + +

    Client authorization token.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def echo : Bool | Nil + + # +
    + +
    + +

    If set to false, the server (version 1.2.0+) will not send originating messages from this connection to its own subscriptions. +Clients should set this to false only for server supporting this feature, +which is when proto in the INFO protocol is set to at least 1.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def echo=(echo : Bool | Nil) + + # +
    + +
    + +

    If set to false, the server (version 1.2.0+) will not send originating messages from this connection to its own subscriptions. +Clients should set this to false only for server supporting this feature, +which is when proto in the INFO protocol is set to at least 1.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def headers : Bool | Nil + + # +
    + +
    + +

    Whether the client supports headers.

    +

    TODO Implement headers support

    +
    + +
    +
    + +
    +
    + +
    +
    + + def headers=(headers : Bool | Nil) + + # +
    + +
    + +

    Whether the client supports headers.

    +

    TODO Implement headers support

    +
    + +
    +
    + +
    +
    + +
    +
    + + def jwt : String | Nil + + # +
    + +
    + +

    The JWT that identifies a user permissions and account.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def jwt=(jwt : String | Nil) + + # +
    + +
    + +

    The JWT that identifies a user permissions and account.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def lang : String | Nil + + # +
    + +
    + +

    The implementation language of the client.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def lang=(lang : String | Nil) + + # +
    + +
    + +

    The implementation language of the client.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def name : String | Nil + + # +
    + +
    + +

    Client name.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def name=(name : String | Nil) + + # +
    + +
    + +

    Client name.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def nkey : String | Nil + + # +
    + +
    + +

    The public NKey to authenticate the client. +This will be used to verify the signature (sig) against the nonce provided in the INFO message.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def nkey=(nkey : String | Nil) + + # +
    + +
    + +

    The public NKey to authenticate the client. +This will be used to verify the signature (sig) against the nonce provided in the INFO message.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def no_responders : Bool | Nil + + # +
    + +
    + +

    Enable quick replies for cases where a request is sent to a topic with no responders.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def no_responders=(no_responders : Bool | Nil) + + # +
    + +
    + +

    Enable quick replies for cases where a request is sent to a topic with no responders.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def pass : String | Nil + + # +
    + +
    + +

    Connection password.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def pass=(pass : String | Nil) + + # +
    + +
    + +

    Connection password.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def pedantic : Bool | Nil + + # +
    + +
    + +

    Turns on additional strict format checking, e.g. for properly formed subjects.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def pedantic=(pedantic : Bool | Nil) + + # +
    + +
    + +

    Turns on additional strict format checking, e.g. for properly formed subjects.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def protocol : Int32 | Nil + + # +
    + +
    + +

    Sending 0 (or absent) indicates client supports original protocol. +Sending 1 indicates that the client supports dynamic reconfiguration +of cluster topology changes by asynchronously receiving INFO messages with known servers it can reconnect to.

    +

    TODO Support dynamic reconfiguration in the future

    +
    + +
    +
    + +
    +
    + +
    +
    + + def protocol=(protocol : Int32 | Nil) + + # +
    + +
    + +

    Sending 0 (or absent) indicates client supports original protocol. +Sending 1 indicates that the client supports dynamic reconfiguration +of cluster topology changes by asynchronously receiving INFO messages with known servers it can reconnect to.

    +

    TODO Support dynamic reconfiguration in the future

    +
    + +
    +
    + +
    +
    + +
    +
    + + def sig : String | Nil + + # +
    + +
    + +

    In case the server has responded with a nonce on INFO, +then a NATS client must use this field to reply with the signed nonce.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def sig=(sig : String | Nil) + + # +
    + +
    + +

    In case the server has responded with a nonce on INFO, +then a NATS client must use this field to reply with the signed nonce.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def tls_required : Bool | Nil + + # +
    + +
    + +

    Indicates whether the client requires an SSL connection.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def tls_required=(tls_required : Bool | Nil) + + # +
    + +
    + +

    Indicates whether the client requires an SSL connection.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def to_s + + # +
    + +
    + +
    + Description copied from class Object +
    + +

    Returns a nicely readable and concise string representation of this object, +typically intended for users.

    +

    This method should usually not be overridden. It delegates to +#to_s(IO) which can be overridden for custom implementations.

    +

    Also see #inspect.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def user : String | Nil + + # +
    + +
    + +

    Connection username.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def user=(user : String | Nil) + + # +
    + +
    + +

    Connection username.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def verbose : Bool | Nil + + # +
    + +
    + +

    Turns on +OK protocol acknowledgements.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def verbose=(verbose : Bool | Nil) + + # +
    + +
    + +

    Turns on +OK protocol acknowledgements.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def version : String | Nil + + # +
    + +
    + +

    The version of the client.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def version=(version : String | Nil) + + # +
    + +
    + +

    The version of the client.

    +
    + +
    +
    + +
    +
    + + + + +
    + + + diff --git a/docs/NATS/Message/INFO.html b/docs/NATS/Message/INFO.html new file mode 100644 index 0000000..7683ef8 --- /dev/null +++ b/docs/NATS/Message/INFO.html @@ -0,0 +1,1651 @@ + + + + + + + + + + + + + + + + + NATS::Message::INFO - nats main-dev + + + + + + + +
    +
    +
    + +
    + +
    +

    + + nats + +

    + + + main-dev + +
    +
    + + + +
    + + +
    +
    + + +
    +

    + + + struct + NATS::Message::INFO + +

    + + + + + + + +

    + + + + Overview +

    + +

    A client will need to start as a plain TCP connection, +then when the server accepts a connection from the client, +it will send information about itself, +the configuration and security requirements necessary for the client to successfully authenticate with the server and exchange messages.

    +

    When using the updated client protocol (see CONNECT), +INFO messages can be sent anytime by the server. +This means clients with that protocol level need to be able to asynchronously handle INFO messages.

    +

    SEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#info

    + + + + + + + +

    + + + + Included Modules +

    +
      + +
    • JSON::Serializable
      • + +
    + + + + + + + + + + +

    + + + + Defined in: +

    + + + nats/message/info.cr + +
    + + + + + + + +

    + + + + Constructors +

    + + + + + + + + +

    + + + + Instance Method Summary +

    + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + +

    + + + + Constructor Detail +

    + +
    +
    + + def self.new(pull : JSON::PullParser) + + # +
    + +
    +
    + +
    +
    + + + + + + + + +

    + + + + Instance Method Detail +

    + +
    +
    + + def auth_required : Bool | Nil + + # +
    + +
    + +

    If this is true, then the client should try to authenticate upon connect.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def auth_required=(auth_required : Bool | Nil) + + # +
    + +
    + +

    If this is true, then the client should try to authenticate upon connect.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def client_id : UInt64 | Nil + + # +
    + +
    + +

    The internal client identifier in the server. +This can be used to filter client connections in monitoring, correlate with error logs, etc...

    +
    + +
    +
    + +
    +
    + +
    +
    + + def client_id=(client_id : UInt64 | Nil) + + # +
    + +
    + +

    The internal client identifier in the server. +This can be used to filter client connections in monitoring, correlate with error logs, etc...

    +
    + +
    +
    + +
    +
    + +
    +
    + + def client_ip : String | Nil + + # +
    + +
    + +

    The IP of the client.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def client_ip=(client_ip : String | Nil) + + # +
    + +
    + +

    The IP of the client.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def cluster : String | Nil + + # +
    + +
    + +

    The name of the cluster.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def cluster=(cluster : String | Nil) + + # +
    + +
    + +

    The name of the cluster.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def connect_urls : Array(String) | Nil + + # +
    + +
    + +

    List of server urls that a client can connect to.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def connect_urls=(connect_urls : Array(String) | Nil) + + # +
    + +
    + +

    List of server urls that a client can connect to.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def domain : String | Nil + + # +
    + +
    + +

    The configured NATS domain of the server.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def domain=(domain : String | Nil) + + # +
    + +
    + +

    The configured NATS domain of the server.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def git_commit : String | Nil + + # +
    + +
    + +

    The git hash at which the NATS server was built.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def git_commit=(git_commit : String | Nil) + + # +
    + +
    + +

    The git hash at which the NATS server was built.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def go : String + + # +
    + +
    + +

    The version of golang the NATS server was built with.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def go=(go : String) + + # +
    + +
    + +

    The version of golang the NATS server was built with.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def headers : Bool + + # +
    + +
    + +

    Whether the server supports headers.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def headers=(headers : Bool) + + # +
    + +
    + +

    Whether the server supports headers.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def host : String + + # +
    + +
    + +

    The IP address used to start the NATS server, by default this will be 0.0.0.0 and can be configured with -client_advertise host:port.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def host=(host : String) + + # +
    + +
    + +

    The IP address used to start the NATS server, by default this will be 0.0.0.0 and can be configured with -client_advertise host:port.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def ip : String | Nil + + # +
    + +
    + +

    The IP of the server.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def ip=(ip : String | Nil) + + # +
    + +
    + +

    The IP of the server.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def jetstream : Bool | Nil + + # +
    + +
    + +

    Whether the server supports JetStream.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def jetstream=(jetstream : Bool | Nil) + + # +
    + +
    + +

    Whether the server supports JetStream.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def ldm : Bool | Nil + + # +
    + +
    + +

    If the server supports Lame Duck Mode notifications, and the current server has transitioned to lame duck, ldm will be set to true.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def ldm=(ldm : Bool | Nil) + + # +
    + +
    + +

    If the server supports Lame Duck Mode notifications, and the current server has transitioned to lame duck, ldm will be set to true.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def max_payload : Int32 + + # +
    + +
    + +

    Maximum payload size, in bytes, that the server will accept from the client.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def max_payload=(max_payload : Int32) + + # +
    + +
    + +

    Maximum payload size, in bytes, that the server will accept from the client.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def nonce : String | Nil + + # +
    + +
    + +

    The nonce for use in CONNECT.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def nonce=(nonce : String | Nil) + + # +
    + +
    + +

    The nonce for use in CONNECT.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def port : Int32 + + # +
    + +
    + +

    The port number the NATS server is configured to listen on.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def port=(port : Int32) + + # +
    + +
    + +

    The port number the NATS server is configured to listen on.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def proto : Int32 + + # +
    + +
    + +

    An integer indicating the protocol version of the server. +The server version 1.2.0 sets this to 1 to indicate that it supports the "Echo" feature.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def proto=(proto : Int32) + + # +
    + +
    + +

    An integer indicating the protocol version of the server. +The server version 1.2.0 sets this to 1 to indicate that it supports the "Echo" feature.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def server_id : String + + # +
    + +
    + +

    The unique identifier of the NATS server.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def server_id=(server_id : String) + + # +
    + +
    + +

    The unique identifier of the NATS server.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def server_name : String + + # +
    + +
    + +

    The name of the NATS server.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def server_name=(server_name : String) + + # +
    + +
    + +

    The name of the NATS server.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def tls_available : Bool | Nil + + # +
    + +
    + +

    If this is true, the client can provide a valid certificate during the TLS handshake.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def tls_available=(tls_available : Bool | Nil) + + # +
    + +
    + +

    If this is true, the client can provide a valid certificate during the TLS handshake.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def tls_required : Bool | Nil + + # +
    + +
    + +

    If this is true, then the client must perform the TLS/1.2 handshake. +Note, this used to be ssl_required and has been updated along with the protocol from SSL to TLS.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def tls_required=(tls_required : Bool | Nil) + + # +
    + +
    + +

    If this is true, then the client must perform the TLS/1.2 handshake. +Note, this used to be ssl_required and has been updated along with the protocol from SSL to TLS.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def tls_verify : Bool | Nil + + # +
    + +
    + +

    If this is true, the client must provide a valid certificate during the TLS handshake.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def tls_verify=(tls_verify : Bool | Nil) + + # +
    + +
    + +

    If this is true, the client must provide a valid certificate during the TLS handshake.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def version : String + + # +
    + +
    + +

    The version of NATS.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def version=(version : String) + + # +
    + +
    + +

    The version of NATS.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def ws_connect_urls : Array(String) | Nil + + # +
    + +
    + +

    List of server urls that a websocket client can connect to.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def ws_connect_urls=(ws_connect_urls : Array(String) | Nil) + + # +
    + +
    + +

    List of server urls that a websocket client can connect to.

    +
    + +
    +
    + +
    +
    + + + + +
    + + + diff --git a/docs/NATS/Message/MSG.html b/docs/NATS/Message/MSG.html new file mode 100644 index 0000000..276facc --- /dev/null +++ b/docs/NATS/Message/MSG.html @@ -0,0 +1,677 @@ + + + + + + + + + + + + + + + + + NATS::Message::MSG - nats main-dev + + + + + + + +
    +
    +
    + +
    + +
    +

    + + nats + +

    + + + main-dev + +
    +
    + + + +
    + + +
    +
    + + +
    +

    + + + struct + NATS::Message::MSG + +

    + + + + + + + +

    + + + + Overview +

    + +

    The MSG protocol message is used to deliver an application message to the client.

    +

    SEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#msg

    + + + + + + + + + + + + + + + + +

    + + + + Defined in: +

    + + + nats/message/msg.cr + +
    + + + + + + + +

    + + + + Constructors +

    + + + + + + + + +

    + + + + Instance Method Summary +

    + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + +

    + + + + Constructor Detail +

    + +
    +
    + + def self.new(subject : String, sid : Int64, reply_to : String | Nil = nil, bytes : Int64 = 0, payload : String | Nil = nil, client : Client | Nil = nil) + + # +
    + +
    +
    + +
    +
    + + + + + + + + +

    + + + + Instance Method Detail +

    + +
    +
    + + def client : Client | Nil + + # +
    + +
    + +

    NATS Client for sending replies.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def client=(client : Client | Nil) + + # +
    + +
    + +

    NATS Client for sending replies.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def payload : String | Nil + + # +
    + +
    + +

    The message payload data.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def payload=(payload : String | Nil) + + # +
    + +
    + +

    The message payload data.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def reply(payload : String | Nil = nil) + + # +
    + +
    + +

    Reply to this message when the reply_to subject is set.

    +

    payload: The payload to send in the reply.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def reply_to : String | Nil + + # +
    + +
    + +

    The subject on which the publisher is listening for responses.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def reply_to=(reply_to : String | Nil) + + # +
    + +
    + +

    The subject on which the publisher is listening for responses.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def sid : Int64 + + # +
    + +
    + +

    The unique alphanumeric subscription ID of the subject.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def sid=(sid : Int64) + + # +
    + +
    + +

    The unique alphanumeric subscription ID of the subject.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def subject : String + + # +
    + +
    + +

    Subject name this message was received on.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def subject=(subject : String) + + # +
    + +
    + +

    Subject name this message was received on.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def to_s : String | Nil + + # +
    + +
    + +

    Helper method to return the payload

    +
    + +
    +
    + +
    +
    + + + + +
    + + + diff --git a/docs/NATS/Message/PUB.html b/docs/NATS/Message/PUB.html new file mode 100644 index 0000000..88494fc --- /dev/null +++ b/docs/NATS/Message/PUB.html @@ -0,0 +1,608 @@ + + + + + + + + + + + + + + + + + NATS::Message::PUB - nats main-dev + + + + + + + +
    +
    +
    + +
    + +
    +

    + + nats + +

    + + + main-dev + +
    +
    + + + +
    + + +
    +
    + + +
    +

    + + + struct + NATS::Message::PUB + +

    + + + + + + + +

    + + + + Overview +

    + +

    The PUB message publishes the message payload to the given subject name, optionally supplying a reply subject.
    +If a reply subject is supplied, it will be delivered to eligible subscribers along with the supplied payload.

    +

    NOTE that the payload itself is optional.

    +

    SEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#pub

    + + + + + + + + + + + + + + + + +

    + + + + Defined in: +

    + + + nats/message/pub.cr + +
    + + + + + + + +

    + + + + Constructors +

    + + + + + + + + +

    + + + + Instance Method Summary +

    + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + +

    + + + + Constructor Detail +

    + +
    +
    + + def self.new(subject : String, reply_to : String | Nil = nil, payload : String | Nil = nil, callback : Message::MSG -> Nil | Nil = nil) + + # +
    + +
    +
    + +
    +
    + + + + + + + + +

    + + + + Instance Method Detail +

    + +
    +
    + + def callback : Message::MSG -> Nil | Nil + + # +
    + +
    + +

    The callback to be invoked when a message is received.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def callback=(callback : Message::MSG -> Nil | Nil) + + # +
    + +
    + +

    The callback to be invoked when a message is received.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def payload : String | Nil + + # +
    + +
    + +

    The message payload data.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def payload=(payload : String | Nil) + + # +
    + +
    + +

    The message payload data.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def reply_to : String | Nil + + # +
    + +
    + +

    The reply subject that subscribers can use to send a response back to the publisher/requestor.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def reply_to=(reply_to : String | Nil) + + # +
    + +
    + +

    The reply subject that subscribers can use to send a response back to the publisher/requestor.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def subject : String + + # +
    + +
    + +

    The destination subject to publish to.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def subject=(subject : String) + + # +
    + +
    + +

    The destination subject to publish to.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def to_s + + # +
    + +
    + +
    + Description copied from class Object +
    + +

    Returns a nicely readable and concise string representation of this object, +typically intended for users.

    +

    This method should usually not be overridden. It delegates to +#to_s(IO) which can be overridden for custom implementations.

    +

    Also see #inspect.

    +
    + +
    +
    + +
    +
    + + + + +
    + + + diff --git a/docs/NATS/Message/SUB.html b/docs/NATS/Message/SUB.html new file mode 100644 index 0000000..8473999 --- /dev/null +++ b/docs/NATS/Message/SUB.html @@ -0,0 +1,554 @@ + + + + + + + + + + + + + + + + + NATS::Message::SUB - nats main-dev + + + + + + + +
    +
    +
    + +
    + +
    +

    + + nats + +

    + + + main-dev + +
    +
    + + + +
    + + +
    +
    + + +
    +

    + + + struct + NATS::Message::SUB + +

    + + + + + + + +

    + + + + Overview +

    + +

    SUB initiates a subscription to a subject, optionally joining a distributed queue group.

    +

    SEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#sub

    + + + + + + + + + + + + + + + + +

    + + + + Defined in: +

    + + + nats/message/sub.cr + +
    + + + + + + + +

    + + + + Constructors +

    + + + + + + + + +

    + + + + Instance Method Summary +

    + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + +

    + + + + Constructor Detail +

    + +
    +
    + + def self.new(subject : String, sid : String, queue_group : String | Nil = nil) + + # +
    + +
    +
    + +
    +
    + + + + + + + + +

    + + + + Instance Method Detail +

    + +
    +
    + + def queue_group : String | Nil + + # +
    + +
    + +

    If specified, the subscriber will join this queue group.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def queue_group=(queue_group : String | Nil) + + # +
    + +
    + +

    If specified, the subscriber will join this queue group.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def sid : String + + # +
    + +
    + +

    A unique alphanumeric subscription ID, generated by the client.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def sid=(sid : String) + + # +
    + +
    + +

    A unique alphanumeric subscription ID, generated by the client.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def subject : String + + # +
    + +
    + +

    The subject name to subscribe to.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def subject=(subject : String) + + # +
    + +
    + +

    The subject name to subscribe to.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def to_s + + # +
    + +
    + +
    + Description copied from class Object +
    + +

    Returns a nicely readable and concise string representation of this object, +typically intended for users.

    +

    This method should usually not be overridden. It delegates to +#to_s(IO) which can be overridden for custom implementations.

    +

    Also see #inspect.

    +
    + +
    +
    + +
    +
    + + + + +
    + + + diff --git a/docs/NATS/Message/UNSUB.html b/docs/NATS/Message/UNSUB.html new file mode 100644 index 0000000..5895996 --- /dev/null +++ b/docs/NATS/Message/UNSUB.html @@ -0,0 +1,503 @@ + + + + + + + + + + + + + + + + + NATS::Message::UNSUB - nats main-dev + + + + + + + +
    +
    +
    + +
    + +
    +

    + + nats + +

    + + + main-dev + +
    +
    + + + +
    + + +
    +
    + + +
    +

    + + + struct + NATS::Message::UNSUB + +

    + + + + + + + +

    + + + + Overview +

    + +

    UNSUB unsubscribes the connection from the specified subject, +or auto-unsubscribes after the specified number of messages has been received.

    +

    SEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#unsub

    + + + + + + + + + + + + + + + + +

    + + + + Defined in: +

    + + + nats/message/unsub.cr + +
    + + + + + + + +

    + + + + Constructors +

    + + + + + + + + +

    + + + + Instance Method Summary +

    +
      + +
    • + #max_msgs : Int64 | Nil + +

      If specified, the subscriber will join this queue group.

      + +
      • + +
    • + #max_msgs=(max_msgs : Int64 | Nil) + +

      If specified, the subscriber will join this queue group.

      + +
      • + +
    • + #sid : String + +

      The unique alphanumeric subscription ID of the subject to unsubscribe from.

      + +
      • + +
    • + #sid=(sid : String) + +

      The unique alphanumeric subscription ID of the subject to unsubscribe from.

      + +
      • + +
    • + #to_s + +

      Returns a nicely readable and concise string representation of this object, typically intended for users.

      + +
      • + +
    + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + +

    + + + + Constructor Detail +

    + +
    +
    + + def self.new(sid : String, max_msgs : Int64 | Nil = nil) + + # +
    + +
    +
    + +
    +
    + + + + + + + + +

    + + + + Instance Method Detail +

    + +
    +
    + + def max_msgs : Int64 | Nil + + # +
    + +
    + +

    If specified, the subscriber will join this queue group.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def max_msgs=(max_msgs : Int64 | Nil) + + # +
    + +
    + +

    If specified, the subscriber will join this queue group.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def sid : String + + # +
    + +
    + +

    The unique alphanumeric subscription ID of the subject to unsubscribe from.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def sid=(sid : String) + + # +
    + +
    + +

    The unique alphanumeric subscription ID of the subject to unsubscribe from.

    +
    + +
    +
    + +
    +
    + +
    +
    + + def to_s + + # +
    + +
    + +
    + Description copied from class Object +
    + +

    Returns a nicely readable and concise string representation of this object, +typically intended for users.

    +

    This method should usually not be overridden. It delegates to +#to_s(IO) which can be overridden for custom implementations.

    +

    Also see #inspect.

    +
    + +
    +
    + +
    +
    + + + + +
    + + + diff --git a/docs/NATS/NUID.html b/docs/NATS/NUID.html index b95ed79..fb56724 100644 --- a/docs/NATS/NUID.html +++ b/docs/NATS/NUID.html @@ -1,66 +1,167 @@ - + - + + + + - + - - - NATS::NUID - github.com/nats-io/nats.cr + + NATS::NUID - nats main-dev + + + +
    -
    - README +
    +

    + + nats + +

    + + + main-dev +
    -
    +
      -
    • +
    • NATS @@ -75,7 +176,9 @@

      - class NATS::NUID + + class + NATS::NUID

      @@ -85,6 +188,18 @@

      +

      + + + + Overview +

      + +

      Copied and modified from nats-pure repo.

      +

      SEE: https://github.com/nats-io/nats-pure.rb/blob/master/lib/nats/nuid.rb

      + @@ -98,12 +213,19 @@

      -

      Defined in:

      + + +

      + + + + Defined in: +

      - - nats/nuid.cr - + nats/nuid.cr
      @@ -111,7 +233,14 @@

      Defined in:

      -

      Constant Summary

      +

      + + + + Constant Summary +

      @@ -164,7 +293,15 @@

      Constant Summary

      -

      Constructors

      + +

      + + + + Constructors +

      • @@ -175,10 +312,19 @@

        Constructors

      + + - -

      Instance Method Summary

      + +

      + + + + Instance Method Summary +

      • @@ -187,7 +333,7 @@

        Instance Method Summary

      • - #randomize_prefix! + #randomize_prefix!
        • @@ -195,34 +341,45 @@

        Instance Method Summary

        +
        + + -
        - - + - + - + - + - + - + - -
        + -

        Constructor Detail

        + +
        + + +

        + + + + Constructor Detail +

        @@ -235,17 +392,24 @@

        Constructor Detail


        - [View source] -
        + + - -

        Instance Method Detail

        + +

        + + + + Instance Method Detail +

        @@ -258,8 +422,6 @@

        Instance Method Detail


        - [View source] -
        @@ -268,21 +430,18 @@

        Instance Method Detail

        def randomize_prefix! - # + #

        - [View source] -
        -
      diff --git a/docs/NATS/Options.html b/docs/NATS/Options.html new file mode 100644 index 0000000..1efdcf9 --- /dev/null +++ b/docs/NATS/Options.html @@ -0,0 +1,560 @@ + + + + + + + + + + + + + + + + + NATS::Options - nats main-dev + + + + + + + +
      +
      +
      + +
      + +
      +

      + + nats + +

      + + + main-dev + +
      +
      + + + +
      + + +
      +
      + + +
      +

      + + + struct + NATS::Options + +

      + + + + + + + +

      + + + + Overview +

      + +

      Adapted from the nats.go library.

      +

      NOTE Currently only some options are implemented.

      +

      SEE: https://github.com/nats-io/nats.go/blob/8a48023f77877dcfc140d0b9c25603c6cbedfaab/nats.go#L152

      + + + + + + + + + + + + + + + + +

      + + + + Defined in: +

      + + + nats/options.cr + +
      + + + + + + + +

      + + + + Constructors +

      +
        + +
      • + .new + +
        • + +
      + + + + + + + +

      + + + + Instance Method Summary +

      +
        + +
      • + #flush_interval : Time::Span + +

        Specific to nats.cr

        + +
        • + +
      • + #flush_interval=(flush_interval : Time::Span) + +

        Specific to nats.cr

        + +
        • + +
      • + #initialize + +
        • + +
      • + #pedantic : Bool + +

        property ping_interval : Time::Span = 2.minutes property max_pings_out : Int32 = 2 property sub_chan_len : Int32 = 64 * 1024 # 64k property reconnect_buf_size : Int32 = 8 * 1024 * 1024 # 8MB property drain_timeout : Time::Span = 30.seconds property flusher_timeout : Time::Span = 1.minute

        + +
        • + +
      • + #pedantic=(pedantic : Bool) + +

        property ping_interval : Time::Span = 2.minutes property max_pings_out : Int32 = 2 property sub_chan_len : Int32 = 64 * 1024 # 64k property reconnect_buf_size : Int32 = 8 * 1024 * 1024 # 8MB property drain_timeout : Time::Span = 30.seconds property flusher_timeout : Time::Span = 1.minute

        + +
        • + +
      • + #timeout : Time::Span + +

        From nats.go property allow_reconnect : Bool = true property max_reconnect : Int32 = 60 property reconnect_wait : Time::Span = 2.seconds property reconnect_jitter : Time::Span = 100.milliseconds property reconnect_jitter_tls : Time::Span = 1.second

        + +
        • + +
      • + #timeout=(timeout : Time::Span) + +

        From nats.go property allow_reconnect : Bool = true property max_reconnect : Int32 = 60 property reconnect_wait : Time::Span = 2.seconds property reconnect_jitter : Time::Span = 100.milliseconds property reconnect_jitter_tls : Time::Span = 1.second

        + +
        • + +
      + + + +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      + + +

      + + + + Constructor Detail +

      + +
      +
      + + def self.new + + # +
      + +
      +
      + +
      +
      + + + + + + + + +

      + + + + Instance Method Detail +

      + +
      +
      + + def flush_interval : Time::Span + + # +
      + +
      + +

      Specific to nats.cr

      +
      + +
      +
      + +
      +
      + +
      +
      + + def flush_interval=(flush_interval : Time::Span) + + # +
      + +
      + +

      Specific to nats.cr

      +
      + +
      +
      + +
      +
      + +
      +
      + + def initialize + + # +
      + +
      +
      + +
      +
      + +
      +
      + + def pedantic : Bool + + # +
      + +
      + +

      property ping_interval : Time::Span = 2.minutes +property max_pings_out : Int32 = 2 +property sub_chan_len : Int32 = 64 * 1024 # 64k +property reconnect_buf_size : Int32 = 8 * 1024 * 1024 # 8MB +property drain_timeout : Time::Span = 30.seconds +property flusher_timeout : Time::Span = 1.minute

      +
      + +
      +
      + +
      +
      + +
      +
      + + def pedantic=(pedantic : Bool) + + # +
      + +
      + +

      property ping_interval : Time::Span = 2.minutes +property max_pings_out : Int32 = 2 +property sub_chan_len : Int32 = 64 * 1024 # 64k +property reconnect_buf_size : Int32 = 8 * 1024 * 1024 # 8MB +property drain_timeout : Time::Span = 30.seconds +property flusher_timeout : Time::Span = 1.minute

      +
      + +
      +
      + +
      +
      + +
      +
      + + def timeout : Time::Span + + # +
      + +
      + +

      From nats.go +property allow_reconnect : Bool = true +property max_reconnect : Int32 = 60 +property reconnect_wait : Time::Span = 2.seconds +property reconnect_jitter : Time::Span = 100.milliseconds +property reconnect_jitter_tls : Time::Span = 1.second

      +
      + +
      +
      + +
      +
      + +
      +
      + + def timeout=(timeout : Time::Span) + + # +
      + +
      + +

      From nats.go +property allow_reconnect : Bool = true +property max_reconnect : Int32 = 60 +property reconnect_wait : Time::Span = 2.seconds +property reconnect_jitter : Time::Span = 100.milliseconds +property reconnect_jitter_tls : Time::Span = 1.second

      +
      + +
      +
      + +
      +
      + + + + +
      + + + diff --git a/docs/NATS/Subscription.html b/docs/NATS/Subscription.html index 8bf1e3c..714ff21 100644 --- a/docs/NATS/Subscription.html +++ b/docs/NATS/Subscription.html @@ -1,66 +1,167 @@ - + - + + + + - + - - - NATS::Subscription - github.com/nats-io/nats.cr + + NATS::Subscription - nats main-dev + + + +
      -
      - README +
      +

      + + nats + +

      + + + main-dev +
      -
      +
        -
      • +
      • NATS @@ -75,24 +176,30 @@

        - class NATS::Subscription + + struct + NATS::Subscription

        - + + +

        + + + + Overview +

        -

        Overview

        +

        Represents a subscription to a NATS subject.

        -

        A subscription to a given subject and possible queue group. Used to unsubscribe/close.

        -
        nc = NATS::Connection.new("demo.nats.io")
-sub = nc.subscribe("foo") { |msg| }
-sub.close
-sub.unsubscribe
        @@ -107,12 +214,17 @@

        Overview

        -

        Defined in:

        +

        + + + + Defined in: +

        - - nats/subscription.cr - + nats/subscription.cr
        @@ -121,31 +233,84 @@

        Defined in:

        + +

        + + + + Constructors +

        + + + -

        Instance Method Summary

        + +

        + + + + Instance Method Summary +

        • - #close + #callback : Message::MSG -> Nil -

          Will unsubscribe from a subscription.

          +

          The callback to be invoked when a message is received.

        • - #closed? + #callback=(callback : Message::MSG -> Nil) -

          Determines if the subscription is already closed.

          +

          The callback to be invoked when a message is received.

        • - #unsubscribe + #client : Client -

          Will unsubscribe from a subscription.

          +

          The client that owns this subscription.

          + +
          • + +
        • + #queue_group : String | Nil + +

          If specified, the subscriber will join this queue group.

          + +
          • + +
        • + #sid : UInt64 + +

          A unique alphanumeric subscription ID, generated by the client.

          + +
          • + +
        • + #subject : String + +

          The subject name to subscribe to.

          + +
          • + +
        • + #unsubscribe
          • @@ -153,71 +318,199 @@

          Instance Method Summary

          +
          + + -
          - - + - + - + - + + + + + + + + + + + + + + + + + + + + +
          + +

          + + + + Constructor Detail +

          + +
          +
          + + def self.new(subject : String, sid : UInt64, callback : Message::MSG -> Nil, client : Client, queue_group : String | Nil = nil) + # +
          + +
          +
          + +
          +
          -
          + + + +

          + + + + Instance Method Detail +

          + +
          +
          + + def callback : Message::MSG -> Nil + # +
          + +
          + +

          The callback to be invoked when a message is received.

          +
          + +
          +
          + +
          +
          + +
          +
          + + def callback=(callback : Message::MSG -> Nil) -

          Instance Method Detail

          + # +
          + +
          + +

          The callback to be invoked when a message is received.

          +
          + +
          +
          + +
          +
          -
          +
          - def close + def client : Client - # + #
          -

          Will unsubscribe from a subscription.

          +
          + +

          The client that owns this subscription.

          +

          - [View source] +
          +
          + +
          +
          + + def queue_group : String | Nil + + # +
          + +
          + +

          If specified, the subscriber will join this queue group.

          +
          + +
          +
          -
          +
          - def closed? + def sid : UInt64 - # + #
          -

          Determines if the subscription is already closed.

          +
          + +

          A unique alphanumeric subscription ID, generated by the client.

          +

          - [View source] +
          +
          + +
          +
          + + def subject : String + + # +
          + +
          + +

          The subject name to subscribe to.

          +
          + +
          +
          @@ -230,20 +523,15 @@

          Instance Method Detail

          #
          -

          Will unsubscribe from a subscription.

          -
          - [View source] -
          -
        diff --git a/docs/NATS/Timeout.html b/docs/NATS/Timeout.html new file mode 100644 index 0000000..923a834 --- /dev/null +++ b/docs/NATS/Timeout.html @@ -0,0 +1,344 @@ + + + + + + + + + + + + + + + + + NATS::Timeout - nats main-dev + + + + + + + +
        +
        +
        + +
        + +
        +

        + + nats + +

        + + + main-dev + +
        +
        + + + +
        + + +
        +
        + + +
        +

        + + + class + NATS::Timeout + +

        + + + + + + + +

        + + + + Overview +

        + +

        +Timeout+ is raised when NATS::Options.timeout is reached.

        + + + + + + + + + + + + + + + + +

        + + + + Defined in: +

        + + + nats/errors.cr + +
        + + + + + + + +

        + + + + Constructors +

        + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + +

        + + + + Constructor Detail +

        + +
        +
        + + def self.new(msg = "Timeout occurred") + + # +
        + +
        +
        + +
        +
        + + + + + + + + + + +
        + + + diff --git a/docs/NATS/TimeoutError.html b/docs/NATS/TimeoutError.html new file mode 100644 index 0000000..c53e4ff --- /dev/null +++ b/docs/NATS/TimeoutError.html @@ -0,0 +1,354 @@ + + + + + + + + + + + + + + + + + NATS::TimeoutError - nats main-dev + + + + + + + +
        +
        +
        + +
        + +
        +

        + + nats + +

        + + + main-dev + +
        +
        + + + +
        + + +
        +
        + + +
        +

        + + + class + NATS::TimeoutError + +

        + + + + + + + +

        + + + + Overview +

        + +

        +Timeout+ is raised when NATS::Options.timeout is reached.

        + + + + + + + + + + + + + + + + +

        + + + + Defined in: +

        + + + nats/errors.cr + +
        + + + + + + + +

        + + + + Constructors +

        + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + +

        + + + + Constructor Detail +

        + +
        +
        + + def self.new(msg = "Timeout occurred") + + # +
        + +
        +
        + +
        +
        + + + + + + + + + + +
        + + + diff --git a/docs/css/style.css b/docs/css/style.css index 7295c3f..3d0a8a5 100644 --- a/docs/css/style.css +++ b/docs/css/style.css @@ -1,3 +1,7 @@ +:root { + color-scheme: light dark; +} + html, body { background: #FFFFFF; position: relative; @@ -56,10 +60,11 @@ body { padding: 0 0 30px; box-shadow: inset -3px 0 4px rgba(0,0,0,.35); line-height: 1.2; + z-index: 0; } .sidebar .search-box { - padding: 8px 9px; + padding: 13px 9px; } .sidebar input { @@ -83,29 +88,78 @@ body { } .sidebar input::-webkit-input-placeholder { /* Chrome/Opera/Safari */ - color: #C8C8C8; + color: #757575; font-size: 14px; text-indent: 2px; } .sidebar input::-moz-placeholder { /* Firefox 19+ */ - color: #C8C8C8; + color: #757575; font-size: 14px; text-indent: 2px; } .sidebar input:-ms-input-placeholder { /* IE 10+ */ - color: #C8C8C8; + color: #757575; font-size: 14px; text-indent: 2px; } .sidebar input:-moz-placeholder { /* Firefox 18- */ - color: #C8C8C8; + color: #757575; font-size: 14px; text-indent: 2px; } +.project-summary { + padding: 9px 15px 30px 30px; +} + +.project-name { + font-size: 1.4rem; + margin: 0; + color: #f4f4f4; + font-weight: 600; +} + +.project-version { + margin-top: 5px; + display: inline-block; + position: relative; +} + +.project-version > form::after { + position: absolute; + right: 0; + top: 0; + content: "\25BC"; + font-size: .6em; + line-height: 1.2rem; + z-index: -1; +} + +.project-versions-nav { + cursor: pointer; + margin: 0; + padding: 0 .9em 0 0; + border: none; + -moz-appearance: none; + -webkit-appearance: none; + appearance: none; + background-color: transparent; + color: inherit; + font-family: inherit; + font-size: inherit; + line-height: inherit; +} +.project-versions-nav:focus { + outline: none; +} + +.project-versions-nav > option { + color: initial; +} + .sidebar ul { margin: 0; padding: 0; @@ -148,10 +202,6 @@ body { color: #866BA6; } -.repository-links { - padding: 5px 15px 5px 30px; -} - .types-list li ul { overflow: hidden; height: 0; @@ -414,6 +464,12 @@ span.flag.purple { border-color: #1F0B37; } +span.flag.lime { + background-color: #a3ff00; + color: #222222; + border-color: #00ff1e; +} + .tooltip>span { position: absolute; opacity: 0; @@ -627,3 +683,298 @@ span.flag.purple { margin-left: -100px; margin-right: 12px; } +.doc-inherited { + font-weight: bold; +} + +.anchor { + float: left; + padding-right: 4px; + margin-left: -20px; +} + +.main-content .anchor .octicon-link { + width: 16px; + height: 16px; +} + +.main-content .anchor:focus { + outline: none +} + +.main-content h1:hover .anchor, +.main-content h2:hover .anchor, +.main-content h3:hover .anchor, +.main-content h4:hover .anchor, +.main-content h5:hover .anchor, +.main-content h6:hover .anchor { + text-decoration: none +} + +.main-content h1 .octicon-link, +.main-content h2 .octicon-link, +.main-content h3 .octicon-link, +.main-content h4 .octicon-link, +.main-content h5 .octicon-link, +.main-content h6 .octicon-link { + visibility: hidden +} + +.main-content h1:hover .anchor .octicon-link, +.main-content h2:hover .anchor .octicon-link, +.main-content h3:hover .anchor .octicon-link, +.main-content h4:hover .anchor .octicon-link, +.main-content h5:hover .anchor .octicon-link, +.main-content h6:hover .anchor .octicon-link { + visibility: visible +} + +img { + max-width: 100%; +} + +table { + font-size: 14px; + display: block; + max-width: -moz-fit-content; + max-width: fit-content; + overflow-x: auto; + white-space: nowrap; + background: #fdfdfd; + text-align: center; + border: 1px solid #eee; + border-collapse: collapse; + padding: 0px 5px 0px 5px; +} + +table th { + padding: 10px; + letter-spacing: 1px; + border-bottom: 1px solid #eee; +} + +table td { + padding: 10px; +} + +#sidebar-btn { + height: 32px; + width: 32px; +} + +#sidebar-btn-label { + height: 2em; + width: 2em; +} + +#sidebar-btn, #sidebar-btn-label { + display: none; + margin: .7rem; + appearance: none; + color: black; + cursor: pointer; +} + +@media only screen and (max-width: 635px) { + .sidebar, .main-content { + /* svg size + vertical margin - .search-box padding-top */ + padding-top: calc(2em + 2 * 0.7rem - 13px); + } + + #sidebar-btn, #sidebar-btn-label { + display: block; + position: absolute; + z-index: 50; + transition-duration: 200ms; + left: 0; + } + + #sidebar-btn:not(:checked) ~ #sidebar-btn-label > .close, + #sidebar-btn:checked ~ #sidebar-btn-label > .open, + #sidebar-btn:checked ~ .main-content { + display: none; + } + + #sidebar-btn:checked { + left: calc(100% - 32px - (2 * 0.7rem)); + } + + #sidebar-btn:checked ~ #sidebar-btn-label { + color: white; + /* 100% - svg size - horizontal margin */ + left: calc(100% - 2em - (2 * 0.7rem)); + } + + #sidebar-btn~.sidebar { + width: 0%; + } + + #sidebar-btn:checked~.sidebar { + visibility: visible; + width: 100%; + } + + .sidebar { + transition-duration: 200ms; + max-width: 100vw; + visibility: hidden; + } +} + +@media (prefers-color-scheme: dark) { + html, body { + background: #1b1b1b; + } + + body { + color: white; + } + + a { + color: #8cb4ff; + } + + .main-content a:visited { + color: #5f8de3; + } + + h1, h2, h3, h4, h5, h6 { + color: white; + } + + h1.type-name { + color: white; + background-color: #202020; + border: 1px solid #353535; + } + + .project-versions-nav > option { + background-color: #222; + } + + .superclass-hierarchy .superclass a, + .superclass-hierarchy .superclass a:visited, + .other-type a, + .other-type a:visited, + .entry-summary .signature, + .entry-summary a:visited { + background-color: #202020; + color: white; + border: 1px solid #353535; + } + + .superclass-hierarchy .superclass a:hover, + .other-type a:hover, + .entry-summary .signature:hover { + background: #443d4d; + border-color: #b092d4; + } + + .kind { + color: #b092d4; + } + + .n { + color: #00ade6; + } + + .t { + color: #00ade6; + } + + .k { + color: #ff66ae; + } + + .o { + color: #ff66ae; + } + + .s { + color: #7799ff; + } + + .i { + color: #b38668; + } + + .m { + color: #b9a5d6; + } + + .c { + color: #a1a1a1; + } + + .methods-inherited a, .methods-inherited a:visited { + color: #B290D9; + } + + .methods-inherited a:hover { + color: #D4B7F4; + } + + .methods-inherited .tooltip>span { + background: #443d4d; + } + + .methods-inherited .tooltip * { + color: white; + } + + .entry-detail:target .signature { + background-color: #443d4d; + border: 1px solid #b092d4; + } + + .entry-detail .signature { + background-color: #202020; + color: white; + border: 1px solid #353535; + } + + .entry-detail .signature .method-permalink { + color: #b092d4; + } + + :not(pre)>code { + background-color: #202020; + } + + span.flag.purple { + background-color: #443d4d; + color: #ECE1F9; + border-color: #b092d4; + } + + .sidebar input::-webkit-input-placeholder { /* Chrome/Opera/Safari */ + color: white; + } + + .sidebar input::-moz-placeholder { /* Firefox 19+ */ + color: white; + } + + .sidebar input:-ms-input-placeholder { /* IE 10+ */ + color: white; + } + + .sidebar input:-moz-placeholder { /* Firefox 18- */ + color: white; + } + + pre, + table { + color: white; + background: #202020; + border: 1px solid #353535; + } + + table th { + border-bottom: 1px solid #353535; + } + + #sidebar-btn, #sidebar-btn-label { + color: white; + } +} diff --git a/docs/index.html b/docs/index.html index f4772ec..f08df0e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,66 +1,167 @@ - + - + + + + - + - - - README - github.com/nats-io/nats.cr + + nats main-dev + + + +
        -
        - README +
        +

        + + nats + +

        + + + main-dev +
        -
        +
          -
        • +
        • NATS @@ -73,45 +174,60 @@
          -

          NATS - Crystal Client

          - -

          Simple NATS client for the Crystal programming language.

          - -

          License Apache 2 -Build Status

          - -

          Installation

          - -
          1. Add the dependency to your shard.yml:
          - +

          +NATS - Crystal Client

          +

          Simple NATS client for the Crystal programming language.

          +

          License Apache 2 +Build Status

          +

          + +Installation

          +
            +
          1. Add the dependency to your shard.yml:
            2. +
             dependencies:
      nats:
        github: nats-io/nats.cr
          - -
          1. Run shards install
          - -

          Usage

          - -
          require "nats"
-
-nc = NATS::Connection.new("demo.nats.io")
-nc.subscribe("foo") { |msg| puts "Received '#{msg}'"}
-nc.publish("foo", "Hello!")
-
-sub = nc.subscribe("req") do |msg|
-  msg.respond("ANSWER is 42")
+
            
+
          1. Run shards install
            2. 
+
          
+
          
+  
+Usage
          
+
          require "nats/client"
+
+client = NATS::Client.new("nats://localhost:4222")
+client.connect
+
+client.subscribe("foo") do |msg|
+  puts "Received message on subject #{msg.subject}: #{msg.payload}"
 end
 
-answer = nc.request("req", "Help!")
-puts "Received a response '#{answer}'!"
+client.publish("foo", "Hello, NATS!")
 
-sub.close
+client.subscribe("bar") do |msg|
+  msg.reply "Received your message on bar: #{msg.payload}"
+end
 
-nc.flush
-nc.close
          
+response = client.request("bar", "Hello, bar!")
+puts "Received response: #{response.payload}"
 
-
          License
          
+client.request("bar") do |msg|
+  puts "Recieved async response: #{msg.payload}"
+end
 
+client.close
          +

          + +License

          Unless otherwise noted, the NATS source files are distributed under the Apache Version 2.0 license found in the LICENSE file.

          diff --git a/docs/index.json b/docs/index.json index 7756f72..95b7c10 100644 --- a/docs/index.json +++ b/docs/index.json @@ -1 +1 @@ -{"repository_name":"github.com/nats-io/nats.cr","body":"# NATS - Crystal Client\n\nSimple NATS client for the [Crystal](https://http://crystal-lang.org) programming language.\n\n[![License Apache 2](https://img.shields.io/badge/License-Apache2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)\n[![Build Status](https://travis-ci.org/nats-io/nats.cr.svg?branch=master)](http://travis-ci.org/nats-io/nats.cr)\n\n## Installation\n\n1. Add the dependency to your `shard.yml`:\n\n```yaml\n dependencies:\n nats:\n github: nats-io/nats.cr\n```\n\n2. Run `shards install`\n\n## Usage\n\n```crystal\nrequire \"nats\"\n\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc.subscribe(\"foo\") { |msg| puts \"Received '#{msg}'\"}\nnc.publish(\"foo\", \"Hello!\")\n\nsub = nc.subscribe(\"req\") do |msg|\n msg.respond(\"ANSWER is 42\")\nend\n\nanswer = nc.request(\"req\", \"Help!\")\nputs \"Received a response '#{answer}'!\"\n\nsub.close\n\nnc.flush\nnc.close\n```\n\n## License\n\nUnless otherwise noted, the NATS source files are distributed under\nthe Apache Version 2.0 license found in the LICENSE file.\n","program":{"html_id":"github.com/nats-io/nats.cr/toplevel","path":"toplevel.html","kind":"module","full_name":"Top Level Namespace","name":"Top Level Namespace","abstract":false,"superclass":null,"ancestors":[],"locations":[],"repository_name":"github.com/nats-io/nats.cr","program":true,"enum":false,"alias":false,"aliased":"","const":false,"constants":[],"included_modules":[],"extended_modules":[],"subclasses":[],"including_types":[],"namespace":null,"doc":null,"summary":null,"class_methods":[],"constructors":[],"instance_methods":[],"macros":[],"types":[{"html_id":"github.com/nats-io/nats.cr/NATS","path":"NATS.html","kind":"module","full_name":"NATS","name":"NATS","abstract":false,"superclass":null,"ancestors":[],"locations":[{"filename":"nats/nuid.cr","line_number":20,"url":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/nuid.cr"},{"filename":"nats/msg.cr","line_number":15,"url":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/msg.cr"},{"filename":"nats/subscription.cr","line_number":15,"url":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/subscription.cr"},{"filename":"nats/connection.cr","line_number":24,"url":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr"}],"repository_name":"github.com/nats-io/nats.cr","program":false,"enum":false,"alias":false,"aliased":"","const":false,"constants":[{"id":"LANG","name":"LANG","value":"\"crystal\"","doc":null,"summary":null},{"id":"VERSION","name":"VERSION","value":"\"0.0.1\"","doc":null,"summary":null}],"included_modules":[],"extended_modules":[],"subclasses":[],"including_types":[],"namespace":null,"doc":null,"summary":null,"class_methods":[],"constructors":[],"instance_methods":[],"macros":[],"types":[{"html_id":"github.com/nats-io/nats.cr/NATS/Connection","path":"NATS/Connection.html","kind":"class","full_name":"NATS::Connection","name":"Connection","abstract":false,"superclass":{"html_id":"github.com/nats-io/nats.cr/Reference","kind":"class","full_name":"Reference","name":"Reference"},"ancestors":[{"html_id":"github.com/nats-io/nats.cr/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"github.com/nats-io/nats.cr/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"nats/connection.cr","line_number":28,"url":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr"}],"repository_name":"github.com/nats-io/nats.cr","program":false,"enum":false,"alias":false,"aliased":"","const":false,"constants":[],"included_modules":[],"extended_modules":[],"subclasses":[],"including_types":[],"namespace":{"html_id":"github.com/nats-io/nats.cr/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":null,"summary":null,"class_methods":[],"constructors":[{"id":"new(host,port,user:String?=nil,pass:String?=nil,name:String?=nil,echo=true,pedantic=false)-class-method","html_id":"new(host,port,user:String?=nil,pass:String?=nil,name:String?=nil,echo=true,pedantic=false)-class-method","name":"new","doc":"Creates a new connection to a NATS Server.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc = NATS::Connection.new(\"tls://demo.nats.io\")\nnc = NATS::Connection.new(\"nats://#{user}:#{pass}@127.0.0.1:4222\")\nnc = NATS::Connection.new(4222, name: \"Sample App\", user: \"derek\", pass: \"s3cr3t\")\nnc = NATS::Connection.new(4222)\nnc = NATS::Connection.new\n```","summary":"

          Creates a new connection to a NATS Server.

          ","abstract":false,"args":[{"name":"host","doc":null,"default_value":"","external_name":"host","restriction":""},{"name":"port","doc":null,"default_value":"","external_name":"port","restriction":""},{"name":"user","doc":null,"default_value":"nil","external_name":"user","restriction":"String | ::Nil"},{"name":"pass","doc":null,"default_value":"nil","external_name":"pass","restriction":"String | ::Nil"},{"name":"name","doc":null,"default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"echo","doc":null,"default_value":"true","external_name":"echo","restriction":""},{"name":"pedantic","doc":null,"default_value":"false","external_name":"pedantic","restriction":""}],"args_string":"(host, port, user : String? = nil, pass : String? = nil, name : String? = nil, echo = true, pedantic = false)","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L55","def":{"name":"new","args":[{"name":"host","doc":null,"default_value":"","external_name":"host","restriction":""},{"name":"port","doc":null,"default_value":"","external_name":"port","restriction":""},{"name":"user","doc":null,"default_value":"nil","external_name":"user","restriction":"String | ::Nil"},{"name":"pass","doc":null,"default_value":"nil","external_name":"pass","restriction":"String | ::Nil"},{"name":"name","doc":null,"default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"echo","doc":null,"default_value":"true","external_name":"echo","restriction":""},{"name":"pedantic","doc":null,"default_value":"false","external_name":"pedantic","restriction":""}],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"_ = allocate\n_.initialize(host, port, user, pass, name, echo, pedantic)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"id":"close-instance-method","html_id":"close-instance-method","name":"close","doc":"Close a connection to the NATS server.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc.close\n```","summary":"

          Close a connection to the NATS server.

          ","abstract":false,"args":[],"args_string":"","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L347","def":{"name":"close","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"if @closed\n return\nend\n@closed = true\n@out.synchronize do\n flush_outbound\n @socket.flush\nend\n@socket.close\n@subs.each do |sid, sub|\n sub.unsubscribe\nend\n@close_cb.try do |cb|\n spawn(cb.call)\nend\n"}},{"id":"closed?:Bool-instance-method","html_id":"closed?:Bool-instance-method","name":"closed?","doc":null,"summary":null,"abstract":false,"args":[],"args_string":" : Bool","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L42","def":{"name":"closed?","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"@closed"}},{"id":"flush(timeout=2.second)-instance-method","html_id":"flush(timeout=2.second)-instance-method","name":"flush","doc":"Flush will flush the connection to the server. Can specify a *timeout*.","summary":"

          Flush will flush the connection to the server.

          ","abstract":false,"args":[{"name":"timeout","doc":null,"default_value":"2.second","external_name":"timeout","restriction":""}],"args_string":"(timeout = 2.second)","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L229","def":{"name":"flush","args":[{"name":"timeout","doc":null,"default_value":"2.second","external_name":"timeout","restriction":""}],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"ch = Channel(Nil).new\n@pongs.push(ch)\n@out.synchronize do\n @buf.write(PING_SLICE)\nend\nflush_outbound\nspawn do\n sleep(timeout)\n ch.close\nend\nbegin\n ch.receive\nrescue\n {raise(\"Flush Timeout\")}\nend\n"}},{"id":"max_payload:Int32-instance-method","html_id":"max_payload:Int32-instance-method","name":"max_payload","doc":null,"summary":null,"abstract":false,"args":[],"args_string":" : Int32","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L43","def":{"name":"max_payload","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"@max_payload"}},{"id":"new_inbox-instance-method","html_id":"new_inbox-instance-method","name":"new_inbox","doc":null,"summary":null,"abstract":false,"args":[],"args_string":"","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L238","def":{"name":"new_inbox","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"\"#{@resp_sub_prefix}.#{inbox_token}\""}},{"id":"on_close(&callback)-instance-method","html_id":"on_close(&callback)-instance-method","name":"on_close","doc":"Setup a callback for when the connection closes.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc.on_close { puts \"Connection closed!\" }\nnc.close\n```","summary":"

          Setup a callback for when the connection closes.

          ","abstract":false,"args":[],"args_string":"(&callback)","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L369","def":{"name":"on_close","args":[],"double_splat":null,"splat_index":null,"yields":0,"block_arg":{"name":"callback","doc":null,"default_value":"","external_name":"callback","restriction":""},"return_type":"","visibility":"Public","body":"@close_cb = callback"}},{"id":"on_error(&callback:String->)-instance-method","html_id":"on_error(&callback:String->)-instance-method","name":"on_error","doc":"Setup a callback for an async errors that are received.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc.on_error { |e| puts \"Received an error #{e}\" }\n```","summary":"

          Setup a callback for an async errors that are received.

          ","abstract":false,"args":[],"args_string":"(&callback : String -> )","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L379","def":{"name":"on_error","args":[],"double_splat":null,"splat_index":null,"yields":1,"block_arg":{"name":"callback","doc":null,"default_value":"","external_name":"callback","restriction":"(String -> )"},"return_type":"","visibility":"Public","body":"@err_cb = callback"}},{"id":"publish(subject:String,msg)-instance-method","html_id":"publish(subject:String,msg)-instance-method","name":"publish","doc":"Publishes a messages to a given subject.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc.publish(\"foo\", \"Hello!\")\n```","summary":"

          Publishes a messages to a given subject.

          ","abstract":false,"args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":"String"},{"name":"msg","doc":null,"default_value":"","external_name":"msg","restriction":""}],"args_string":"(subject : String, msg)","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L164","def":{"name":"publish","args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":"String"},{"name":"msg","doc":null,"default_value":"","external_name":"msg","restriction":""}],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"if subject.empty?\n raise(\"Bad Subject\")\nend\nif closed?\n raise(\"Connection Closed\")\nend\ndata = msg.to_slice\ncheck_size(data)\n@out.synchronize do\n @buf.write(PUB_SLICE)\n @buf.write(\"#{subject} #{data.size}\".to_slice)\n @buf.write(CR_LF_SLICE)\n @buf.write(data)\n @buf.write(CR_LF_SLICE)\nend\nif @flush.empty?\n @flush.send(true)\nend\n"}},{"id":"publish(subject:String)-instance-method","html_id":"publish(subject:String)-instance-method","name":"publish","doc":"Publishes an empty message to a given subject.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc.publish(\"foo\")\n```","summary":"

          Publishes an empty message to a given subject.

          ","abstract":false,"args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":"String"}],"args_string":"(subject : String)","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L188","def":{"name":"publish","args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":"String"}],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"if subject.empty?\n raise(\"Bad Subject\")\nend\nif closed?\n raise(\"Connection Closed\")\nend\n@out.synchronize do\n @buf.write(\"PUB #{subject} 0\\r\\n\\r\\n\".to_slice)\nend\nif @flush.empty?\n @flush.send(true)\nend\n"}},{"id":"publish_with_reply(subject,reply:String,msg)-instance-method","html_id":"publish_with_reply(subject,reply:String,msg)-instance-method","name":"publish_with_reply","doc":"Publishes a messages to a given subject with a reply subject.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc.publish_with_reply(\"foo\", \"reply\", \"Hello!\")\n```","summary":"

          Publishes a messages to a given subject with a reply subject.

          ","abstract":false,"args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":""},{"name":"reply","doc":null,"default_value":"","external_name":"reply","restriction":"String"},{"name":"msg","doc":null,"default_value":"","external_name":"msg","restriction":""}],"args_string":"(subject, reply : String, msg)","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L220","def":{"name":"publish_with_reply","args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":""},{"name":"reply","doc":null,"default_value":"","external_name":"reply","restriction":"String"},{"name":"msg","doc":null,"default_value":"","external_name":"msg","restriction":""}],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"if subject.empty?\n raise(\"Bad Subject\")\nend\nif closed?\n raise(\"Connection Closed\")\nend\n@out.synchronize do\n @buf.write(\"PUB #{subject} #{reply} 0\\r\\n\\r\\n\".to_slice)\nend\nif @flush.empty?\n @flush.send(true)\nend\n"}},{"id":"request(subject:String,msg?,timeout=2.second)-instance-method","html_id":"request(subject:String,msg?,timeout=2.second)-instance-method","name":"request","doc":"Request will send a request to the given subject and wait up to *timeout* for a response.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nanswer = nc.request(\"req\", \"Help!\")\nputs \"Received a response '#{answer}'!\"\n```","summary":"

          Request will send a request to the given subject and wait up to timeout for a response.

          ","abstract":false,"args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":"String"},{"name":"msg?","doc":null,"default_value":"","external_name":"msg?","restriction":""},{"name":"timeout","doc":null,"default_value":"2.second","external_name":"timeout","restriction":""}],"args_string":"(subject : String, msg?, timeout = 2.second)","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L275","def":{"name":"request","args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":"String"},{"name":"msg?","doc":null,"default_value":"","external_name":"msg?","restriction":""},{"name":"timeout","doc":null,"default_value":"2.second","external_name":"timeout","restriction":""}],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"if @resp_sub_created\nelse\n create_resp_subscription\nend\ntoken = inbox_token\nreply = \"#{@resp_sub_prefix}.#{token}\"\nch = Channel(Msg | ::Nil).new\n@resp_map[token] = ch\npublish_with_reply(subject, reply, msg?)\nspawn do\n sleep(timeout)\n ch.close\nend\nbegin\n msg = ch.receive\nrescue\n @resp_map.delete(token)\n raise(\"Request Timeout\")\nend\n"}},{"id":"subscribe(subject,queue:String,&callback:Msg->)-instance-method","html_id":"subscribe(subject,queue:String,&callback:Msg->)-instance-method","name":"subscribe","doc":"Subscribe to a given subject with the queue group. Will yield to the callback provided with the message received.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc.subscribe(\"foo\", \"group1\") { |msg| puts \"Received '#{msg}'\" }\n```","summary":"

          Subscribe to a given subject with the queue group.

          ","abstract":false,"args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":""},{"name":"queue","doc":null,"default_value":"","external_name":"queue","restriction":"String"}],"args_string":"(subject, queue : String, &callback : Msg -> )","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L321","def":{"name":"subscribe","args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":""},{"name":"queue","doc":null,"default_value":"","external_name":"queue","restriction":"String"}],"double_splat":null,"splat_index":null,"yields":1,"block_arg":{"name":"callback","doc":null,"default_value":"","external_name":"callback","restriction":"(Msg -> )"},"return_type":"","visibility":"Public","body":"sid = @gsid = @gsid + 1\n@out.synchronize do\n ((((@buf << \"SUB \") << subject) << \" \") << queue) << \" #{sid}\\r\\n\"\nend\nif @flush.empty?\n @flush.send(true)\nend\n(Subscription.new(sid, self, callback)).tap do |sub|\n @subs[sid] = sub\nend\n"}},{"id":"subscribe(subject:String,queue:String?,&callback:Msg->)-instance-method","html_id":"subscribe(subject:String,queue:String?,&callback:Msg->)-instance-method","name":"subscribe","doc":null,"summary":null,"abstract":false,"args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":"String"},{"name":"queue","doc":null,"default_value":"","external_name":"queue","restriction":"String | Nil"}],"args_string":"(subject : String, queue : String?, &callback : Msg -> )","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L330","def":{"name":"subscribe","args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":"String"},{"name":"queue","doc":null,"default_value":"","external_name":"queue","restriction":"String | Nil"}],"double_splat":null,"splat_index":null,"yields":1,"block_arg":{"name":"callback","doc":null,"default_value":"","external_name":"callback","restriction":"(Msg -> )"},"return_type":"","visibility":"Public","body":"if queue.is_a?(String)\n return subscribe(subject, queue, &callback)\nend\nsubscribe(subject, &callback)\n"}},{"id":"subscribe(subject:String,&callback:Msg->)-instance-method","html_id":"subscribe(subject:String,&callback:Msg->)-instance-method","name":"subscribe","doc":"Subscribe to a given subject. Will yield to the callback provided with the message received.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc.subscribe(\"foo\") { |msg| puts \"Received '#{msg}'\" }\n```","summary":"

          Subscribe to a given subject.

          ","abstract":false,"args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":"String"}],"args_string":"(subject : String, &callback : Msg -> )","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L306","def":{"name":"subscribe","args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":"String"}],"double_splat":null,"splat_index":null,"yields":1,"block_arg":{"name":"callback","doc":null,"default_value":"","external_name":"callback","restriction":"(Msg -> )"},"return_type":"","visibility":"Public","body":"sid = @gsid = @gsid + 1\n@out.synchronize do\n ((@buf << \"SUB \") << subject) << \" #{sid}\\r\\n\"\nend\nif @flush.empty?\n @flush.send(true)\nend\n(Subscription.new(sid, self, callback)).tap do |sub|\n @subs[sid] = sub\nend\n"}}],"macros":[],"types":[]},{"html_id":"github.com/nats-io/nats.cr/NATS/Msg","path":"NATS/Msg.html","kind":"class","full_name":"NATS::Msg","name":"Msg","abstract":false,"superclass":{"html_id":"github.com/nats-io/nats.cr/Reference","kind":"class","full_name":"Reference","name":"Reference"},"ancestors":[{"html_id":"github.com/nats-io/nats.cr/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"github.com/nats-io/nats.cr/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"nats/msg.cr","line_number":27,"url":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/msg.cr"}],"repository_name":"github.com/nats-io/nats.cr","program":false,"enum":false,"alias":false,"aliased":"","const":false,"constants":[],"included_modules":[],"extended_modules":[],"subclasses":[],"including_types":[],"namespace":{"html_id":"github.com/nats-io/nats.cr/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"A delivered message from a subscription.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc.subscribe(\"foo\") do |msg|\n puts \"Received '#{msg}'\"\n puts \"Subject is #{msg.subject}\"\n puts \"Reply Subject is #{msg.reply}\"\n puts \"Raw Data is #{msg.data}\"\nend\n```","summary":"

          A delivered message from a subscription.

          ","class_methods":[],"constructors":[],"instance_methods":[{"id":"data:Bytes-instance-method","html_id":"data:Bytes-instance-method","name":"data","doc":null,"summary":null,"abstract":false,"args":[],"args_string":" : Bytes","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/msg.cr#L32","def":{"name":"data","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"Bytes","visibility":"Public","body":"@data"}},{"id":"reply:String?-instance-method","html_id":"reply:String?-instance-method","name":"reply","doc":null,"summary":null,"abstract":false,"args":[],"args_string":" : String?","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/msg.cr#L31","def":{"name":"reply","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"String | ::Nil","visibility":"Public","body":"@reply"}},{"id":"respond(msg)-instance-method","html_id":"respond(msg)-instance-method","name":"respond","doc":"Allows a response to a request message to be easily sent.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc.subscribe(\"req\") do |msg|\n msg.respond(\"ANSWER is 42\")\nend\n```","summary":"

          Allows a response to a request message to be easily sent.

          ","abstract":false,"args":[{"name":"msg","doc":null,"default_value":"","external_name":"msg","restriction":""}],"args_string":"(msg)","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/msg.cr#L54","def":{"name":"respond","args":[{"name":"msg","doc":null,"default_value":"","external_name":"msg","restriction":""}],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"if @reply.nil?\n raise(\"No reply subject\")\nend\nif @conn.nil?\n raise(\"Not a received message\")\nend\n@conn.try(&.publish(@reply.to_s, msg))\n"}},{"id":"subject:String-instance-method","html_id":"subject:String-instance-method","name":"subject","doc":null,"summary":null,"abstract":false,"args":[],"args_string":" : String","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/msg.cr#L30","def":{"name":"subject","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"String","visibility":"Public","body":"@subject"}}],"macros":[],"types":[]},{"html_id":"github.com/nats-io/nats.cr/NATS/NUID","path":"NATS/NUID.html","kind":"class","full_name":"NATS::NUID","name":"NUID","abstract":false,"superclass":{"html_id":"github.com/nats-io/nats.cr/Reference","kind":"class","full_name":"Reference","name":"Reference"},"ancestors":[{"html_id":"github.com/nats-io/nats.cr/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"github.com/nats-io/nats.cr/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"nats/nuid.cr","line_number":21,"url":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/nuid.cr"}],"repository_name":"github.com/nats-io/nats.cr","program":false,"enum":false,"alias":false,"aliased":"","const":false,"constants":[{"id":"BASE","name":"BASE","value":"62","doc":null,"summary":null},{"id":"DIGITS","name":"DIGITS","value":"\"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\"","doc":null,"summary":null},{"id":"INC","name":"INC","value":"MAX_INC - MIN_INC","doc":null,"summary":null},{"id":"MAX_INC","name":"MAX_INC","value":"333_i64","doc":null,"summary":null},{"id":"MAX_SEQ","name":"MAX_SEQ","value":"839299365868340224_i64","doc":null,"summary":null},{"id":"MIN_INC","name":"MIN_INC","value":"33_i64","doc":null,"summary":null},{"id":"PREFIX_LENGTH","name":"PREFIX_LENGTH","value":"12","doc":null,"summary":null},{"id":"SEQ_LENGTH","name":"SEQ_LENGTH","value":"10","doc":null,"summary":null},{"id":"TOTAL_LENGTH","name":"TOTAL_LENGTH","value":"PREFIX_LENGTH + SEQ_LENGTH","doc":null,"summary":null}],"included_modules":[],"extended_modules":[],"subclasses":[],"including_types":[],"namespace":{"html_id":"github.com/nats-io/nats.cr/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":null,"summary":null,"class_methods":[],"constructors":[{"id":"new-class-method","html_id":"new-class-method","name":"new","doc":null,"summary":null,"abstract":false,"args":[],"args_string":"","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/nuid.cr#L32","def":{"name":"new","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"_ = allocate\n_.initialize\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"id":"next-instance-method","html_id":"next-instance-method","name":"next","doc":null,"summary":null,"abstract":false,"args":[],"args_string":"","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/nuid.cr#L38","def":{"name":"next","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"@seq = @seq + @inc\nif @seq >= MAX_SEQ\n reset!\nend\nl = @seq\ns_10 = DIGITS[l % BASE]\ns_09, s_08, s_07, s_06, s_05, s_04, s_03, s_02, s_01 = (l = l / BASE\nDIGITS[l % BASE]), (l = l / BASE\nDIGITS[l % BASE]), (l = l / BASE\nDIGITS[l % BASE]), (l = l / BASE\nDIGITS[l % BASE]), (l = l / BASE\nDIGITS[l % BASE]), (l = l / BASE\nDIGITS[l % BASE]), (l = l / BASE\nDIGITS[l % BASE]), (l = l / BASE\nDIGITS[l % BASE]), (l = l / BASE\nDIGITS[l % BASE])\n\"#{@prefix}#{s_01}#{s_02}#{s_03}#{s_04}#{s_05}#{s_06}#{s_07}#{s_08}#{s_09}#{s_10}\"\n"}},{"id":"randomize_prefix!-instance-method","html_id":"randomize_prefix!-instance-method","name":"randomize_prefix!","doc":null,"summary":null,"abstract":false,"args":[],"args_string":"","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/nuid.cr#L60","def":{"name":"randomize_prefix!","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"@prefix = String::Builder.build(PREFIX_LENGTH) do |io|\n Random::Secure.random_bytes(@pre_bytes)\n @pre_bytes.each do |n|\n io << \"#{DIGITS[n % BASE]}\"\n end\nend"}}],"macros":[],"types":[]},{"html_id":"github.com/nats-io/nats.cr/NATS/Subscription","path":"NATS/Subscription.html","kind":"class","full_name":"NATS::Subscription","name":"Subscription","abstract":false,"superclass":{"html_id":"github.com/nats-io/nats.cr/Reference","kind":"class","full_name":"Reference","name":"Reference"},"ancestors":[{"html_id":"github.com/nats-io/nats.cr/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"github.com/nats-io/nats.cr/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"nats/subscription.cr","line_number":24,"url":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/subscription.cr"}],"repository_name":"github.com/nats-io/nats.cr","program":false,"enum":false,"alias":false,"aliased":"","const":false,"constants":[],"included_modules":[],"extended_modules":[],"subclasses":[],"including_types":[],"namespace":{"html_id":"github.com/nats-io/nats.cr/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"A subscription to a given subject and possible queue group. Used to unsubscribe/close.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nsub = nc.subscribe(\"foo\") { |msg| }\nsub.close\nsub.unsubscribe\n```","summary":"

          A subscription to a given subject and possible queue group.

          ","class_methods":[],"constructors":[],"instance_methods":[{"id":"close-instance-method","html_id":"close-instance-method","name":"close","doc":"Will unsubscribe from a subscription.","summary":"

          Will unsubscribe from a subscription.

          ","abstract":false,"args":[],"args_string":"","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/subscription.cr#L39","def":{"name":"close","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"unsubscribe"}},{"id":"closed?-instance-method","html_id":"closed?-instance-method","name":"closed?","doc":"Determines if the subscription is already closed.","summary":"

          Determines if the subscription is already closed.

          ","abstract":false,"args":[],"args_string":"","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/subscription.cr#L44","def":{"name":"closed?","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"return @msgs.closed?"}},{"id":"unsubscribe-instance-method","html_id":"unsubscribe-instance-method","name":"unsubscribe","doc":"Will unsubscribe from a subscription.","summary":"

          Will unsubscribe from a subscription.

          ","abstract":false,"args":[],"args_string":"","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/subscription.cr#L31","def":{"name":"unsubscribe","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"if closed?\nelse\n @conn.unsubscribe(@sid)\n @msgs.close\nend"}}],"macros":[],"types":[]}]}]}} \ No newline at end of file +{"repository_name":"nats","body":"# NATS - Crystal Client\n\nSimple NATS client for the [Crystal](https://crystal-lang.org) programming language.\n\n[![License Apache 2](https://img.shields.io/badge/License-Apache2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)\n[![Build Status](https://travis-ci.org/nats-io/nats.cr.svg?branch=master)](http://travis-ci.org/nats-io/nats.cr)\n\n## Installation\n\n1. Add the dependency to your `shard.yml`:\n\n```yaml\n dependencies:\n nats:\n github: nats-io/nats.cr\n```\n\n2. Run `shards install`\n\n## Usage\n\n```crystal\nrequire \"nats/client\"\n\nclient = NATS::Client.new(\"nats://localhost:4222\")\nclient.connect\n\nclient.subscribe(\"foo\") do |msg|\n puts \"Received message on subject #{msg.subject}: #{msg.payload}\"\nend\n\nclient.publish(\"foo\", \"Hello, NATS!\")\n\nclient.subscribe(\"bar\") do |msg|\n msg.reply \"Received your message on bar: #{msg.payload}\"\nend\n\nresponse = client.request(\"bar\", \"Hello, bar!\")\nputs \"Received response: #{response.payload}\"\n\nclient.request(\"bar\") do |msg|\n puts \"Recieved async response: #{msg.payload}\"\nend\n\nclient.close\n```\n\n## License\n\nUnless otherwise noted, the NATS source files are distributed under\nthe Apache Version 2.0 license found in the LICENSE file.\n","program":{"html_id":"nats/toplevel","path":"toplevel.html","kind":"module","full_name":"Top Level Namespace","name":"Top Level Namespace","abstract":false,"locations":[],"repository_name":"nats","program":true,"enum":false,"alias":false,"const":false,"types":[{"html_id":"nats/NATS","path":"NATS.html","kind":"module","full_name":"NATS","name":"NATS","abstract":false,"locations":[{"filename":"src/nats.cr","line_number":3,"url":null},{"filename":"src/nats/client.cr","line_number":27,"url":null},{"filename":"src/nats/client/status.cr","line_number":15,"url":null},{"filename":"src/nats/errors.cr","line_number":15,"url":null},{"filename":"src/nats/message/connect.cr","line_number":15,"url":null},{"filename":"src/nats/message/info.cr","line_number":15,"url":null},{"filename":"src/nats/message/msg.cr","line_number":17,"url":null},{"filename":"src/nats/message/pub.cr","line_number":15,"url":null},{"filename":"src/nats/message/sub.cr","line_number":15,"url":null},{"filename":"src/nats/message/unsub.cr","line_number":15,"url":null},{"filename":"src/nats/nuid.cr","line_number":17,"url":null},{"filename":"src/nats/options.cr","line_number":15,"url":null},{"filename":"src/nats/subscription.cr","line_number":15,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"constants":[{"id":"VERSION","name":"VERSION","value":"{{ (`shards version /home/zbensley/Documents/git/nats.cr/src`).chomp.stringify }}"}],"class_methods":[{"html_id":"connect(uri:String|URI=Client::DEFAULT_URI):Client-class-method","name":"connect","doc":"Connects to a NATS server using the provided URI.\n\n*uri*: The URI of the NATS server to connect to.","summary":"

          Connects to a NATS server using the provided URI.

          ","abstract":false,"args":[{"name":"uri","default_value":"Client::DEFAULT_URI","external_name":"uri","restriction":"String | URI"}],"args_string":"(uri : String | URI = Client::DEFAULT_URI) : Client","args_html":"(uri : String | URI = Client::DEFAULT_URI) : Client","location":{"filename":"src/nats.cr","line_number":9,"url":null},"def":{"name":"connect","args":[{"name":"uri","default_value":"Client::DEFAULT_URI","external_name":"uri","restriction":"String | URI"}],"return_type":"Client","visibility":"Public","body":"(Client.new(uri)).connect"},"external_var":false}],"types":[{"html_id":"nats/NATS/AuthenticationError","path":"NATS/AuthenticationError.html","kind":"class","full_name":"NATS::AuthenticationError","name":"AuthenticationError","abstract":false,"superclass":{"html_id":"nats/NATS/ERRError","kind":"class","full_name":"NATS::ERRError","name":"ERRError"},"ancestors":[{"html_id":"nats/NATS/ERRError","kind":"class","full_name":"NATS::ERRError","name":"ERRError"},{"html_id":"nats/NATS/Error","kind":"class","full_name":"NATS::Error","name":"Error"},{"html_id":"nats/Exception","kind":"class","full_name":"Exception","name":"Exception"},{"html_id":"nats/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/errors.cr","line_number":43,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"nats/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"+AuthenticationError+ is raised when the NATS server indicates an authentication error.","summary":"

          +AuthenticationError+ is raised when the NATS server indicates an authentication error.

          ","constructors":[{"html_id":"new(msg=\"Authenticationfailed\")-class-method","name":"new","abstract":false,"args":[{"name":"msg","default_value":"\"Authentication failed\"","external_name":"msg","restriction":""}],"args_string":"(msg = \"Authentication failed\")","args_html":"(msg = "Authentication failed")","location":{"filename":"src/nats/errors.cr","line_number":44,"url":null},"def":{"name":"new","args":[{"name":"msg","default_value":"\"Authentication failed\"","external_name":"msg","restriction":""}],"visibility":"Public","body":"_ = allocate\n_.initialize(msg)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}]},{"html_id":"nats/NATS/Client","path":"NATS/Client.html","kind":"class","full_name":"NATS::Client","name":"Client","abstract":false,"superclass":{"html_id":"nats/Reference","kind":"class","full_name":"Reference","name":"Reference"},"ancestors":[{"html_id":"nats/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/client.cr","line_number":57,"url":null},{"filename":"src/nats/client/status.cr","line_number":16,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"constants":[{"id":"BUFFER_SIZE","name":"BUFFER_SIZE","value":"32768","doc":"Buffer Size for the socket","summary":"

          Buffer Size for the socket

          "},{"id":"DEFAULT_HOST","name":"DEFAULT_HOST","value":"\"localhost\"","doc":"Default Host for NATS Server","summary":"

          Default Host for NATS Server

          "},{"id":"DEFAULT_PORT","name":"DEFAULT_PORT","value":"4222","doc":"Default Port for NATS Server","summary":"

          Default Port for NATS Server

          "},{"id":"DEFAULT_URI","name":"DEFAULT_URI","value":"URI.parse(\"nats://#{DEFAULT_HOST}:#{DEFAULT_PORT}\")","doc":"Default URI for NATS Server","summary":"

          Default URI for NATS Server

          "}],"namespace":{"html_id":"nats/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"NATS Client for connecting to a NATS server.\\\nThis client allows you to subscribe and publish messages.\n\nExample:\n```\nrequire \"nats/client\"\n\nclient = NATS::Client.new(\"nats://localhost:4222\")\nclient.connect\n\nclient.subscribe(\"foo\") do |msg|\n puts \"Received message on subject #{msg.subject}: #{msg.payload}\"\nend\n\nclient.publish(\"foo\", \"Hello, NATS!\")\n\nclient.subscribe(\"bar\") do |msg|\n msg.reply \"Received your message on bar: #{msg.payload}\"\nend\n\nresponse = client.request(\"bar\", \"Hello, bar!\")\nputs \"Received response: #{response.payload}\"\n\nclient.request(\"bar\") do |msg|\n puts \"Recieved async response: #{msg.payload}\"\nend\n\nclient.close\n```","summary":"

          NATS Client for connecting to a NATS server.\\ This client allows you to subscribe and publish messages.

          ","constructors":[{"html_id":"new(uri:String|URI=DEFAULT_URI,options:Options=Options.new,user:String|Nil=nil,pass:String|Nil=nil,jwt:String|Nil=nil)-class-method","name":"new","abstract":false,"args":[{"name":"uri","default_value":"DEFAULT_URI","external_name":"uri","restriction":"String | URI"},{"name":"options","default_value":"Options.new","external_name":"options","restriction":"Options"},{"name":"user","default_value":"nil","external_name":"user","restriction":"String | ::Nil"},{"name":"pass","default_value":"nil","external_name":"pass","restriction":"String | ::Nil"},{"name":"jwt","default_value":"nil","external_name":"jwt","restriction":"String | ::Nil"}],"args_string":"(uri : String | URI = DEFAULT_URI, options : Options = Options.new, user : String | Nil = nil, pass : String | Nil = nil, jwt : String | Nil = nil)","args_html":"(uri : String | URI = DEFAULT_URI, options : Options = Options.new, user : String | Nil = nil, pass : String | Nil = nil, jwt : String | Nil = nil)","location":{"filename":"src/nats/client.cr","line_number":78,"url":null},"def":{"name":"new","args":[{"name":"uri","default_value":"DEFAULT_URI","external_name":"uri","restriction":"String | URI"},{"name":"options","default_value":"Options.new","external_name":"options","restriction":"Options"},{"name":"user","default_value":"nil","external_name":"user","restriction":"String | ::Nil"},{"name":"pass","default_value":"nil","external_name":"pass","restriction":"String | ::Nil"},{"name":"jwt","default_value":"nil","external_name":"jwt","restriction":"String | ::Nil"}],"visibility":"Public","body":"_ = allocate\n_.initialize(uri, options, user, pass, jwt)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}],"instance_methods":[{"html_id":"close-instance-method","name":"close","doc":"Closes the NATS connection and cleans up resources.","summary":"

          Closes the NATS connection and cleans up resources.

          ","abstract":false,"location":{"filename":"src/nats/client.cr","line_number":228,"url":null},"def":{"name":"close","visibility":"Public","body":"if status == Status::CLOSED\n return\nend\n\n\n@status = Status::DRAINING_SUBS\n@subs.each_value(&.unsubscribe)\n@subs.clear\n\n\n@socket_mutex.synchronize do\n @pongs.each(&.close)\n @pongs.clear\n\n if @socket.closed?\n else\n @status = Status::DRAINING_PUBS\n @socket.flush\n @socket.close\n end\n @status = Status::CLOSED\nend\n"},"external_var":false},{"html_id":"connect:self-instance-method","name":"connect","doc":"Connects to the NATS server","summary":"

          Connects to the NATS server

          ","abstract":false,"location":{"filename":"src/nats/client.cr","line_number":96,"url":null},"def":{"name":"connect","return_type":"self","visibility":"Public","body":"@status = Status::CONNECTING\nsetup_socket\n\n\nhandle_info(parse_info(@socket.read_line))\n\n\nsend_connect\nfirst_connection_ok?\n@status = Status::CONNECTED\n\n\nspawn(handle_messages)\n\nspawn(flush)\n\nself\n"},"external_var":false},{"html_id":"connected?:Bool-instance-method","name":"connected?","doc":"Checks if the client is connected to the NATS server.\\\nWill send a PING message and wait for a PONG response.","summary":"

          Checks if the client is connected to the NATS server.\\ Will send a PING message and wait for a PONG response.

          ","abstract":false,"location":{"filename":"src/nats/client.cr","line_number":252,"url":null},"def":{"name":"connected?","return_type":"Bool","visibility":"Public","body":"if status == Status::CLOSED\n return false\nend\n\nchannel = Channel(Nil).new\n@pongs.push(channel)\nsend_msg!(\"PING\")\nspawn do\n sleep(@options.timeout)\n channel.close\nend\nbegin\n channel.receive\nrescue\n {raise(TimeoutError.new(\"PING timeout\"))}\nend\ntrue\n"},"external_var":false},{"html_id":"publish(subject:String,payload:String)-instance-method","name":"publish","doc":"Publishes a message to the specified subject.\n\n*subject*: The subject to publish to.\\\n*payload*: The message payload.","summary":"

          Publishes a message to the specified subject.

          ","abstract":false,"args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"payload","external_name":"payload","restriction":"String"}],"args_string":"(subject : String, payload : String)","args_html":"(subject : String, payload : String)","location":{"filename":"src/nats/client.cr","line_number":158,"url":null},"def":{"name":"publish","args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"payload","external_name":"payload","restriction":"String"}],"visibility":"Public","body":"if status == Status::CLOSED\n raise(ClientClosedError.new)\nend\n\nmsg = Message::PUB.new(subject: subject, payload: payload)\nsend_msg!(msg.to_s)\n"},"external_var":false},{"html_id":"request(subject:String,payload:String,timeout:Time::Span|Nil=nil):Message::MSG-instance-method","name":"request","doc":"Publishes a message to the specified subject and waits for a response.\n\n*subject*: The subject to publish to.\\\n*payload*: The message payload.\\\n*timeout*: Optional timeout for waiting for a response. Will use `Options.timeout` if not set.","summary":"

          Publishes a message to the specified subject and waits for a response.

          ","abstract":false,"args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"payload","external_name":"payload","restriction":"String"},{"name":"timeout","default_value":"nil","external_name":"timeout","restriction":"Time::Span | ::Nil"}],"args_string":"(subject : String, payload : String, timeout : Time::Span | Nil = nil) : Message::MSG","args_html":"(subject : String, payload : String, timeout : Time::Span | Nil = nil) : Message::MSG","location":{"filename":"src/nats/client.cr","line_number":173,"url":null},"def":{"name":"request","args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"payload","external_name":"payload","restriction":"String"},{"name":"timeout","default_value":"nil","external_name":"timeout","restriction":"Time::Span | ::Nil"}],"return_type":"Message::MSG","visibility":"Public","body":"begin\n if status == Status::CLOSED\n raise(ClientClosedError.new)\n end\n\n msg = Message::PUB.new(subject: subject, reply_to: new_inbox, payload: payload)\n send_msg!(msg.to_s)\n channel = Channel(Message::MSG).new\n reply_sub = subscribe(msg.reply_to.to_s) do |response_msg|\n channel.send(response_msg)\n end\n spawn do\n sleep(timeout || @options.timeout)\n channel.close\n end\n\n begin\n channel.receive\n rescue\n raise(TimeoutError.new(\"Request Timeout\"))\n end\nensure\n if @subs.has_key?(reply_sub.try(&.sid))\n @subs[reply_sub.try(&.sid)].unsubscribe\n end\n if reply_sub.try(&.sid)\n @subs.delete(reply_sub.try(&.sid))\n end\nend"},"external_var":false},{"html_id":"request(subject:String,payload:String,&callback:Message::MSG->Nil)-instance-method","name":"request","doc":"Publishes a message to the specified subject and sends response to callback when available.\n\n*subject*: The subject to publish to.\\\n*payload*: The message payload.\\\n*callback*: Callback to handle the response message.","summary":"

          Publishes a message to the specified subject and sends response to callback when available.

          ","abstract":false,"args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"payload","external_name":"payload","restriction":"String"}],"args_string":"(subject : String, payload : String, &callback : Message::MSG -> Nil)","args_html":"(subject : String, payload : String, &callback : Message::MSG -> Nil)","location":{"filename":"src/nats/client.cr","line_number":206,"url":null},"def":{"name":"request","args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"payload","external_name":"payload","restriction":"String"}],"yields":1,"block_arity":1,"block_arg":{"name":"callback","external_name":"callback","restriction":"(Message::MSG -> Nil)"},"visibility":"Public","body":"if status == Status::CLOSED\n raise(ClientClosedError.new)\nend\n\nmsg = Message::PUB.new(subject: subject, reply_to: new_inbox, payload: payload)\nsend_msg(msg.to_s)\nspawn do\n begin\n channel = Channel(Message::MSG).new\n reply_sub = subscribe(msg.reply_to.to_s) do |response_msg|\n channel.send(response_msg)\n end\n callback.call(channel.receive)\n ensure\n if @subs.has_key?(reply_sub.try(&.sid))\n @subs[reply_sub.try(&.sid)].unsubscribe\n end\n if reply_sub.try(&.sid)\n @subs.delete(reply_sub.try(&.sid))\n end\n end\nend\n"},"external_var":false},{"html_id":"status:Status-instance-method","name":"status","doc":"The current status of the client connection.","summary":"

          The current status of the client connection.

          ","abstract":false,"location":{"filename":"src/nats/client.cr","line_number":68,"url":null},"def":{"name":"status","return_type":"Status","visibility":"Public","body":"@status"},"external_var":false},{"html_id":"subscribe(subject:String,queue_group:String|Nil=nil,&callback:Message::MSG->Nil):Subscription-instance-method","name":"subscribe","doc":"Subscribe to a subject, messages will be delivered to the provided callback.\n\n*subject*: The subject to subscribe to.\\\n*queue_group*: Optional queue group for load balancing.\\\n*callback*: The callback to handle incoming messages.","summary":"

          Subscribe to a subject, messages will be delivered to the provided callback.

          ","abstract":false,"args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"queue_group","default_value":"nil","external_name":"queue_group","restriction":"String | ::Nil"}],"args_string":"(subject : String, queue_group : String | Nil = nil, &callback : Message::MSG -> Nil) : Subscription","args_html":"(subject : String, queue_group : String | Nil = nil, &callback : Message::MSG -> Nil) : Subscription","location":{"filename":"src/nats/client.cr","line_number":121,"url":null},"def":{"name":"subscribe","args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"queue_group","default_value":"nil","external_name":"queue_group","restriction":"String | ::Nil"}],"yields":1,"block_arity":1,"block_arg":{"name":"callback","external_name":"callback","restriction":"(Message::MSG -> Nil)"},"return_type":"Subscription","visibility":"Public","body":"if status == Status::CLOSED\n raise(ClientClosedError.new)\nend\n\nsid = next_sid\nsub = Subscription.new(subject: subject, sid: sid, callback: callback, client: self, queue_group: queue_group)\n\nmsg = Message::SUB.new(subject: subject, queue_group: queue_group, sid: sid.to_s)\nsend_msg!(msg.to_s)\n@subs[sid] = sub\n"},"external_var":false},{"html_id":"unsubscribe(sub:Subscription)-instance-method","name":"unsubscribe","doc":"Unsubscribes from a subject.\n\n*sub*: The subscription to unsubscribe from.","summary":"

          Unsubscribes from a subject.

          ","abstract":false,"args":[{"name":"sub","external_name":"sub","restriction":"Subscription"}],"args_string":"(sub : Subscription)","args_html":"(sub : Subscription)","location":{"filename":"src/nats/client.cr","line_number":145,"url":null},"def":{"name":"unsubscribe","args":[{"name":"sub","external_name":"sub","restriction":"Subscription"}],"visibility":"Public","body":"if status == Status::CLOSED\n raise(ClientClosedError.new)\nend\n\nsid = sub.sid\nunsub = Message::UNSUB.new(sid: sid.to_s)\nsend_msg!(unsub.to_s)\n@subs.delete(sid)\n"},"external_var":false}],"types":[{"html_id":"nats/NATS/Client/Status","path":"NATS/Client/Status.html","kind":"enum","full_name":"NATS::Client::Status","name":"Status","abstract":false,"ancestors":[{"html_id":"nats/Enum","kind":"struct","full_name":"Enum","name":"Enum"},{"html_id":"nats/Comparable","kind":"module","full_name":"Comparable","name":"Comparable"},{"html_id":"nats/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/client/status.cr","line_number":17,"url":null}],"repository_name":"nats","program":false,"enum":true,"alias":false,"const":false,"constants":[{"id":"DISCONNECTED","name":"DISCONNECTED","value":"0","doc":"When the client is not actively connected.","summary":"

          When the client is not actively connected.

          "},{"id":"CONNECTED","name":"CONNECTED","value":"1","doc":"When the client is connected.","summary":"

          When the client is connected.

          "},{"id":"CLOSED","name":"CLOSED","value":"2","doc":"When the client will no longer attempt to connect to a NATS Server.","summary":"

          When the client will no longer attempt to connect to a NATS Server.

          "},{"id":"RECONNECTING","name":"RECONNECTING","value":"3","doc":"When the client has disconnected and is attempting to reconnect.","summary":"

          When the client has disconnected and is attempting to reconnect.

          "},{"id":"CONNECTING","name":"CONNECTING","value":"4","doc":"When the client is attempting to connect to a NATS Server for the first time.","summary":"

          When the client is attempting to connect to a NATS Server for the first time.

          "},{"id":"DRAINING_SUBS","name":"DRAINING_SUBS","value":"5","doc":"When the client is draining a connection before closing.","summary":"

          When the client is draining a connection before closing.

          "},{"id":"DRAINING_PUBS","name":"DRAINING_PUBS","value":"6","doc":"When the client is draining a connection before closing.","summary":"

          When the client is draining a connection before closing.

          "}],"namespace":{"html_id":"nats/NATS/Client","kind":"class","full_name":"NATS::Client","name":"Client"},"instance_methods":[{"html_id":"closed?-instance-method","name":"closed?","doc":"Returns `true` if this enum value equals `CLOSED`","summary":"

          Returns true if this enum value equals CLOSED

          ","abstract":false,"location":{"filename":"src/nats/client/status.cr","line_number":25,"url":null},"def":{"name":"closed?","visibility":"Public","body":"self == CLOSED"},"external_var":false},{"html_id":"connected?-instance-method","name":"connected?","doc":"Returns `true` if this enum value equals `CONNECTED`","summary":"

          Returns true if this enum value equals CONNECTED

          ","abstract":false,"location":{"filename":"src/nats/client/status.cr","line_number":22,"url":null},"def":{"name":"connected?","visibility":"Public","body":"self == CONNECTED"},"external_var":false},{"html_id":"connecting?-instance-method","name":"connecting?","doc":"Returns `true` if this enum value equals `CONNECTING`","summary":"

          Returns true if this enum value equals CONNECTING

          ","abstract":false,"location":{"filename":"src/nats/client/status.cr","line_number":31,"url":null},"def":{"name":"connecting?","visibility":"Public","body":"self == CONNECTING"},"external_var":false},{"html_id":"disconnected?-instance-method","name":"disconnected?","doc":"Returns `true` if this enum value equals `DISCONNECTED`","summary":"

          Returns true if this enum value equals DISCONNECTED

          ","abstract":false,"location":{"filename":"src/nats/client/status.cr","line_number":19,"url":null},"def":{"name":"disconnected?","visibility":"Public","body":"self == DISCONNECTED"},"external_var":false},{"html_id":"draining_pubs?-instance-method","name":"draining_pubs?","doc":"Returns `true` if this enum value equals `DRAINING_PUBS`","summary":"

          Returns true if this enum value equals DRAINING_PUBS

          ","abstract":false,"location":{"filename":"src/nats/client/status.cr","line_number":37,"url":null},"def":{"name":"draining_pubs?","visibility":"Public","body":"self == DRAINING_PUBS"},"external_var":false},{"html_id":"draining_subs?-instance-method","name":"draining_subs?","doc":"Returns `true` if this enum value equals `DRAINING_SUBS`","summary":"

          Returns true if this enum value equals DRAINING_SUBS

          ","abstract":false,"location":{"filename":"src/nats/client/status.cr","line_number":34,"url":null},"def":{"name":"draining_subs?","visibility":"Public","body":"self == DRAINING_SUBS"},"external_var":false},{"html_id":"reconnecting?-instance-method","name":"reconnecting?","doc":"Returns `true` if this enum value equals `RECONNECTING`","summary":"

          Returns true if this enum value equals RECONNECTING

          ","abstract":false,"location":{"filename":"src/nats/client/status.cr","line_number":28,"url":null},"def":{"name":"reconnecting?","visibility":"Public","body":"self == RECONNECTING"},"external_var":false}]}]},{"html_id":"nats/NATS/ClientClosedError","path":"NATS/ClientClosedError.html","kind":"class","full_name":"NATS::ClientClosedError","name":"ClientClosedError","abstract":false,"superclass":{"html_id":"nats/NATS/Error","kind":"class","full_name":"NATS::Error","name":"Error"},"ancestors":[{"html_id":"nats/NATS/Error","kind":"class","full_name":"NATS::Error","name":"Error"},{"html_id":"nats/Exception","kind":"class","full_name":"Exception","name":"Exception"},{"html_id":"nats/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/errors.cr","line_number":22,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"nats/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"+ClientClosed+ is raised when `NATS::Client.status == +NATS::Client::Status::CLOSED`\\\nUsually due to the socket being closed.","summary":"

          +ClientClosed+ is raised when NATS::Client.status == +NATS::Client::Status::CLOSED\\ Usually due to the socket being closed.

          ","constructors":[{"html_id":"new(msg=\"Clientisclosed\")-class-method","name":"new","abstract":false,"args":[{"name":"msg","default_value":"\"Client is closed\"","external_name":"msg","restriction":""}],"args_string":"(msg = \"Client is closed\")","args_html":"(msg = "Client is closed")","location":{"filename":"src/nats/errors.cr","line_number":23,"url":null},"def":{"name":"new","args":[{"name":"msg","default_value":"\"Client is closed\"","external_name":"msg","restriction":""}],"visibility":"Public","body":"_ = allocate\n_.initialize(msg)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}]},{"html_id":"nats/NATS/ERRError","path":"NATS/ERRError.html","kind":"class","full_name":"NATS::ERRError","name":"ERRError","abstract":false,"superclass":{"html_id":"nats/NATS/Error","kind":"class","full_name":"NATS::Error","name":"Error"},"ancestors":[{"html_id":"nats/NATS/Error","kind":"class","full_name":"NATS::Error","name":"Error"},{"html_id":"nats/Exception","kind":"class","full_name":"Exception","name":"Exception"},{"html_id":"nats/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/errors.cr","line_number":36,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"subclasses":[{"html_id":"nats/NATS/AuthenticationError","kind":"class","full_name":"NATS::AuthenticationError","name":"AuthenticationError"}],"namespace":{"html_id":"nats/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"+-ERR+ is raised when the NATS server indicates a protocol error.","summary":"

          +-ERR+ is raised when the NATS server indicates a protocol error.

          ","constructors":[{"html_id":"new(msg=\"Unknownerror\")-class-method","name":"new","abstract":false,"args":[{"name":"msg","default_value":"\"Unknown error\"","external_name":"msg","restriction":""}],"args_string":"(msg = \"Unknown error\")","args_html":"(msg = "Unknown error")","location":{"filename":"src/nats/errors.cr","line_number":37,"url":null},"def":{"name":"new","args":[{"name":"msg","default_value":"\"Unknown error\"","external_name":"msg","restriction":""}],"visibility":"Public","body":"_ = allocate\n_.initialize(msg)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}]},{"html_id":"nats/NATS/Error","path":"NATS/Error.html","kind":"class","full_name":"NATS::Error","name":"Error","abstract":false,"superclass":{"html_id":"nats/Exception","kind":"class","full_name":"Exception","name":"Exception"},"ancestors":[{"html_id":"nats/Exception","kind":"class","full_name":"Exception","name":"Exception"},{"html_id":"nats/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/errors.cr","line_number":17,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"subclasses":[{"html_id":"nats/NATS/ClientClosedError","kind":"class","full_name":"NATS::ClientClosedError","name":"ClientClosedError"},{"html_id":"nats/NATS/ERRError","kind":"class","full_name":"NATS::ERRError","name":"ERRError"},{"html_id":"nats/NATS/MSGError","kind":"class","full_name":"NATS::MSGError","name":"MSGError"},{"html_id":"nats/NATS/TimeoutError","kind":"class","full_name":"NATS::TimeoutError","name":"TimeoutError"}],"namespace":{"html_id":"nats/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"Generic NATS exception class.","summary":"

          Generic NATS exception class.

          "},{"html_id":"nats/NATS/Message","path":"NATS/Message.html","kind":"module","full_name":"NATS::Message","name":"Message","abstract":false,"locations":[{"filename":"src/nats/message/connect.cr","line_number":16,"url":null},{"filename":"src/nats/message/info.cr","line_number":16,"url":null},{"filename":"src/nats/message/msg.cr","line_number":18,"url":null},{"filename":"src/nats/message/pub.cr","line_number":16,"url":null},{"filename":"src/nats/message/sub.cr","line_number":16,"url":null},{"filename":"src/nats/message/unsub.cr","line_number":16,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"nats/NATS","kind":"module","full_name":"NATS","name":"NATS"},"types":[{"html_id":"nats/NATS/Message/CONNECT","path":"NATS/Message/CONNECT.html","kind":"struct","full_name":"NATS::Message::CONNECT","name":"CONNECT","abstract":false,"superclass":{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"nats/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"nats/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/message/connect.cr","line_number":24,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"nats/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"}],"namespace":{"html_id":"nats/NATS/Message","kind":"module","full_name":"NATS::Message","name":"Message"},"doc":"The CONNECT message is the client version of the INFO message.\\\nOnce the client has established a TCP/IP socket connection with the NATS server,\n and an INFO message has been received from the server,\n the client may send a CONNECT message to the NATS server to provide more\n information about the current connection as well as security information.\n\nSEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#connect","summary":"

          The CONNECT message is the client version of the INFO message.\\ Once the client has established a TCP/IP socket connection with the NATS server, and an INFO message has been received from the server, the client may send a CONNECT message to the NATS server to provide more information about the current connection as well as security information.

          ","constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/nats/message/connect.cr","line_number":69,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"},"external_var":false},{"html_id":"new-class-method","name":"new","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":66,"url":null},"def":{"name":"new","visibility":"Public","body":"_ = allocate\n_.initialize\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}],"instance_methods":[{"html_id":"auth_token:String|Nil-instance-method","name":"auth_token","doc":"Client authorization token.","summary":"

          Client authorization token.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":32,"url":null},"def":{"name":"auth_token","return_type":"String | ::Nil","visibility":"Public","body":"@auth_token"},"external_var":false},{"html_id":"auth_token=(auth_token:String|Nil)-instance-method","name":"auth_token=","doc":"Client authorization token.","summary":"

          Client authorization token.

          ","abstract":false,"args":[{"name":"auth_token","external_name":"auth_token","restriction":"String | ::Nil"}],"args_string":"(auth_token : String | Nil)","args_html":"(auth_token : String | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":32,"url":null},"def":{"name":"auth_token=","args":[{"name":"auth_token","external_name":"auth_token","restriction":"String | ::Nil"}],"visibility":"Public","body":"@auth_token = auth_token"},"external_var":false},{"html_id":"echo:Bool|Nil-instance-method","name":"echo","doc":"If set to false, the server (version 1.2.0+) will not send originating messages from this connection to its own subscriptions.\nClients should set this to false only for server supporting this feature,\n which is when proto in the INFO protocol is set to at least `1`.","summary":"

          If set to false, the server (version 1.2.0+) will not send originating messages from this connection to its own subscriptions.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":51,"url":null},"def":{"name":"echo","return_type":"Bool | ::Nil","visibility":"Public","body":"@echo"},"external_var":false},{"html_id":"echo=(echo:Bool|Nil)-instance-method","name":"echo=","doc":"If set to false, the server (version 1.2.0+) will not send originating messages from this connection to its own subscriptions.\nClients should set this to false only for server supporting this feature,\n which is when proto in the INFO protocol is set to at least `1`.","summary":"

          If set to false, the server (version 1.2.0+) will not send originating messages from this connection to its own subscriptions.

          ","abstract":false,"args":[{"name":"echo","external_name":"echo","restriction":"Bool | ::Nil"}],"args_string":"(echo : Bool | Nil)","args_html":"(echo : Bool | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":51,"url":null},"def":{"name":"echo=","args":[{"name":"echo","external_name":"echo","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@echo = echo"},"external_var":false},{"html_id":"headers:Bool|Nil-instance-method","name":"headers","doc":"Whether the client supports headers.\nTODO: Implement headers support","summary":"

          Whether the client supports headers.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":61,"url":null},"def":{"name":"headers","return_type":"Bool | ::Nil","visibility":"Public","body":"@headers"},"external_var":false},{"html_id":"headers=(headers:Bool|Nil)-instance-method","name":"headers=","doc":"Whether the client supports headers.\nTODO: Implement headers support","summary":"

          Whether the client supports headers.

          ","abstract":false,"args":[{"name":"headers","external_name":"headers","restriction":"Bool | ::Nil"}],"args_string":"(headers : Bool | Nil)","args_html":"(headers : Bool | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":61,"url":null},"def":{"name":"headers=","args":[{"name":"headers","external_name":"headers","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@headers = headers"},"external_var":false},{"html_id":"jwt:String|Nil-instance-method","name":"jwt","doc":"The JWT that identifies a user permissions and account.","summary":"

          The JWT that identifies a user permissions and account.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":56,"url":null},"def":{"name":"jwt","return_type":"String | ::Nil","visibility":"Public","body":"@jwt"},"external_var":false},{"html_id":"jwt=(jwt:String|Nil)-instance-method","name":"jwt=","doc":"The JWT that identifies a user permissions and account.","summary":"

          The JWT that identifies a user permissions and account.

          ","abstract":false,"args":[{"name":"jwt","external_name":"jwt","restriction":"String | ::Nil"}],"args_string":"(jwt : String | Nil)","args_html":"(jwt : String | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":56,"url":null},"def":{"name":"jwt=","args":[{"name":"jwt","external_name":"jwt","restriction":"String | ::Nil"}],"visibility":"Public","body":"@jwt = jwt"},"external_var":false},{"html_id":"lang:String|Nil-instance-method","name":"lang","doc":"The implementation language of the client.","summary":"

          The implementation language of the client.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":40,"url":null},"def":{"name":"lang","return_type":"String | ::Nil","visibility":"Public","body":"@lang"},"external_var":false},{"html_id":"lang=(lang:String|Nil)-instance-method","name":"lang=","doc":"The implementation language of the client.","summary":"

          The implementation language of the client.

          ","abstract":false,"args":[{"name":"lang","external_name":"lang","restriction":"String | ::Nil"}],"args_string":"(lang : String | Nil)","args_html":"(lang : String | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":40,"url":null},"def":{"name":"lang=","args":[{"name":"lang","external_name":"lang","restriction":"String | ::Nil"}],"visibility":"Public","body":"@lang = lang"},"external_var":false},{"html_id":"name:String|Nil-instance-method","name":"name","doc":"Client name.","summary":"

          Client name.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":38,"url":null},"def":{"name":"name","return_type":"String | ::Nil","visibility":"Public","body":"@name"},"external_var":false},{"html_id":"name=(name:String|Nil)-instance-method","name":"name=","doc":"Client name.","summary":"

          Client name.

          ","abstract":false,"args":[{"name":"name","external_name":"name","restriction":"String | ::Nil"}],"args_string":"(name : String | Nil)","args_html":"(name : String | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":38,"url":null},"def":{"name":"name=","args":[{"name":"name","external_name":"name","restriction":"String | ::Nil"}],"visibility":"Public","body":"@name = name"},"external_var":false},{"html_id":"nkey:String|Nil-instance-method","name":"nkey","doc":"The public NKey to authenticate the client.\nThis will be used to verify the signature (sig) against the nonce provided in the INFO message.","summary":"

          The public NKey to authenticate the client.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":64,"url":null},"def":{"name":"nkey","return_type":"String | ::Nil","visibility":"Public","body":"@nkey"},"external_var":false},{"html_id":"nkey=(nkey:String|Nil)-instance-method","name":"nkey=","doc":"The public NKey to authenticate the client.\nThis will be used to verify the signature (sig) against the nonce provided in the INFO message.","summary":"

          The public NKey to authenticate the client.

          ","abstract":false,"args":[{"name":"nkey","external_name":"nkey","restriction":"String | ::Nil"}],"args_string":"(nkey : String | Nil)","args_html":"(nkey : String | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":64,"url":null},"def":{"name":"nkey=","args":[{"name":"nkey","external_name":"nkey","restriction":"String | ::Nil"}],"visibility":"Public","body":"@nkey = nkey"},"external_var":false},{"html_id":"no_responders:Bool|Nil-instance-method","name":"no_responders","doc":"Enable quick replies for cases where a request is sent to a topic with no responders.","summary":"

          Enable quick replies for cases where a request is sent to a topic with no responders.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":58,"url":null},"def":{"name":"no_responders","return_type":"Bool | ::Nil","visibility":"Public","body":"@no_responders"},"external_var":false},{"html_id":"no_responders=(no_responders:Bool|Nil)-instance-method","name":"no_responders=","doc":"Enable quick replies for cases where a request is sent to a topic with no responders.","summary":"

          Enable quick replies for cases where a request is sent to a topic with no responders.

          ","abstract":false,"args":[{"name":"no_responders","external_name":"no_responders","restriction":"Bool | ::Nil"}],"args_string":"(no_responders : Bool | Nil)","args_html":"(no_responders : Bool | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":58,"url":null},"def":{"name":"no_responders=","args":[{"name":"no_responders","external_name":"no_responders","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@no_responders = no_responders"},"external_var":false},{"html_id":"pass:String|Nil-instance-method","name":"pass","doc":"Connection password.","summary":"

          Connection password.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":36,"url":null},"def":{"name":"pass","return_type":"String | ::Nil","visibility":"Public","body":"@pass"},"external_var":false},{"html_id":"pass=(pass:String|Nil)-instance-method","name":"pass=","doc":"Connection password.","summary":"

          Connection password.

          ","abstract":false,"args":[{"name":"pass","external_name":"pass","restriction":"String | ::Nil"}],"args_string":"(pass : String | Nil)","args_html":"(pass : String | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":36,"url":null},"def":{"name":"pass=","args":[{"name":"pass","external_name":"pass","restriction":"String | ::Nil"}],"visibility":"Public","body":"@pass = pass"},"external_var":false},{"html_id":"pedantic:Bool|Nil-instance-method","name":"pedantic","doc":"Turns on additional strict format checking, e.g. for properly formed subjects.","summary":"

          Turns on additional strict format checking, e.g.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":28,"url":null},"def":{"name":"pedantic","return_type":"Bool | ::Nil","visibility":"Public","body":"@pedantic"},"external_var":false},{"html_id":"pedantic=(pedantic:Bool|Nil)-instance-method","name":"pedantic=","doc":"Turns on additional strict format checking, e.g. for properly formed subjects.","summary":"

          Turns on additional strict format checking, e.g.

          ","abstract":false,"args":[{"name":"pedantic","external_name":"pedantic","restriction":"Bool | ::Nil"}],"args_string":"(pedantic : Bool | Nil)","args_html":"(pedantic : Bool | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":28,"url":null},"def":{"name":"pedantic=","args":[{"name":"pedantic","external_name":"pedantic","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@pedantic = pedantic"},"external_var":false},{"html_id":"protocol:Int32|Nil-instance-method","name":"protocol","doc":"Sending `0` (or absent) indicates client supports original protocol.\nSending `1` indicates that the client supports dynamic reconfiguration\n of cluster topology changes by asynchronously receiving INFO messages with known servers it can reconnect to.\nTODO: Support dynamic reconfiguration in the future","summary":"

          Sending 0 (or absent) indicates client supports original protocol.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":47,"url":null},"def":{"name":"protocol","return_type":"Int32 | ::Nil","visibility":"Public","body":"@protocol"},"external_var":false},{"html_id":"protocol=(protocol:Int32|Nil)-instance-method","name":"protocol=","doc":"Sending `0` (or absent) indicates client supports original protocol.\nSending `1` indicates that the client supports dynamic reconfiguration\n of cluster topology changes by asynchronously receiving INFO messages with known servers it can reconnect to.\nTODO: Support dynamic reconfiguration in the future","summary":"

          Sending 0 (or absent) indicates client supports original protocol.

          ","abstract":false,"args":[{"name":"protocol","external_name":"protocol","restriction":"Int32 | ::Nil"}],"args_string":"(protocol : Int32 | Nil)","args_html":"(protocol : Int32 | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":47,"url":null},"def":{"name":"protocol=","args":[{"name":"protocol","external_name":"protocol","restriction":"Int32 | ::Nil"}],"visibility":"Public","body":"@protocol = protocol"},"external_var":false},{"html_id":"sig:String|Nil-instance-method","name":"sig","doc":"In case the server has responded with a nonce on INFO,\n then a NATS client must use this field to reply with the signed nonce.","summary":"

          In case the server has responded with a nonce on INFO, then a NATS client must use this field to reply with the signed nonce.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":54,"url":null},"def":{"name":"sig","return_type":"String | ::Nil","visibility":"Public","body":"@sig"},"external_var":false},{"html_id":"sig=(sig:String|Nil)-instance-method","name":"sig=","doc":"In case the server has responded with a nonce on INFO,\n then a NATS client must use this field to reply with the signed nonce.","summary":"

          In case the server has responded with a nonce on INFO, then a NATS client must use this field to reply with the signed nonce.

          ","abstract":false,"args":[{"name":"sig","external_name":"sig","restriction":"String | ::Nil"}],"args_string":"(sig : String | Nil)","args_html":"(sig : String | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":54,"url":null},"def":{"name":"sig=","args":[{"name":"sig","external_name":"sig","restriction":"String | ::Nil"}],"visibility":"Public","body":"@sig = sig"},"external_var":false},{"html_id":"tls_required:Bool|Nil-instance-method","name":"tls_required","doc":"Indicates whether the client requires an SSL connection.","summary":"

          Indicates whether the client requires an SSL connection.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":30,"url":null},"def":{"name":"tls_required","return_type":"Bool | ::Nil","visibility":"Public","body":"@tls_required"},"external_var":false},{"html_id":"tls_required=(tls_required:Bool|Nil)-instance-method","name":"tls_required=","doc":"Indicates whether the client requires an SSL connection.","summary":"

          Indicates whether the client requires an SSL connection.

          ","abstract":false,"args":[{"name":"tls_required","external_name":"tls_required","restriction":"Bool | ::Nil"}],"args_string":"(tls_required : Bool | Nil)","args_html":"(tls_required : Bool | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":30,"url":null},"def":{"name":"tls_required=","args":[{"name":"tls_required","external_name":"tls_required","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@tls_required = tls_required"},"external_var":false},{"html_id":"to_s-instance-method","name":"to_s","doc":"Returns a nicely readable and concise string representation of this object,\ntypically intended for users.\n\nThis method should usually **not** be overridden. It delegates to\n`#to_s(IO)` which can be overridden for custom implementations.\n\nAlso see `#inspect`.","summary":"

          Returns a nicely readable and concise string representation of this object, typically intended for users.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":71,"url":null},"def":{"name":"to_s","visibility":"Public","body":"\"CONNECT #{to_json}\""},"external_var":false},{"html_id":"user:String|Nil-instance-method","name":"user","doc":"Connection username.","summary":"

          Connection username.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":34,"url":null},"def":{"name":"user","return_type":"String | ::Nil","visibility":"Public","body":"@user"},"external_var":false},{"html_id":"user=(user:String|Nil)-instance-method","name":"user=","doc":"Connection username.","summary":"

          Connection username.

          ","abstract":false,"args":[{"name":"user","external_name":"user","restriction":"String | ::Nil"}],"args_string":"(user : String | Nil)","args_html":"(user : String | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":34,"url":null},"def":{"name":"user=","args":[{"name":"user","external_name":"user","restriction":"String | ::Nil"}],"visibility":"Public","body":"@user = user"},"external_var":false},{"html_id":"verbose:Bool|Nil-instance-method","name":"verbose","doc":"Turns on +OK protocol acknowledgements.","summary":"

          Turns on +OK protocol acknowledgements.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":26,"url":null},"def":{"name":"verbose","return_type":"Bool | ::Nil","visibility":"Public","body":"@verbose"},"external_var":false},{"html_id":"verbose=(verbose:Bool|Nil)-instance-method","name":"verbose=","doc":"Turns on +OK protocol acknowledgements.","summary":"

          Turns on +OK protocol acknowledgements.

          ","abstract":false,"args":[{"name":"verbose","external_name":"verbose","restriction":"Bool | ::Nil"}],"args_string":"(verbose : Bool | Nil)","args_html":"(verbose : Bool | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":26,"url":null},"def":{"name":"verbose=","args":[{"name":"verbose","external_name":"verbose","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@verbose = verbose"},"external_var":false},{"html_id":"version:String|Nil-instance-method","name":"version","doc":"The version of the client.","summary":"

          The version of the client.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":42,"url":null},"def":{"name":"version","return_type":"String | ::Nil","visibility":"Public","body":"@version"},"external_var":false},{"html_id":"version=(version:String|Nil)-instance-method","name":"version=","doc":"The version of the client.","summary":"

          The version of the client.

          ","abstract":false,"args":[{"name":"version","external_name":"version","restriction":"String | ::Nil"}],"args_string":"(version : String | Nil)","args_html":"(version : String | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":42,"url":null},"def":{"name":"version=","args":[{"name":"version","external_name":"version","restriction":"String | ::Nil"}],"visibility":"Public","body":"@version = version"},"external_var":false}]},{"html_id":"nats/NATS/Message/INFO","path":"NATS/Message/INFO.html","kind":"struct","full_name":"NATS::Message::INFO","name":"INFO","abstract":false,"superclass":{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"nats/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"nats/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/message/info.cr","line_number":27,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"nats/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"}],"namespace":{"html_id":"nats/NATS/Message","kind":"module","full_name":"NATS::Message","name":"Message"},"doc":"A client will need to start as a plain TCP connection,\n then when the server accepts a connection from the client,\n it will send information about itself,\n the configuration and security requirements necessary for the client to successfully authenticate with the server and exchange messages.\n\nWhen using the updated client protocol (see `CONNECT`),\n INFO messages can be sent anytime by the server.\n This means clients with that protocol level need to be able to asynchronously handle INFO messages.\n\nSEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#info","summary":"

          A client will need to start as a plain TCP connection, then when the server accepts a connection from the client, it will send information about itself, the configuration and security requirements necessary for the client to successfully authenticate with the server and exchange messages.

          ","constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/nats/message/info.cr","line_number":28,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"},"external_var":false}],"instance_methods":[{"html_id":"auth_required:Bool|Nil-instance-method","name":"auth_required","doc":"If this is true, then the client should try to authenticate upon connect.","summary":"

          If this is true, then the client should try to authenticate upon connect.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":53,"url":null},"def":{"name":"auth_required","return_type":"Bool | ::Nil","visibility":"Public","body":"@auth_required"},"external_var":false},{"html_id":"auth_required=(auth_required:Bool|Nil)-instance-method","name":"auth_required=","doc":"If this is true, then the client should try to authenticate upon connect.","summary":"

          If this is true, then the client should try to authenticate upon connect.

          ","abstract":false,"args":[{"name":"auth_required","external_name":"auth_required","restriction":"Bool | ::Nil"}],"args_string":"(auth_required : Bool | Nil)","args_html":"(auth_required : Bool | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":53,"url":null},"def":{"name":"auth_required=","args":[{"name":"auth_required","external_name":"auth_required","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@auth_required = auth_required"},"external_var":false},{"html_id":"client_id:UInt64|Nil-instance-method","name":"client_id","doc":"The internal client identifier in the server.\nThis can be used to filter client connections in monitoring, correlate with error logs, etc...","summary":"

          The internal client identifier in the server.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":51,"url":null},"def":{"name":"client_id","return_type":"UInt64 | ::Nil","visibility":"Public","body":"@client_id"},"external_var":false},{"html_id":"client_id=(client_id:UInt64|Nil)-instance-method","name":"client_id=","doc":"The internal client identifier in the server.\nThis can be used to filter client connections in monitoring, correlate with error logs, etc...","summary":"

          The internal client identifier in the server.

          ","abstract":false,"args":[{"name":"client_id","external_name":"client_id","restriction":"UInt64 | ::Nil"}],"args_string":"(client_id : UInt64 | Nil)","args_html":"(client_id : UInt64 | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":51,"url":null},"def":{"name":"client_id=","args":[{"name":"client_id","external_name":"client_id","restriction":"UInt64 | ::Nil"}],"visibility":"Public","body":"@client_id = client_id"},"external_var":false},{"html_id":"client_ip:String|Nil-instance-method","name":"client_ip","doc":"The IP of the client.","summary":"

          The IP of the client.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":74,"url":null},"def":{"name":"client_ip","return_type":"String | ::Nil","visibility":"Public","body":"@client_ip"},"external_var":false},{"html_id":"client_ip=(client_ip:String|Nil)-instance-method","name":"client_ip=","doc":"The IP of the client.","summary":"

          The IP of the client.

          ","abstract":false,"args":[{"name":"client_ip","external_name":"client_ip","restriction":"String | ::Nil"}],"args_string":"(client_ip : String | Nil)","args_html":"(client_ip : String | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":74,"url":null},"def":{"name":"client_ip=","args":[{"name":"client_ip","external_name":"client_ip","restriction":"String | ::Nil"}],"visibility":"Public","body":"@client_ip = client_ip"},"external_var":false},{"html_id":"cluster:String|Nil-instance-method","name":"cluster","doc":"The name of the cluster.","summary":"

          The name of the cluster.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":78,"url":null},"def":{"name":"cluster","return_type":"String | ::Nil","visibility":"Public","body":"@cluster"},"external_var":false},{"html_id":"cluster=(cluster:String|Nil)-instance-method","name":"cluster=","doc":"The name of the cluster.","summary":"

          The name of the cluster.

          ","abstract":false,"args":[{"name":"cluster","external_name":"cluster","restriction":"String | ::Nil"}],"args_string":"(cluster : String | Nil)","args_html":"(cluster : String | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":78,"url":null},"def":{"name":"cluster=","args":[{"name":"cluster","external_name":"cluster","restriction":"String | ::Nil"}],"visibility":"Public","body":"@cluster = cluster"},"external_var":false},{"html_id":"connect_urls:Array(String)|Nil-instance-method","name":"connect_urls","doc":"List of server urls that a client can connect to.","summary":"

          List of server urls that a client can connect to.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":62,"url":null},"def":{"name":"connect_urls","return_type":"Array(String) | ::Nil","visibility":"Public","body":"@connect_urls"},"external_var":false},{"html_id":"connect_urls=(connect_urls:Array(String)|Nil)-instance-method","name":"connect_urls=","doc":"List of server urls that a client can connect to.","summary":"

          List of server urls that a client can connect to.

          ","abstract":false,"args":[{"name":"connect_urls","external_name":"connect_urls","restriction":"Array(String) | ::Nil"}],"args_string":"(connect_urls : Array(String) | Nil)","args_html":"(connect_urls : Array(String) | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":62,"url":null},"def":{"name":"connect_urls=","args":[{"name":"connect_urls","external_name":"connect_urls","restriction":"Array(String) | ::Nil"}],"visibility":"Public","body":"@connect_urls = connect_urls"},"external_var":false},{"html_id":"domain:String|Nil-instance-method","name":"domain","doc":"The configured NATS domain of the server.","summary":"

          The configured NATS domain of the server.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":80,"url":null},"def":{"name":"domain","return_type":"String | ::Nil","visibility":"Public","body":"@domain"},"external_var":false},{"html_id":"domain=(domain:String|Nil)-instance-method","name":"domain=","doc":"The configured NATS domain of the server.","summary":"

          The configured NATS domain of the server.

          ","abstract":false,"args":[{"name":"domain","external_name":"domain","restriction":"String | ::Nil"}],"args_string":"(domain : String | Nil)","args_html":"(domain : String | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":80,"url":null},"def":{"name":"domain=","args":[{"name":"domain","external_name":"domain","restriction":"String | ::Nil"}],"visibility":"Public","body":"@domain = domain"},"external_var":false},{"html_id":"git_commit:String|Nil-instance-method","name":"git_commit","doc":"The git hash at which the NATS server was built.","summary":"

          The git hash at which the NATS server was built.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":68,"url":null},"def":{"name":"git_commit","return_type":"String | ::Nil","visibility":"Public","body":"@git_commit"},"external_var":false},{"html_id":"git_commit=(git_commit:String|Nil)-instance-method","name":"git_commit=","doc":"The git hash at which the NATS server was built.","summary":"

          The git hash at which the NATS server was built.

          ","abstract":false,"args":[{"name":"git_commit","external_name":"git_commit","restriction":"String | ::Nil"}],"args_string":"(git_commit : String | Nil)","args_html":"(git_commit : String | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":68,"url":null},"def":{"name":"git_commit=","args":[{"name":"git_commit","external_name":"git_commit","restriction":"String | ::Nil"}],"visibility":"Public","body":"@git_commit = git_commit"},"external_var":false},{"html_id":"go:String-instance-method","name":"go","doc":"The version of golang the NATS server was built with.","summary":"

          The version of golang the NATS server was built with.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":37,"url":null},"def":{"name":"go","return_type":"String","visibility":"Public","body":"@go"},"external_var":false},{"html_id":"go=(go:String)-instance-method","name":"go=","doc":"The version of golang the NATS server was built with.","summary":"

          The version of golang the NATS server was built with.

          ","abstract":false,"args":[{"name":"go","external_name":"go","restriction":"String"}],"args_string":"(go : String)","args_html":"(go : String)","location":{"filename":"src/nats/message/info.cr","line_number":37,"url":null},"def":{"name":"go=","args":[{"name":"go","external_name":"go","restriction":"String"}],"visibility":"Public","body":"@go = go"},"external_var":false},{"html_id":"headers:Bool-instance-method","name":"headers","doc":"Whether the server supports headers.","summary":"

          Whether the server supports headers.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":43,"url":null},"def":{"name":"headers","return_type":"Bool","visibility":"Public","body":"@headers"},"external_var":false},{"html_id":"headers=(headers:Bool)-instance-method","name":"headers=","doc":"Whether the server supports headers.","summary":"

          Whether the server supports headers.

          ","abstract":false,"args":[{"name":"headers","external_name":"headers","restriction":"Bool"}],"args_string":"(headers : Bool)","args_html":"(headers : Bool)","location":{"filename":"src/nats/message/info.cr","line_number":43,"url":null},"def":{"name":"headers=","args":[{"name":"headers","external_name":"headers","restriction":"Bool"}],"visibility":"Public","body":"@headers = headers"},"external_var":false},{"html_id":"host:String-instance-method","name":"host","doc":"The IP address used to start the NATS server, by default this will be 0.0.0.0 and can be configured with -client_advertise host:port.","summary":"

          The IP address used to start the NATS server, by default this will be 0.0.0.0 and can be configured with -client_advertise host:port.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":39,"url":null},"def":{"name":"host","return_type":"String","visibility":"Public","body":"@host"},"external_var":false},{"html_id":"host=(host:String)-instance-method","name":"host=","doc":"The IP address used to start the NATS server, by default this will be 0.0.0.0 and can be configured with -client_advertise host:port.","summary":"

          The IP address used to start the NATS server, by default this will be 0.0.0.0 and can be configured with -client_advertise host:port.

          ","abstract":false,"args":[{"name":"host","external_name":"host","restriction":"String"}],"args_string":"(host : String)","args_html":"(host : String)","location":{"filename":"src/nats/message/info.cr","line_number":39,"url":null},"def":{"name":"host=","args":[{"name":"host","external_name":"host","restriction":"String"}],"visibility":"Public","body":"@host = host"},"external_var":false},{"html_id":"ip:String|Nil-instance-method","name":"ip","doc":"The IP of the server.","summary":"

          The IP of the server.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":72,"url":null},"def":{"name":"ip","return_type":"String | ::Nil","visibility":"Public","body":"@ip"},"external_var":false},{"html_id":"ip=(ip:String|Nil)-instance-method","name":"ip=","doc":"The IP of the server.","summary":"

          The IP of the server.

          ","abstract":false,"args":[{"name":"ip","external_name":"ip","restriction":"String | ::Nil"}],"args_string":"(ip : String | Nil)","args_html":"(ip : String | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":72,"url":null},"def":{"name":"ip=","args":[{"name":"ip","external_name":"ip","restriction":"String | ::Nil"}],"visibility":"Public","body":"@ip = ip"},"external_var":false},{"html_id":"jetstream:Bool|Nil-instance-method","name":"jetstream","doc":"Whether the server supports JetStream.","summary":"

          Whether the server supports JetStream.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":70,"url":null},"def":{"name":"jetstream","return_type":"Bool | ::Nil","visibility":"Public","body":"@jetstream"},"external_var":false},{"html_id":"jetstream=(jetstream:Bool|Nil)-instance-method","name":"jetstream=","doc":"Whether the server supports JetStream.","summary":"

          Whether the server supports JetStream.

          ","abstract":false,"args":[{"name":"jetstream","external_name":"jetstream","restriction":"Bool | ::Nil"}],"args_string":"(jetstream : Bool | Nil)","args_html":"(jetstream : Bool | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":70,"url":null},"def":{"name":"jetstream=","args":[{"name":"jetstream","external_name":"jetstream","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@jetstream = jetstream"},"external_var":false},{"html_id":"ldm:Bool|Nil-instance-method","name":"ldm","doc":"If the server supports Lame Duck Mode notifications, and the current server has transitioned to lame duck, ldm will be set to true.","summary":"

          If the server supports Lame Duck Mode notifications, and the current server has transitioned to lame duck, ldm will be set to true.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":66,"url":null},"def":{"name":"ldm","return_type":"Bool | ::Nil","visibility":"Public","body":"@ldm"},"external_var":false},{"html_id":"ldm=(ldm:Bool|Nil)-instance-method","name":"ldm=","doc":"If the server supports Lame Duck Mode notifications, and the current server has transitioned to lame duck, ldm will be set to true.","summary":"

          If the server supports Lame Duck Mode notifications, and the current server has transitioned to lame duck, ldm will be set to true.

          ","abstract":false,"args":[{"name":"ldm","external_name":"ldm","restriction":"Bool | ::Nil"}],"args_string":"(ldm : Bool | Nil)","args_html":"(ldm : Bool | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":66,"url":null},"def":{"name":"ldm=","args":[{"name":"ldm","external_name":"ldm","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@ldm = ldm"},"external_var":false},{"html_id":"max_payload:Int32-instance-method","name":"max_payload","doc":"Maximum payload size, in bytes, that the server will accept from the client.","summary":"

          Maximum payload size, in bytes, that the server will accept from the client.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":45,"url":null},"def":{"name":"max_payload","return_type":"Int32","visibility":"Public","body":"@max_payload"},"external_var":false},{"html_id":"max_payload=(max_payload:Int32)-instance-method","name":"max_payload=","doc":"Maximum payload size, in bytes, that the server will accept from the client.","summary":"

          Maximum payload size, in bytes, that the server will accept from the client.

          ","abstract":false,"args":[{"name":"max_payload","external_name":"max_payload","restriction":"Int32"}],"args_string":"(max_payload : Int32)","args_html":"(max_payload : Int32)","location":{"filename":"src/nats/message/info.cr","line_number":45,"url":null},"def":{"name":"max_payload=","args":[{"name":"max_payload","external_name":"max_payload","restriction":"Int32"}],"visibility":"Public","body":"@max_payload = max_payload"},"external_var":false},{"html_id":"nonce:String|Nil-instance-method","name":"nonce","doc":"The nonce for use in CONNECT.","summary":"

          The nonce for use in CONNECT.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":76,"url":null},"def":{"name":"nonce","return_type":"String | ::Nil","visibility":"Public","body":"@nonce"},"external_var":false},{"html_id":"nonce=(nonce:String|Nil)-instance-method","name":"nonce=","doc":"The nonce for use in CONNECT.","summary":"

          The nonce for use in CONNECT.

          ","abstract":false,"args":[{"name":"nonce","external_name":"nonce","restriction":"String | ::Nil"}],"args_string":"(nonce : String | Nil)","args_html":"(nonce : String | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":76,"url":null},"def":{"name":"nonce=","args":[{"name":"nonce","external_name":"nonce","restriction":"String | ::Nil"}],"visibility":"Public","body":"@nonce = nonce"},"external_var":false},{"html_id":"port:Int32-instance-method","name":"port","doc":"The port number the NATS server is configured to listen on.","summary":"

          The port number the NATS server is configured to listen on.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":41,"url":null},"def":{"name":"port","return_type":"Int32","visibility":"Public","body":"@port"},"external_var":false},{"html_id":"port=(port:Int32)-instance-method","name":"port=","doc":"The port number the NATS server is configured to listen on.","summary":"

          The port number the NATS server is configured to listen on.

          ","abstract":false,"args":[{"name":"port","external_name":"port","restriction":"Int32"}],"args_string":"(port : Int32)","args_html":"(port : Int32)","location":{"filename":"src/nats/message/info.cr","line_number":41,"url":null},"def":{"name":"port=","args":[{"name":"port","external_name":"port","restriction":"Int32"}],"visibility":"Public","body":"@port = port"},"external_var":false},{"html_id":"proto:Int32-instance-method","name":"proto","doc":"An integer indicating the protocol version of the server.\nThe server version 1.2.0 sets this to `1` to indicate that it supports the \"Echo\" feature.","summary":"

          An integer indicating the protocol version of the server.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":48,"url":null},"def":{"name":"proto","return_type":"Int32","visibility":"Public","body":"@proto"},"external_var":false},{"html_id":"proto=(proto:Int32)-instance-method","name":"proto=","doc":"An integer indicating the protocol version of the server.\nThe server version 1.2.0 sets this to `1` to indicate that it supports the \"Echo\" feature.","summary":"

          An integer indicating the protocol version of the server.

          ","abstract":false,"args":[{"name":"proto","external_name":"proto","restriction":"Int32"}],"args_string":"(proto : Int32)","args_html":"(proto : Int32)","location":{"filename":"src/nats/message/info.cr","line_number":48,"url":null},"def":{"name":"proto=","args":[{"name":"proto","external_name":"proto","restriction":"Int32"}],"visibility":"Public","body":"@proto = proto"},"external_var":false},{"html_id":"server_id:String-instance-method","name":"server_id","doc":"The unique identifier of the NATS server.","summary":"

          The unique identifier of the NATS server.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":31,"url":null},"def":{"name":"server_id","return_type":"String","visibility":"Public","body":"@server_id"},"external_var":false},{"html_id":"server_id=(server_id:String)-instance-method","name":"server_id=","doc":"The unique identifier of the NATS server.","summary":"

          The unique identifier of the NATS server.

          ","abstract":false,"args":[{"name":"server_id","external_name":"server_id","restriction":"String"}],"args_string":"(server_id : String)","args_html":"(server_id : String)","location":{"filename":"src/nats/message/info.cr","line_number":31,"url":null},"def":{"name":"server_id=","args":[{"name":"server_id","external_name":"server_id","restriction":"String"}],"visibility":"Public","body":"@server_id = server_id"},"external_var":false},{"html_id":"server_name:String-instance-method","name":"server_name","doc":"The name of the NATS server.","summary":"

          The name of the NATS server.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":33,"url":null},"def":{"name":"server_name","return_type":"String","visibility":"Public","body":"@server_name"},"external_var":false},{"html_id":"server_name=(server_name:String)-instance-method","name":"server_name=","doc":"The name of the NATS server.","summary":"

          The name of the NATS server.

          ","abstract":false,"args":[{"name":"server_name","external_name":"server_name","restriction":"String"}],"args_string":"(server_name : String)","args_html":"(server_name : String)","location":{"filename":"src/nats/message/info.cr","line_number":33,"url":null},"def":{"name":"server_name=","args":[{"name":"server_name","external_name":"server_name","restriction":"String"}],"visibility":"Public","body":"@server_name = server_name"},"external_var":false},{"html_id":"tls_available:Bool|Nil-instance-method","name":"tls_available","doc":"If this is true, the client can provide a valid certificate during the TLS handshake.","summary":"

          If this is true, the client can provide a valid certificate during the TLS handshake.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":60,"url":null},"def":{"name":"tls_available","return_type":"Bool | ::Nil","visibility":"Public","body":"@tls_available"},"external_var":false},{"html_id":"tls_available=(tls_available:Bool|Nil)-instance-method","name":"tls_available=","doc":"If this is true, the client can provide a valid certificate during the TLS handshake.","summary":"

          If this is true, the client can provide a valid certificate during the TLS handshake.

          ","abstract":false,"args":[{"name":"tls_available","external_name":"tls_available","restriction":"Bool | ::Nil"}],"args_string":"(tls_available : Bool | Nil)","args_html":"(tls_available : Bool | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":60,"url":null},"def":{"name":"tls_available=","args":[{"name":"tls_available","external_name":"tls_available","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@tls_available = tls_available"},"external_var":false},{"html_id":"tls_required:Bool|Nil-instance-method","name":"tls_required","doc":"If this is true, then the client must perform the TLS/1.2 handshake.\nNote, this used to be ssl_required and has been updated along with the protocol from SSL to TLS.","summary":"

          If this is true, then the client must perform the TLS/1.2 handshake.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":56,"url":null},"def":{"name":"tls_required","return_type":"Bool | ::Nil","visibility":"Public","body":"@tls_required"},"external_var":false},{"html_id":"tls_required=(tls_required:Bool|Nil)-instance-method","name":"tls_required=","doc":"If this is true, then the client must perform the TLS/1.2 handshake.\nNote, this used to be ssl_required and has been updated along with the protocol from SSL to TLS.","summary":"

          If this is true, then the client must perform the TLS/1.2 handshake.

          ","abstract":false,"args":[{"name":"tls_required","external_name":"tls_required","restriction":"Bool | ::Nil"}],"args_string":"(tls_required : Bool | Nil)","args_html":"(tls_required : Bool | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":56,"url":null},"def":{"name":"tls_required=","args":[{"name":"tls_required","external_name":"tls_required","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@tls_required = tls_required"},"external_var":false},{"html_id":"tls_verify:Bool|Nil-instance-method","name":"tls_verify","doc":"If this is true, the client must provide a valid certificate during the TLS handshake.","summary":"

          If this is true, the client must provide a valid certificate during the TLS handshake.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":58,"url":null},"def":{"name":"tls_verify","return_type":"Bool | ::Nil","visibility":"Public","body":"@tls_verify"},"external_var":false},{"html_id":"tls_verify=(tls_verify:Bool|Nil)-instance-method","name":"tls_verify=","doc":"If this is true, the client must provide a valid certificate during the TLS handshake.","summary":"

          If this is true, the client must provide a valid certificate during the TLS handshake.

          ","abstract":false,"args":[{"name":"tls_verify","external_name":"tls_verify","restriction":"Bool | ::Nil"}],"args_string":"(tls_verify : Bool | Nil)","args_html":"(tls_verify : Bool | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":58,"url":null},"def":{"name":"tls_verify=","args":[{"name":"tls_verify","external_name":"tls_verify","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@tls_verify = tls_verify"},"external_var":false},{"html_id":"version:String-instance-method","name":"version","doc":"The version of NATS.","summary":"

          The version of NATS.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":35,"url":null},"def":{"name":"version","return_type":"String","visibility":"Public","body":"@version"},"external_var":false},{"html_id":"version=(version:String)-instance-method","name":"version=","doc":"The version of NATS.","summary":"

          The version of NATS.

          ","abstract":false,"args":[{"name":"version","external_name":"version","restriction":"String"}],"args_string":"(version : String)","args_html":"(version : String)","location":{"filename":"src/nats/message/info.cr","line_number":35,"url":null},"def":{"name":"version=","args":[{"name":"version","external_name":"version","restriction":"String"}],"visibility":"Public","body":"@version = version"},"external_var":false},{"html_id":"ws_connect_urls:Array(String)|Nil-instance-method","name":"ws_connect_urls","doc":"List of server urls that a websocket client can connect to.","summary":"

          List of server urls that a websocket client can connect to.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":64,"url":null},"def":{"name":"ws_connect_urls","return_type":"Array(String) | ::Nil","visibility":"Public","body":"@ws_connect_urls"},"external_var":false},{"html_id":"ws_connect_urls=(ws_connect_urls:Array(String)|Nil)-instance-method","name":"ws_connect_urls=","doc":"List of server urls that a websocket client can connect to.","summary":"

          List of server urls that a websocket client can connect to.

          ","abstract":false,"args":[{"name":"ws_connect_urls","external_name":"ws_connect_urls","restriction":"Array(String) | ::Nil"}],"args_string":"(ws_connect_urls : Array(String) | Nil)","args_html":"(ws_connect_urls : Array(String) | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":64,"url":null},"def":{"name":"ws_connect_urls=","args":[{"name":"ws_connect_urls","external_name":"ws_connect_urls","restriction":"Array(String) | ::Nil"}],"visibility":"Public","body":"@ws_connect_urls = ws_connect_urls"},"external_var":false}]},{"html_id":"nats/NATS/Message/MSG","path":"NATS/Message/MSG.html","kind":"struct","full_name":"NATS::Message::MSG","name":"MSG","abstract":false,"superclass":{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"nats/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/message/msg.cr","line_number":22,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"nats/NATS/Message","kind":"module","full_name":"NATS::Message","name":"Message"},"doc":"The MSG protocol message is used to deliver an application message to the client.\n\nSEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#msg","summary":"

          The MSG protocol message is used to deliver an application message to the client.

          ","constructors":[{"html_id":"new(subject:String,sid:Int64,reply_to:String|Nil=nil,bytes:Int64=0,payload:String|Nil=nil,client:Client|Nil=nil)-class-method","name":"new","abstract":false,"args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"sid","external_name":"sid","restriction":"Int64"},{"name":"reply_to","default_value":"nil","external_name":"reply_to","restriction":"String | ::Nil"},{"name":"bytes","default_value":"0","external_name":"bytes","restriction":"Int64"},{"name":"payload","default_value":"nil","external_name":"payload","restriction":"String | ::Nil"},{"name":"client","default_value":"nil","external_name":"client","restriction":"Client | ::Nil"}],"args_string":"(subject : String, sid : Int64, reply_to : String | Nil = nil, bytes : Int64 = 0, payload : String | Nil = nil, client : Client | Nil = nil)","args_html":"(subject : String, sid : Int64, reply_to : String | Nil = nil, bytes : Int64 = 0, payload : String | Nil = nil, client : Client | Nil = nil)","location":{"filename":"src/nats/message/msg.cr","line_number":34,"url":null},"def":{"name":"new","args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"sid","external_name":"sid","restriction":"Int64"},{"name":"reply_to","default_value":"nil","external_name":"reply_to","restriction":"String | ::Nil"},{"name":"bytes","default_value":"0","external_name":"bytes","restriction":"Int64"},{"name":"payload","default_value":"nil","external_name":"payload","restriction":"String | ::Nil"},{"name":"client","default_value":"nil","external_name":"client","restriction":"Client | ::Nil"}],"visibility":"Public","body":"_ = allocate\n_.initialize(subject, sid, reply_to, bytes, payload, client)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}],"instance_methods":[{"html_id":"client:Client|Nil-instance-method","name":"client","doc":"NATS Client for sending replies.","summary":"

          NATS Client for sending replies.

          ","abstract":false,"location":{"filename":"src/nats/message/msg.cr","line_number":32,"url":null},"def":{"name":"client","return_type":"Client | ::Nil","visibility":"Public","body":"@client"},"external_var":false},{"html_id":"client=(client:Client|Nil)-instance-method","name":"client=","doc":"NATS Client for sending replies.","summary":"

          NATS Client for sending replies.

          ","abstract":false,"args":[{"name":"client","external_name":"client","restriction":"Client | ::Nil"}],"args_string":"(client : Client | Nil)","args_html":"(client : Client | Nil)","location":{"filename":"src/nats/message/msg.cr","line_number":32,"url":null},"def":{"name":"client=","args":[{"name":"client","external_name":"client","restriction":"Client | ::Nil"}],"visibility":"Public","body":"@client = client"},"external_var":false},{"html_id":"payload:String|Nil-instance-method","name":"payload","doc":"The message payload data.","summary":"

          The message payload data.

          ","abstract":false,"location":{"filename":"src/nats/message/msg.cr","line_number":30,"url":null},"def":{"name":"payload","return_type":"String | ::Nil","visibility":"Public","body":"@payload"},"external_var":false},{"html_id":"payload=(payload:String|Nil)-instance-method","name":"payload=","doc":"The message payload data.","summary":"

          The message payload data.

          ","abstract":false,"args":[{"name":"payload","external_name":"payload","restriction":"String | ::Nil"}],"args_string":"(payload : String | Nil)","args_html":"(payload : String | Nil)","location":{"filename":"src/nats/message/msg.cr","line_number":30,"url":null},"def":{"name":"payload=","args":[{"name":"payload","external_name":"payload","restriction":"String | ::Nil"}],"visibility":"Public","body":"@payload = payload"},"external_var":false},{"html_id":"reply(payload:String|Nil=nil)-instance-method","name":"reply","doc":"Reply to this message when the reply_to subject is set.\n\n*payload*: The payload to send in the reply.","summary":"

          Reply to this message when the reply_to subject is set.

          ","abstract":false,"args":[{"name":"payload","default_value":"nil","external_name":"payload","restriction":"String | ::Nil"}],"args_string":"(payload : String | Nil = nil)","args_html":"(payload : String | Nil = nil)","location":{"filename":"src/nats/message/msg.cr","line_number":54,"url":null},"def":{"name":"reply","args":[{"name":"payload","default_value":"nil","external_name":"payload","restriction":"String | ::Nil"}],"visibility":"Public","body":"if reply_to\n msg = PUB.new(subject: reply_to.to_s, payload: payload)\n\n @client.try(&.send_msg!(msg.to_s))\nelse\n raise(MSGError.new(\"reply_to is nil\"))\nend"},"external_var":false},{"html_id":"reply_to:String|Nil-instance-method","name":"reply_to","doc":"The subject on which the publisher is listening for responses.","summary":"

          The subject on which the publisher is listening for responses.

          ","abstract":false,"location":{"filename":"src/nats/message/msg.cr","line_number":28,"url":null},"def":{"name":"reply_to","return_type":"String | ::Nil","visibility":"Public","body":"@reply_to"},"external_var":false},{"html_id":"reply_to=(reply_to:String|Nil)-instance-method","name":"reply_to=","doc":"The subject on which the publisher is listening for responses.","summary":"

          The subject on which the publisher is listening for responses.

          ","abstract":false,"args":[{"name":"reply_to","external_name":"reply_to","restriction":"String | ::Nil"}],"args_string":"(reply_to : String | Nil)","args_html":"(reply_to : String | Nil)","location":{"filename":"src/nats/message/msg.cr","line_number":28,"url":null},"def":{"name":"reply_to=","args":[{"name":"reply_to","external_name":"reply_to","restriction":"String | ::Nil"}],"visibility":"Public","body":"@reply_to = reply_to"},"external_var":false},{"html_id":"sid:Int64-instance-method","name":"sid","doc":"The unique alphanumeric subscription ID of the subject.","summary":"

          The unique alphanumeric subscription ID of the subject.

          ","abstract":false,"location":{"filename":"src/nats/message/msg.cr","line_number":26,"url":null},"def":{"name":"sid","return_type":"Int64","visibility":"Public","body":"@sid"},"external_var":false},{"html_id":"sid=(sid:Int64)-instance-method","name":"sid=","doc":"The unique alphanumeric subscription ID of the subject.","summary":"

          The unique alphanumeric subscription ID of the subject.

          ","abstract":false,"args":[{"name":"sid","external_name":"sid","restriction":"Int64"}],"args_string":"(sid : Int64)","args_html":"(sid : Int64)","location":{"filename":"src/nats/message/msg.cr","line_number":26,"url":null},"def":{"name":"sid=","args":[{"name":"sid","external_name":"sid","restriction":"Int64"}],"visibility":"Public","body":"@sid = sid"},"external_var":false},{"html_id":"subject:String-instance-method","name":"subject","doc":"Subject name this message was received on.","summary":"

          Subject name this message was received on.

          ","abstract":false,"location":{"filename":"src/nats/message/msg.cr","line_number":24,"url":null},"def":{"name":"subject","return_type":"String","visibility":"Public","body":"@subject"},"external_var":false},{"html_id":"subject=(subject:String)-instance-method","name":"subject=","doc":"Subject name this message was received on.","summary":"

          Subject name this message was received on.

          ","abstract":false,"args":[{"name":"subject","external_name":"subject","restriction":"String"}],"args_string":"(subject : String)","args_html":"(subject : String)","location":{"filename":"src/nats/message/msg.cr","line_number":24,"url":null},"def":{"name":"subject=","args":[{"name":"subject","external_name":"subject","restriction":"String"}],"visibility":"Public","body":"@subject = subject"},"external_var":false},{"html_id":"to_s:String|Nil-instance-method","name":"to_s","doc":"Helper method to return the payload","summary":"

          Helper method to return the payload

          ","abstract":false,"location":{"filename":"src/nats/message/msg.cr","line_number":47,"url":null},"def":{"name":"to_s","return_type":"String | ::Nil","visibility":"Public","body":"payload"},"external_var":false}]},{"html_id":"nats/NATS/Message/PUB","path":"NATS/Message/PUB.html","kind":"struct","full_name":"NATS::Message::PUB","name":"PUB","abstract":false,"superclass":{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"nats/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/message/pub.cr","line_number":23,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"nats/NATS/Message","kind":"module","full_name":"NATS::Message","name":"Message"},"doc":"The PUB message publishes the message payload to the given subject name, optionally supplying a reply subject.\\\nIf a reply subject is supplied, it will be delivered to eligible subscribers along with the supplied payload.\n\nNOTE: that the payload itself is optional.\n\nSEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#pub","summary":"

          The PUB message publishes the message payload to the given subject name, optionally supplying a reply subject.\\ If a reply subject is supplied, it will be delivered to eligible subscribers along with the supplied payload.

          ","constructors":[{"html_id":"new(subject:String,reply_to:String|Nil=nil,payload:String|Nil=nil,callback:Message::MSG->Nil|Nil=nil)-class-method","name":"new","abstract":false,"args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"reply_to","default_value":"nil","external_name":"reply_to","restriction":"String | ::Nil"},{"name":"payload","default_value":"nil","external_name":"payload","restriction":"String | ::Nil"},{"name":"callback","default_value":"nil","external_name":"callback","restriction":"(Message::MSG -> Nil) | ::Nil"}],"args_string":"(subject : String, reply_to : String | Nil = nil, payload : String | Nil = nil, callback : Message::MSG -> Nil | Nil = nil)","args_html":"(subject : String, reply_to : String | Nil = nil, payload : String | Nil = nil, callback : Message::MSG -> Nil | Nil = nil)","location":{"filename":"src/nats/message/pub.cr","line_number":33,"url":null},"def":{"name":"new","args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"reply_to","default_value":"nil","external_name":"reply_to","restriction":"String | ::Nil"},{"name":"payload","default_value":"nil","external_name":"payload","restriction":"String | ::Nil"},{"name":"callback","default_value":"nil","external_name":"callback","restriction":"(Message::MSG -> Nil) | ::Nil"}],"visibility":"Public","body":"_ = allocate\n_.initialize(subject, reply_to, payload, callback)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}],"instance_methods":[{"html_id":"callback:Message::MSG->Nil|Nil-instance-method","name":"callback","doc":"The callback to be invoked when a message is received.","summary":"

          The callback to be invoked when a message is received.

          ","abstract":false,"location":{"filename":"src/nats/message/pub.cr","line_number":31,"url":null},"def":{"name":"callback","return_type":"(Message::MSG -> Nil) | ::Nil","visibility":"Public","body":"@callback"},"external_var":false},{"html_id":"callback=(callback:Message::MSG->Nil|Nil)-instance-method","name":"callback=","doc":"The callback to be invoked when a message is received.","summary":"

          The callback to be invoked when a message is received.

          ","abstract":false,"args":[{"name":"callback","external_name":"callback","restriction":"(Message::MSG -> Nil) | ::Nil"}],"args_string":"(callback : Message::MSG -> Nil | Nil)","args_html":"(callback : Message::MSG -> Nil | Nil)","location":{"filename":"src/nats/message/pub.cr","line_number":31,"url":null},"def":{"name":"callback=","args":[{"name":"callback","external_name":"callback","restriction":"(Message::MSG -> Nil) | ::Nil"}],"visibility":"Public","body":"@callback = callback"},"external_var":false},{"html_id":"payload:String|Nil-instance-method","name":"payload","doc":"The message payload data.","summary":"

          The message payload data.

          ","abstract":false,"location":{"filename":"src/nats/message/pub.cr","line_number":29,"url":null},"def":{"name":"payload","return_type":"String | ::Nil","visibility":"Public","body":"@payload"},"external_var":false},{"html_id":"payload=(payload:String|Nil)-instance-method","name":"payload=","doc":"The message payload data.","summary":"

          The message payload data.

          ","abstract":false,"args":[{"name":"payload","external_name":"payload","restriction":"String | ::Nil"}],"args_string":"(payload : String | Nil)","args_html":"(payload : String | Nil)","location":{"filename":"src/nats/message/pub.cr","line_number":29,"url":null},"def":{"name":"payload=","args":[{"name":"payload","external_name":"payload","restriction":"String | ::Nil"}],"visibility":"Public","body":"@payload = payload"},"external_var":false},{"html_id":"reply_to:String|Nil-instance-method","name":"reply_to","doc":"The reply subject that subscribers can use to send a response back to the publisher/requestor.","summary":"

          The reply subject that subscribers can use to send a response back to the publisher/requestor.

          ","abstract":false,"location":{"filename":"src/nats/message/pub.cr","line_number":27,"url":null},"def":{"name":"reply_to","return_type":"String | ::Nil","visibility":"Public","body":"@reply_to"},"external_var":false},{"html_id":"reply_to=(reply_to:String|Nil)-instance-method","name":"reply_to=","doc":"The reply subject that subscribers can use to send a response back to the publisher/requestor.","summary":"

          The reply subject that subscribers can use to send a response back to the publisher/requestor.

          ","abstract":false,"args":[{"name":"reply_to","external_name":"reply_to","restriction":"String | ::Nil"}],"args_string":"(reply_to : String | Nil)","args_html":"(reply_to : String | Nil)","location":{"filename":"src/nats/message/pub.cr","line_number":27,"url":null},"def":{"name":"reply_to=","args":[{"name":"reply_to","external_name":"reply_to","restriction":"String | ::Nil"}],"visibility":"Public","body":"@reply_to = reply_to"},"external_var":false},{"html_id":"subject:String-instance-method","name":"subject","doc":"The destination subject to publish to.","summary":"

          The destination subject to publish to.

          ","abstract":false,"location":{"filename":"src/nats/message/pub.cr","line_number":25,"url":null},"def":{"name":"subject","return_type":"String","visibility":"Public","body":"@subject"},"external_var":false},{"html_id":"subject=(subject:String)-instance-method","name":"subject=","doc":"The destination subject to publish to.","summary":"

          The destination subject to publish to.

          ","abstract":false,"args":[{"name":"subject","external_name":"subject","restriction":"String"}],"args_string":"(subject : String)","args_html":"(subject : String)","location":{"filename":"src/nats/message/pub.cr","line_number":25,"url":null},"def":{"name":"subject=","args":[{"name":"subject","external_name":"subject","restriction":"String"}],"visibility":"Public","body":"@subject = subject"},"external_var":false},{"html_id":"to_s-instance-method","name":"to_s","doc":"Returns a nicely readable and concise string representation of this object,\ntypically intended for users.\n\nThis method should usually **not** be overridden. It delegates to\n`#to_s(IO)` which can be overridden for custom implementations.\n\nAlso see `#inspect`.","summary":"

          Returns a nicely readable and concise string representation of this object, typically intended for users.

          ","abstract":false,"location":{"filename":"src/nats/message/pub.cr","line_number":42,"url":null},"def":{"name":"to_s","visibility":"Public","body":"if reply_to.nil?\n \"PUB #{subject} #{bytes}#{CR_LF}#{payload}\"\nelse\n \"PUB #{subject} #{reply_to} #{bytes}#{CR_LF}#{payload}\"\nend"},"external_var":false}]},{"html_id":"nats/NATS/Message/SUB","path":"NATS/Message/SUB.html","kind":"struct","full_name":"NATS::Message::SUB","name":"SUB","abstract":false,"superclass":{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"nats/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/message/sub.cr","line_number":20,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"nats/NATS/Message","kind":"module","full_name":"NATS::Message","name":"Message"},"doc":"SUB initiates a subscription to a subject, optionally joining a distributed queue group.\n\nSEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#sub","summary":"

          SUB initiates a subscription to a subject, optionally joining a distributed queue group.

          ","constructors":[{"html_id":"new(subject:String,sid:String,queue_group:String|Nil=nil)-class-method","name":"new","abstract":false,"args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"sid","external_name":"sid","restriction":"String"},{"name":"queue_group","default_value":"nil","external_name":"queue_group","restriction":"String | ::Nil"}],"args_string":"(subject : String, sid : String, queue_group : String | Nil = nil)","args_html":"(subject : String, sid : String, queue_group : String | Nil = nil)","location":{"filename":"src/nats/message/sub.cr","line_number":28,"url":null},"def":{"name":"new","args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"sid","external_name":"sid","restriction":"String"},{"name":"queue_group","default_value":"nil","external_name":"queue_group","restriction":"String | ::Nil"}],"visibility":"Public","body":"_ = allocate\n_.initialize(subject, sid, queue_group)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}],"instance_methods":[{"html_id":"queue_group:String|Nil-instance-method","name":"queue_group","doc":"If specified, the subscriber will join this queue group.","summary":"

          If specified, the subscriber will join this queue group.

          ","abstract":false,"location":{"filename":"src/nats/message/sub.cr","line_number":24,"url":null},"def":{"name":"queue_group","return_type":"String | ::Nil","visibility":"Public","body":"@queue_group"},"external_var":false},{"html_id":"queue_group=(queue_group:String|Nil)-instance-method","name":"queue_group=","doc":"If specified, the subscriber will join this queue group.","summary":"

          If specified, the subscriber will join this queue group.

          ","abstract":false,"args":[{"name":"queue_group","external_name":"queue_group","restriction":"String | ::Nil"}],"args_string":"(queue_group : String | Nil)","args_html":"(queue_group : String | Nil)","location":{"filename":"src/nats/message/sub.cr","line_number":24,"url":null},"def":{"name":"queue_group=","args":[{"name":"queue_group","external_name":"queue_group","restriction":"String | ::Nil"}],"visibility":"Public","body":"@queue_group = queue_group"},"external_var":false},{"html_id":"sid:String-instance-method","name":"sid","doc":"A unique alphanumeric subscription ID, generated by the client.","summary":"

          A unique alphanumeric subscription ID, generated by the client.

          ","abstract":false,"location":{"filename":"src/nats/message/sub.cr","line_number":26,"url":null},"def":{"name":"sid","return_type":"String","visibility":"Public","body":"@sid"},"external_var":false},{"html_id":"sid=(sid:String)-instance-method","name":"sid=","doc":"A unique alphanumeric subscription ID, generated by the client.","summary":"

          A unique alphanumeric subscription ID, generated by the client.

          ","abstract":false,"args":[{"name":"sid","external_name":"sid","restriction":"String"}],"args_string":"(sid : String)","args_html":"(sid : String)","location":{"filename":"src/nats/message/sub.cr","line_number":26,"url":null},"def":{"name":"sid=","args":[{"name":"sid","external_name":"sid","restriction":"String"}],"visibility":"Public","body":"@sid = sid"},"external_var":false},{"html_id":"subject:String-instance-method","name":"subject","doc":"The subject name to subscribe to.","summary":"

          The subject name to subscribe to.

          ","abstract":false,"location":{"filename":"src/nats/message/sub.cr","line_number":22,"url":null},"def":{"name":"subject","return_type":"String","visibility":"Public","body":"@subject"},"external_var":false},{"html_id":"subject=(subject:String)-instance-method","name":"subject=","doc":"The subject name to subscribe to.","summary":"

          The subject name to subscribe to.

          ","abstract":false,"args":[{"name":"subject","external_name":"subject","restriction":"String"}],"args_string":"(subject : String)","args_html":"(subject : String)","location":{"filename":"src/nats/message/sub.cr","line_number":22,"url":null},"def":{"name":"subject=","args":[{"name":"subject","external_name":"subject","restriction":"String"}],"visibility":"Public","body":"@subject = subject"},"external_var":false},{"html_id":"to_s-instance-method","name":"to_s","doc":"Returns a nicely readable and concise string representation of this object,\ntypically intended for users.\n\nThis method should usually **not** be overridden. It delegates to\n`#to_s(IO)` which can be overridden for custom implementations.\n\nAlso see `#inspect`.","summary":"

          Returns a nicely readable and concise string representation of this object, typically intended for users.

          ","abstract":false,"location":{"filename":"src/nats/message/sub.cr","line_number":35,"url":null},"def":{"name":"to_s","visibility":"Public","body":"if queue_group.nil?\n \"SUB #{subject} #{sid}\"\nelse\n \"SUB #{subject} #{queue_group} #{sid}\"\nend"},"external_var":false}]},{"html_id":"nats/NATS/Message/UNSUB","path":"NATS/Message/UNSUB.html","kind":"struct","full_name":"NATS::Message::UNSUB","name":"UNSUB","abstract":false,"superclass":{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"nats/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/message/unsub.cr","line_number":21,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"nats/NATS/Message","kind":"module","full_name":"NATS::Message","name":"Message"},"doc":"UNSUB unsubscribes the connection from the specified subject,\n or auto-unsubscribes after the specified number of messages has been received.\n\nSEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#unsub","summary":"

          UNSUB unsubscribes the connection from the specified subject, or auto-unsubscribes after the specified number of messages has been received.

          ","constructors":[{"html_id":"new(sid:String,max_msgs:Int64|Nil=nil)-class-method","name":"new","abstract":false,"args":[{"name":"sid","external_name":"sid","restriction":"String"},{"name":"max_msgs","default_value":"nil","external_name":"max_msgs","restriction":"Int64 | ::Nil"}],"args_string":"(sid : String, max_msgs : Int64 | Nil = nil)","args_html":"(sid : String, max_msgs : Int64 | Nil = nil)","location":{"filename":"src/nats/message/unsub.cr","line_number":27,"url":null},"def":{"name":"new","args":[{"name":"sid","external_name":"sid","restriction":"String"},{"name":"max_msgs","default_value":"nil","external_name":"max_msgs","restriction":"Int64 | ::Nil"}],"visibility":"Public","body":"_ = allocate\n_.initialize(sid, max_msgs)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}],"instance_methods":[{"html_id":"max_msgs:Int64|Nil-instance-method","name":"max_msgs","doc":"If specified, the subscriber will join this queue group.","summary":"

          If specified, the subscriber will join this queue group.

          ","abstract":false,"location":{"filename":"src/nats/message/unsub.cr","line_number":25,"url":null},"def":{"name":"max_msgs","return_type":"Int64 | ::Nil","visibility":"Public","body":"@max_msgs"},"external_var":false},{"html_id":"max_msgs=(max_msgs:Int64|Nil)-instance-method","name":"max_msgs=","doc":"If specified, the subscriber will join this queue group.","summary":"

          If specified, the subscriber will join this queue group.

          ","abstract":false,"args":[{"name":"max_msgs","external_name":"max_msgs","restriction":"Int64 | ::Nil"}],"args_string":"(max_msgs : Int64 | Nil)","args_html":"(max_msgs : Int64 | Nil)","location":{"filename":"src/nats/message/unsub.cr","line_number":25,"url":null},"def":{"name":"max_msgs=","args":[{"name":"max_msgs","external_name":"max_msgs","restriction":"Int64 | ::Nil"}],"visibility":"Public","body":"@max_msgs = max_msgs"},"external_var":false},{"html_id":"sid:String-instance-method","name":"sid","doc":"The unique alphanumeric subscription ID of the subject to unsubscribe from.","summary":"

          The unique alphanumeric subscription ID of the subject to unsubscribe from.

          ","abstract":false,"location":{"filename":"src/nats/message/unsub.cr","line_number":23,"url":null},"def":{"name":"sid","return_type":"String","visibility":"Public","body":"@sid"},"external_var":false},{"html_id":"sid=(sid:String)-instance-method","name":"sid=","doc":"The unique alphanumeric subscription ID of the subject to unsubscribe from.","summary":"

          The unique alphanumeric subscription ID of the subject to unsubscribe from.

          ","abstract":false,"args":[{"name":"sid","external_name":"sid","restriction":"String"}],"args_string":"(sid : String)","args_html":"(sid : String)","location":{"filename":"src/nats/message/unsub.cr","line_number":23,"url":null},"def":{"name":"sid=","args":[{"name":"sid","external_name":"sid","restriction":"String"}],"visibility":"Public","body":"@sid = sid"},"external_var":false},{"html_id":"to_s-instance-method","name":"to_s","doc":"Returns a nicely readable and concise string representation of this object,\ntypically intended for users.\n\nThis method should usually **not** be overridden. It delegates to\n`#to_s(IO)` which can be overridden for custom implementations.\n\nAlso see `#inspect`.","summary":"

          Returns a nicely readable and concise string representation of this object, typically intended for users.

          ","abstract":false,"location":{"filename":"src/nats/message/unsub.cr","line_number":33,"url":null},"def":{"name":"to_s","visibility":"Public","body":"if max_msgs.nil?\n \"UNSUB #{sid}\"\nelse\n \"UNSUB #{sid} #{max_msgs}\"\nend"},"external_var":false}]}]},{"html_id":"nats/NATS/MSGError","path":"NATS/MSGError.html","kind":"class","full_name":"NATS::MSGError","name":"MSGError","abstract":false,"superclass":{"html_id":"nats/NATS/Error","kind":"class","full_name":"NATS::Error","name":"Error"},"ancestors":[{"html_id":"nats/NATS/Error","kind":"class","full_name":"NATS::Error","name":"Error"},{"html_id":"nats/Exception","kind":"class","full_name":"Exception","name":"Exception"},{"html_id":"nats/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/errors.cr","line_number":50,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"nats/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"+MSGError+ is raised when there is a problem with a +NATS::Message::MSG+.","summary":"

          +MSGError+ is raised when there is a problem with a +NATS::Message::MSG+.

          ","constructors":[{"html_id":"new(msg=\"MSGerror\")-class-method","name":"new","abstract":false,"args":[{"name":"msg","default_value":"\"MSG error\"","external_name":"msg","restriction":""}],"args_string":"(msg = \"MSG error\")","args_html":"(msg = "MSG error")","location":{"filename":"src/nats/errors.cr","line_number":51,"url":null},"def":{"name":"new","args":[{"name":"msg","default_value":"\"MSG error\"","external_name":"msg","restriction":""}],"visibility":"Public","body":"_ = allocate\n_.initialize(msg)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}]},{"html_id":"nats/NATS/NUID","path":"NATS/NUID.html","kind":"class","full_name":"NATS::NUID","name":"NUID","abstract":false,"superclass":{"html_id":"nats/Reference","kind":"class","full_name":"Reference","name":"Reference"},"ancestors":[{"html_id":"nats/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/nuid.cr","line_number":21,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"constants":[{"id":"BASE","name":"BASE","value":"62"},{"id":"DIGITS","name":"DIGITS","value":"\"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\""},{"id":"INC","name":"INC","value":"MAX_INC - MIN_INC"},{"id":"MAX_INC","name":"MAX_INC","value":"333_i64"},{"id":"MAX_SEQ","name":"MAX_SEQ","value":"839299365868340224_i64"},{"id":"MIN_INC","name":"MIN_INC","value":"33_i64"},{"id":"PREFIX_LENGTH","name":"PREFIX_LENGTH","value":"12"},{"id":"SEQ_LENGTH","name":"SEQ_LENGTH","value":"10"},{"id":"TOTAL_LENGTH","name":"TOTAL_LENGTH","value":"PREFIX_LENGTH + SEQ_LENGTH"}],"namespace":{"html_id":"nats/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"Copied and modified from nats-pure repo.\n\nSEE: https://github.com/nats-io/nats-pure.rb/blob/master/lib/nats/nuid.rb","summary":"

          Copied and modified from nats-pure repo.

          ","constructors":[{"html_id":"new-class-method","name":"new","abstract":false,"location":{"filename":"src/nats/nuid.cr","line_number":32,"url":null},"def":{"name":"new","visibility":"Public","body":"_ = allocate\n_.initialize\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}],"instance_methods":[{"html_id":"next-instance-method","name":"next","abstract":false,"location":{"filename":"src/nats/nuid.cr","line_number":38,"url":null},"def":{"name":"next","visibility":"Public","body":"@seq = @seq + @inc\nif @seq >= MAX_SEQ\n reset!\nend\nl = @seq\n\n\n\n\ns_10 = DIGITS[l % BASE]\n\ns_09, s_08, s_07, s_06, s_05, s_04, s_03, s_02, s_01 = (l = l // BASE\nDIGITS[l % BASE]), (l = l // BASE\nDIGITS[l % BASE]), (l = l // BASE\nDIGITS[l % BASE]), (l = l // BASE\nDIGITS[l % BASE]), (l = l // BASE\nDIGITS[l % BASE]), (l = l // BASE\nDIGITS[l % BASE]), (l = l // BASE\nDIGITS[l % BASE]), (l = l // BASE\nDIGITS[l % BASE]), (l = l // BASE\nDIGITS[l % BASE])\n\"#{@prefix}#{s_01}#{s_02}#{s_03}#{s_04}#{s_05}#{s_06}#{s_07}#{s_08}#{s_09}#{s_10}\"\n"},"external_var":false},{"html_id":"randomize_prefix!-instance-method","name":"randomize_prefix!","abstract":false,"location":{"filename":"src/nats/nuid.cr","line_number":60,"url":null},"def":{"name":"randomize_prefix!","visibility":"Public","body":"@prefix = String::Builder.build(PREFIX_LENGTH) do |io|\n Random::Secure.random_bytes(@pre_bytes)\n @pre_bytes.each do |n|\n io << DIGITS[n % BASE]\n end\nend"},"external_var":false}]},{"html_id":"nats/NATS/Options","path":"NATS/Options.html","kind":"struct","full_name":"NATS::Options","name":"Options","abstract":false,"superclass":{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"nats/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/options.cr","line_number":21,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"nats/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"Adapted from the nats.go library.\n\nNOTE: Currently only some options are implemented.\n\nSEE: https://github.com/nats-io/nats.go/blob/8a48023f77877dcfc140d0b9c25603c6cbedfaab/nats.go#L152","summary":"

          Adapted from the nats.go library.

          ","constructors":[{"html_id":"new-class-method","name":"new","abstract":false,"location":{"filename":"src/nats/options.cr","line_number":21,"url":null},"def":{"name":"new","visibility":"Public","body":"x = allocate\nif x.responds_to?(:finalize)\n ::GC.add_finalizer(x)\nend\nx\n"},"external_var":false}],"instance_methods":[{"html_id":"flush_interval:Time::Span-instance-method","name":"flush_interval","doc":"Specific to nats.cr","summary":"

          Specific to nats.cr

          ","abstract":false,"location":{"filename":"src/nats/options.cr","line_number":38,"url":null},"def":{"name":"flush_interval","return_type":"Time::Span","visibility":"Public","body":"@flush_interval"},"external_var":false},{"html_id":"flush_interval=(flush_interval:Time::Span)-instance-method","name":"flush_interval=","doc":"Specific to nats.cr","summary":"

          Specific to nats.cr

          ","abstract":false,"args":[{"name":"flush_interval","external_name":"flush_interval","restriction":"Time::Span"}],"args_string":"(flush_interval : Time::Span)","args_html":"(flush_interval : Time::Span)","location":{"filename":"src/nats/options.cr","line_number":38,"url":null},"def":{"name":"flush_interval=","args":[{"name":"flush_interval","external_name":"flush_interval","restriction":"Time::Span"}],"visibility":"Public","body":"@flush_interval = flush_interval"},"external_var":false},{"html_id":"initialize-instance-method","name":"initialize","abstract":false,"location":{"filename":"src/nats/options.cr","line_number":21,"url":null},"def":{"name":"initialize","visibility":"Public","body":""},"external_var":false},{"html_id":"pedantic:Bool-instance-method","name":"pedantic","doc":"property ping_interval : Time::Span = 2.minutes\nproperty max_pings_out : Int32 = 2\nproperty sub_chan_len : Int32 = 64 * 1024 # 64k\nproperty reconnect_buf_size : Int32 = 8 * 1024 * 1024 # 8MB\nproperty drain_timeout : Time::Span = 30.seconds\nproperty flusher_timeout : Time::Span = 1.minute","summary":"

          property ping_interval : Time::Span = 2.minutes property max_pings_out : Int32 = 2 property sub_chan_len : Int32 = 64 * 1024 # 64k property reconnect_buf_size : Int32 = 8 * 1024 * 1024 # 8MB property drain_timeout : Time::Span = 30.seconds property flusher_timeout : Time::Span = 1.minute

          ","abstract":false,"location":{"filename":"src/nats/options.cr","line_number":35,"url":null},"def":{"name":"pedantic","return_type":"Bool","visibility":"Public","body":"@pedantic"},"external_var":false},{"html_id":"pedantic=(pedantic:Bool)-instance-method","name":"pedantic=","doc":"property ping_interval : Time::Span = 2.minutes\nproperty max_pings_out : Int32 = 2\nproperty sub_chan_len : Int32 = 64 * 1024 # 64k\nproperty reconnect_buf_size : Int32 = 8 * 1024 * 1024 # 8MB\nproperty drain_timeout : Time::Span = 30.seconds\nproperty flusher_timeout : Time::Span = 1.minute","summary":"

          property ping_interval : Time::Span = 2.minutes property max_pings_out : Int32 = 2 property sub_chan_len : Int32 = 64 * 1024 # 64k property reconnect_buf_size : Int32 = 8 * 1024 * 1024 # 8MB property drain_timeout : Time::Span = 30.seconds property flusher_timeout : Time::Span = 1.minute

          ","abstract":false,"args":[{"name":"pedantic","external_name":"pedantic","restriction":"Bool"}],"args_string":"(pedantic : Bool)","args_html":"(pedantic : Bool)","location":{"filename":"src/nats/options.cr","line_number":35,"url":null},"def":{"name":"pedantic=","args":[{"name":"pedantic","external_name":"pedantic","restriction":"Bool"}],"visibility":"Public","body":"@pedantic = pedantic"},"external_var":false},{"html_id":"timeout:Time::Span-instance-method","name":"timeout","doc":"From nats.go\nproperty allow_reconnect : Bool = true\nproperty max_reconnect : Int32 = 60\nproperty reconnect_wait : Time::Span = 2.seconds\nproperty reconnect_jitter : Time::Span = 100.milliseconds\nproperty reconnect_jitter_tls : Time::Span = 1.second","summary":"

          From nats.go property allow_reconnect : Bool = true property max_reconnect : Int32 = 60 property reconnect_wait : Time::Span = 2.seconds property reconnect_jitter : Time::Span = 100.milliseconds property reconnect_jitter_tls : Time::Span = 1.second

          ","abstract":false,"location":{"filename":"src/nats/options.cr","line_number":28,"url":null},"def":{"name":"timeout","return_type":"Time::Span","visibility":"Public","body":"@timeout"},"external_var":false},{"html_id":"timeout=(timeout:Time::Span)-instance-method","name":"timeout=","doc":"From nats.go\nproperty allow_reconnect : Bool = true\nproperty max_reconnect : Int32 = 60\nproperty reconnect_wait : Time::Span = 2.seconds\nproperty reconnect_jitter : Time::Span = 100.milliseconds\nproperty reconnect_jitter_tls : Time::Span = 1.second","summary":"

          From nats.go property allow_reconnect : Bool = true property max_reconnect : Int32 = 60 property reconnect_wait : Time::Span = 2.seconds property reconnect_jitter : Time::Span = 100.milliseconds property reconnect_jitter_tls : Time::Span = 1.second

          ","abstract":false,"args":[{"name":"timeout","external_name":"timeout","restriction":"Time::Span"}],"args_string":"(timeout : Time::Span)","args_html":"(timeout : Time::Span)","location":{"filename":"src/nats/options.cr","line_number":28,"url":null},"def":{"name":"timeout=","args":[{"name":"timeout","external_name":"timeout","restriction":"Time::Span"}],"visibility":"Public","body":"@timeout = timeout"},"external_var":false}]},{"html_id":"nats/NATS/Subscription","path":"NATS/Subscription.html","kind":"struct","full_name":"NATS::Subscription","name":"Subscription","abstract":false,"superclass":{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"nats/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/subscription.cr","line_number":17,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"nats/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"Represents a subscription to a NATS subject.","summary":"

          Represents a subscription to a NATS subject.

          ","constructors":[{"html_id":"new(subject:String,sid:UInt64,callback:Message::MSG->Nil,client:Client,queue_group:String|Nil=nil)-class-method","name":"new","abstract":false,"args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"sid","external_name":"sid","restriction":"UInt64"},{"name":"callback","external_name":"callback","restriction":"(Message::MSG -> Nil)"},{"name":"client","external_name":"client","restriction":"Client"},{"name":"queue_group","default_value":"nil","external_name":"queue_group","restriction":"String | ::Nil"}],"args_string":"(subject : String, sid : UInt64, callback : Message::MSG -> Nil, client : Client, queue_group : String | Nil = nil)","args_html":"(subject : String, sid : UInt64, callback : Message::MSG -> Nil, client : Client, queue_group : String | Nil = nil)","location":{"filename":"src/nats/subscription.cr","line_number":29,"url":null},"def":{"name":"new","args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"sid","external_name":"sid","restriction":"UInt64"},{"name":"callback","external_name":"callback","restriction":"(Message::MSG -> Nil)"},{"name":"client","external_name":"client","restriction":"Client"},{"name":"queue_group","default_value":"nil","external_name":"queue_group","restriction":"String | ::Nil"}],"visibility":"Public","body":"_ = allocate\n_.initialize(subject, sid, callback, client, queue_group)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}],"instance_methods":[{"html_id":"callback:Message::MSG->Nil-instance-method","name":"callback","doc":"The callback to be invoked when a message is received.","summary":"

          The callback to be invoked when a message is received.

          ","abstract":false,"location":{"filename":"src/nats/subscription.cr","line_number":25,"url":null},"def":{"name":"callback","return_type":"(Message::MSG -> Nil)","visibility":"Public","body":"@callback"},"external_var":false},{"html_id":"callback=(callback:Message::MSG->Nil)-instance-method","name":"callback=","doc":"The callback to be invoked when a message is received.","summary":"

          The callback to be invoked when a message is received.

          ","abstract":false,"args":[{"name":"callback","external_name":"callback","restriction":"(Message::MSG -> Nil)"}],"args_string":"(callback : Message::MSG -> Nil)","args_html":"(callback : Message::MSG -> Nil)","location":{"filename":"src/nats/subscription.cr","line_number":25,"url":null},"def":{"name":"callback=","args":[{"name":"callback","external_name":"callback","restriction":"(Message::MSG -> Nil)"}],"visibility":"Public","body":"@callback = callback"},"external_var":false},{"html_id":"client:Client-instance-method","name":"client","doc":"The client that owns this subscription.","summary":"

          The client that owns this subscription.

          ","abstract":false,"location":{"filename":"src/nats/subscription.cr","line_number":27,"url":null},"def":{"name":"client","return_type":"Client","visibility":"Public","body":"@client"},"external_var":false},{"html_id":"queue_group:String|Nil-instance-method","name":"queue_group","doc":"If specified, the subscriber will join this queue group.","summary":"

          If specified, the subscriber will join this queue group.

          ","abstract":false,"location":{"filename":"src/nats/subscription.cr","line_number":21,"url":null},"def":{"name":"queue_group","return_type":"String | ::Nil","visibility":"Public","body":"@queue_group"},"external_var":false},{"html_id":"sid:UInt64-instance-method","name":"sid","doc":"A unique alphanumeric subscription ID, generated by the client.","summary":"

          A unique alphanumeric subscription ID, generated by the client.

          ","abstract":false,"location":{"filename":"src/nats/subscription.cr","line_number":23,"url":null},"def":{"name":"sid","return_type":"UInt64","visibility":"Public","body":"@sid"},"external_var":false},{"html_id":"subject:String-instance-method","name":"subject","doc":"The subject name to subscribe to.","summary":"

          The subject name to subscribe to.

          ","abstract":false,"location":{"filename":"src/nats/subscription.cr","line_number":19,"url":null},"def":{"name":"subject","return_type":"String","visibility":"Public","body":"@subject"},"external_var":false},{"html_id":"unsubscribe-instance-method","name":"unsubscribe","abstract":false,"location":{"filename":"src/nats/subscription.cr","line_number":38,"url":null},"def":{"name":"unsubscribe","visibility":"Public","body":"client.unsubscribe(self)"},"external_var":false}]},{"html_id":"nats/NATS/TimeoutError","path":"NATS/TimeoutError.html","kind":"class","full_name":"NATS::TimeoutError","name":"TimeoutError","abstract":false,"superclass":{"html_id":"nats/NATS/Error","kind":"class","full_name":"NATS::Error","name":"Error"},"ancestors":[{"html_id":"nats/NATS/Error","kind":"class","full_name":"NATS::Error","name":"Error"},{"html_id":"nats/Exception","kind":"class","full_name":"Exception","name":"Exception"},{"html_id":"nats/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/errors.cr","line_number":29,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"nats/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"+Timeout+ is raised when `NATS::Options.timeout` is reached.","summary":"

          +Timeout+ is raised when NATS::Options.timeout is reached.

          ","constructors":[{"html_id":"new(msg=\"Timeoutoccurred\")-class-method","name":"new","abstract":false,"args":[{"name":"msg","default_value":"\"Timeout occurred\"","external_name":"msg","restriction":""}],"args_string":"(msg = \"Timeout occurred\")","args_html":"(msg = "Timeout occurred")","location":{"filename":"src/nats/errors.cr","line_number":30,"url":null},"def":{"name":"new","args":[{"name":"msg","default_value":"\"Timeout occurred\"","external_name":"msg","restriction":""}],"visibility":"Public","body":"_ = allocate\n_.initialize(msg)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}]}]}]}} \ No newline at end of file diff --git a/docs/js/doc.js b/docs/js/doc.js index 8796e74..eaedd5c 100644 --- a/docs/js/doc.js +++ b/docs/js/doc.js @@ -1,11 +1,11 @@ -window.CrystalDoc = (window.CrystalDoc || {}); +window.CrystalDocs = (window.CrystalDocs || {}); -CrystalDoc.base_path = (CrystalDoc.base_path || ""); +CrystalDocs.base_path = (CrystalDocs.base_path || ""); -CrystalDoc.searchIndex = (CrystalDoc.searchIndex || false); -CrystalDoc.MAX_RESULTS_DISPLAY = 140; +CrystalDocs.searchIndex = (CrystalDocs.searchIndex || false); +CrystalDocs.MAX_RESULTS_DISPLAY = 140; -CrystalDoc.runQuery = function(query) { +CrystalDocs.runQuery = function(query) { function searchType(type, query, results) { var matches = []; var matchedFields = []; @@ -33,7 +33,7 @@ CrystalDoc.runQuery = function(query) { } if (matches.length > 0) { results.push({ - id: type.id, + id: type.html_id, result_type: "type", kind: type.kind, name: name, @@ -45,25 +45,36 @@ CrystalDoc.runQuery = function(query) { }); } - type.instance_methods.forEach(function(method) { - searchMethod(method, type, "instance_method", query, results); - }) - type.class_methods.forEach(function(method) { - searchMethod(method, type, "class_method", query, results); - }) - type.constructors.forEach(function(constructor) { - searchMethod(constructor, type, "constructor", query, results); - }) - type.macros.forEach(function(macro) { - searchMethod(macro, type, "macro", query, results); - }) - type.constants.forEach(function(constant){ - searchConstant(constant, type, query, results); - }); - - type.types.forEach(function(subtype){ - searchType(subtype, query, results); - }); + if (type.instance_methods) { + type.instance_methods.forEach(function(method) { + searchMethod(method, type, "instance_method", query, results); + }) + } + if (type.class_methods) { + type.class_methods.forEach(function(method) { + searchMethod(method, type, "class_method", query, results); + }) + } + if (type.constructors) { + type.constructors.forEach(function(constructor) { + searchMethod(constructor, type, "constructor", query, results); + }) + } + if (type.macros) { + type.macros.forEach(function(macro) { + searchMethod(macro, type, "macro", query, results); + }) + } + if (type.constants) { + type.constants.forEach(function(constant){ + searchConstant(constant, type, query, results); + }); + } + if (type.types) { + type.types.forEach(function(subtype){ + searchType(subtype, query, results); + }); + } }; function searchMethod(method, type, kind, query, results) { @@ -75,13 +86,15 @@ CrystalDoc.runQuery = function(query) { matchedFields.push("name"); } - method.args.forEach(function(arg){ - var argMatches = query.matches(arg.external_name); - if (argMatches) { - matches = matches.concat(argMatches); - matchedFields.push("args"); - } - }); + if (method.args) { + method.args.forEach(function(arg){ + var argMatches = query.matches(arg.external_name); + if (argMatches) { + matches = matches.concat(argMatches); + matchedFields.push("args"); + } + }); + } var docMatches = query.matches(type.doc); if(docMatches){ @@ -96,14 +109,14 @@ CrystalDoc.runQuery = function(query) { matches = matches.concat(typeMatches); } results.push({ - id: method.id, + id: method.html_id, type: type.full_name, result_type: kind, name: method.name, full_name: type.full_name + "#" + method.name, args_string: method.args_string, summary: method.summary, - href: type.path + "#" + method.id, + href: type.path + "#" + method.html_id, matched_fields: matchedFields, matched_terms: matches }); @@ -145,11 +158,11 @@ CrystalDoc.runQuery = function(query) { } var results = []; - searchType(CrystalDoc.searchIndex.program, query, results); + searchType(CrystalDocs.searchIndex.program, query, results); return results; }; -CrystalDoc.rankResults = function(results, query) { +CrystalDocs.rankResults = function(results, query) { function uniqueArray(ar) { var j = {}; @@ -171,42 +184,42 @@ CrystalDoc.rankResults = function(results, query) { var bOnlyDocs = bHasDocs && b.matched_fields.length == 1; if (a.result_type == "type" && b.result_type != "type" && !aOnlyDocs) { - if(CrystalDoc.DEBUG) { console.log("a is type b not"); } + if(CrystalDocs.DEBUG) { console.log("a is type b not"); } return -1; } else if (b.result_type == "type" && a.result_type != "type" && !bOnlyDocs) { - if(CrystalDoc.DEBUG) { console.log("b is type, a not"); } + if(CrystalDocs.DEBUG) { console.log("b is type, a not"); } return 1; } if (a.matched_fields.includes("name")) { if (b.matched_fields.includes("name")) { - var a_name = (CrystalDoc.prefixForType(a.result_type) || "") + ((a.result_type == "type") ? a.full_name : a.name); - var b_name = (CrystalDoc.prefixForType(b.result_type) || "") + ((b.result_type == "type") ? b.full_name : b.name); + var a_name = (CrystalDocs.prefixForType(a.result_type) || "") + ((a.result_type == "type") ? a.full_name : a.name); + var b_name = (CrystalDocs.prefixForType(b.result_type) || "") + ((b.result_type == "type") ? b.full_name : b.name); a_name = a_name.toLowerCase(); b_name = b_name.toLowerCase(); for(var i = 0; i < query.normalizedTerms.length; i++) { var term = query.terms[i].replace(/^::?|::?$/, ""); var a_orig_index = a_name.indexOf(term); var b_orig_index = b_name.indexOf(term); - if(CrystalDoc.DEBUG) { console.log("term: " + term + " a: " + a_name + " b: " + b_name); } - if(CrystalDoc.DEBUG) { console.log(a_orig_index, b_orig_index, a_orig_index - b_orig_index); } + if(CrystalDocs.DEBUG) { console.log("term: " + term + " a: " + a_name + " b: " + b_name); } + if(CrystalDocs.DEBUG) { console.log(a_orig_index, b_orig_index, a_orig_index - b_orig_index); } if (a_orig_index >= 0) { if (b_orig_index >= 0) { - if(CrystalDoc.DEBUG) { console.log("both have exact match", a_orig_index > b_orig_index ? -1 : 1); } + if(CrystalDocs.DEBUG) { console.log("both have exact match", a_orig_index > b_orig_index ? -1 : 1); } if(a_orig_index != b_orig_index) { - if(CrystalDoc.DEBUG) { console.log("both have exact match at different positions", a_orig_index > b_orig_index ? 1 : -1); } + if(CrystalDocs.DEBUG) { console.log("both have exact match at different positions", a_orig_index > b_orig_index ? 1 : -1); } return a_orig_index > b_orig_index ? 1 : -1; } } else { - if(CrystalDoc.DEBUG) { console.log("a has exact match, b not"); } + if(CrystalDocs.DEBUG) { console.log("a has exact match, b not"); } return -1; } } else if (b_orig_index >= 0) { - if(CrystalDoc.DEBUG) { console.log("b has exact match, a not"); } + if(CrystalDocs.DEBUG) { console.log("b has exact match, a not"); } return 1; } } } else { - if(CrystalDoc.DEBUG) { console.log("a has match in name, b not"); } + if(CrystalDocs.DEBUG) { console.log("a has match in name, b not"); } return -1; } } else if ( @@ -217,19 +230,19 @@ CrystalDoc.rankResults = function(results, query) { } if (matchedTermsDiff != 0 || (aHasDocs != bHasDocs)) { - if(CrystalDoc.DEBUG) { console.log("matchedTermsDiff: " + matchedTermsDiff, aHasDocs, bHasDocs); } + if(CrystalDocs.DEBUG) { console.log("matchedTermsDiff: " + matchedTermsDiff, aHasDocs, bHasDocs); } return matchedTermsDiff; } var matchedFieldsDiff = b.matched_fields.length - a.matched_fields.length; if (matchedFieldsDiff != 0) { - if(CrystalDoc.DEBUG) { console.log("matched to different number of fields: " + matchedFieldsDiff); } + if(CrystalDocs.DEBUG) { console.log("matched to different number of fields: " + matchedFieldsDiff); } return matchedFieldsDiff > 0 ? 1 : -1; } var nameCompare = a.name.localeCompare(b.name); if(nameCompare != 0){ - if(CrystalDoc.DEBUG) { console.log("nameCompare resulted in: " + a.name + "<=>" + b.name + ": " + nameCompare); } + if(CrystalDocs.DEBUG) { console.log("nameCompare resulted in: " + a.name + "<=>" + b.name + ": " + nameCompare); } return nameCompare > 0 ? 1 : -1; } @@ -238,7 +251,7 @@ CrystalDoc.rankResults = function(results, query) { var term = query.terms[i]; var aIndex = a.args_string.indexOf(term); var bIndex = b.args_string.indexOf(term); - if(CrystalDoc.DEBUG) { console.log("index of " + term + " in args_string: " + aIndex + " - " + bIndex); } + if(CrystalDocs.DEBUG) { console.log("index of " + term + " in args_string: " + aIndex + " - " + bIndex); } if(aIndex >= 0){ if(bIndex >= 0){ if(aIndex != bIndex){ @@ -267,7 +280,7 @@ CrystalDoc.rankResults = function(results, query) { return results; }; -CrystalDoc.prefixForType = function(type) { +CrystalDocs.prefixForType = function(type) { switch (type) { case "instance_method": return "#"; @@ -282,14 +295,14 @@ CrystalDoc.prefixForType = function(type) { } }; -CrystalDoc.displaySearchResults = function(results, query) { +CrystalDocs.displaySearchResults = function(results, query) { function sanitize(html){ return html.replace(/<(?!\/?code)[^>]+>/g, ""); } // limit results - if (results.length > CrystalDoc.MAX_RESULTS_DISPLAY) { - results = results.slice(0, CrystalDoc.MAX_RESULTS_DISPLAY); + if (results.length > CrystalDocs.MAX_RESULTS_DISPLAY) { + results = results.slice(0, CrystalDocs.MAX_RESULTS_DISPLAY); } var $frag = document.createDocumentFragment(); @@ -297,12 +310,12 @@ CrystalDoc.displaySearchResults = function(results, query) { $resultsElem.innerHTML = ""; results.forEach(function(result, i) { - var url = CrystalDoc.base_path + result.href; + var url = CrystalDocs.base_path + result.href; var type = false; var title = query.highlight(result.result_type == "type" ? result.full_name : result.name); - var prefix = CrystalDoc.prefixForType(result.result_type); + var prefix = CrystalDocs.prefixForType(result.result_type); if (prefix) { title = "" + prefix + "" + title; } @@ -351,10 +364,10 @@ CrystalDoc.displaySearchResults = function(results, query) { $resultsElem.appendChild($frag); - CrystalDoc.toggleResultsList(true); + CrystalDocs.toggleResultsList(true); }; -CrystalDoc.toggleResultsList = function(visible) { +CrystalDocs.toggleResultsList = function(visible) { if (visible) { document.querySelector(".types-list").classList.add("hidden"); document.querySelector(".search-results").classList.remove("hidden"); @@ -364,20 +377,20 @@ CrystalDoc.toggleResultsList = function(visible) { } }; -CrystalDoc.Query = function(string) { +CrystalDocs.Query = function(string) { this.original = string; this.terms = string.split(/\s+/).filter(function(word) { - return CrystalDoc.Query.stripModifiers(word).length > 0; + return CrystalDocs.Query.stripModifiers(word).length > 0; }); - var normalized = this.terms.map(CrystalDoc.Query.normalizeTerm); + var normalized = this.terms.map(CrystalDocs.Query.normalizeTerm); this.normalizedTerms = normalized; function runMatcher(field, matcher) { if (!field) { return false; } - var normalizedValue = CrystalDoc.Query.normalizeTerm(field); + var normalizedValue = CrystalDocs.Query.normalizeTerm(field); var matches = []; normalized.forEach(function(term) { @@ -435,7 +448,7 @@ CrystalDoc.Query = function(string) { methodName = term.substring(i+1); if(termType != "") { - if(CrystalDoc.Query.normalizeTerm(type.full_name).indexOf(termType) < 0){ + if(CrystalDocs.Query.normalizeTerm(type.full_name).indexOf(termType) < 0){ return false; } } @@ -461,10 +474,10 @@ CrystalDoc.Query = function(string) { ); }; }; -CrystalDoc.Query.normalizeTerm = function(term) { +CrystalDocs.Query.normalizeTerm = function(term) { return term.toLowerCase(); }; -CrystalDoc.Query.stripModifiers = function(term) { +CrystalDocs.Query.stripModifiers = function(term) { switch (term[0]) { case "#": case ".": @@ -476,34 +489,34 @@ CrystalDoc.Query.stripModifiers = function(term) { } } -CrystalDoc.search = function(string) { - if(!CrystalDoc.searchIndex) { - console.log("CrystalDoc search index not initialized, delaying search"); +CrystalDocs.search = function(string) { + if(!CrystalDocs.searchIndex) { + console.log("CrystalDocs search index not initialized, delaying search"); - document.addEventListener("CrystalDoc:loaded", function listener(){ - document.removeEventListener("CrystalDoc:loaded", listener); - CrystalDoc.search(string); + document.addEventListener("CrystalDocs:loaded", function listener(){ + document.removeEventListener("CrystalDocs:loaded", listener); + CrystalDocs.search(string); }); return; } - document.dispatchEvent(new Event("CrystalDoc:searchStarted")); + document.dispatchEvent(new Event("CrystalDocs:searchStarted")); - var query = new CrystalDoc.Query(string); - var results = CrystalDoc.runQuery(query); - results = CrystalDoc.rankResults(results, query); - CrystalDoc.displaySearchResults(results, query); + var query = new CrystalDocs.Query(string); + var results = CrystalDocs.runQuery(query); + results = CrystalDocs.rankResults(results, query); + CrystalDocs.displaySearchResults(results, query); - document.dispatchEvent(new Event("CrystalDoc:searchPerformed")); + document.dispatchEvent(new Event("CrystalDocs:searchPerformed")); }; -CrystalDoc.initializeIndex = function(data) { - CrystalDoc.searchIndex = data; +CrystalDocs.initializeIndex = function(data) { + CrystalDocs.searchIndex = data; - document.dispatchEvent(new Event("CrystalDoc:loaded")); + document.dispatchEvent(new Event("CrystalDocs:loaded")); }; -CrystalDoc.loadIndex = function() { +CrystalDocs.loadIndex = function() { function loadJSON(file, callback) { var xobj = new XMLHttpRequest(); xobj.overrideMimeType("application/json"); @@ -523,7 +536,7 @@ CrystalDoc.loadIndex = function() { } function parseJSON(json) { - CrystalDoc.initializeIndex(JSON.parse(json)); + CrystalDocs.initializeIndex(JSON.parse(json)); } for(var i = 0; i < document.scripts.length; i++){ @@ -546,7 +559,7 @@ CrystalDoc.loadIndex = function() { // Callback for jsonp function crystal_doc_search_index_callback(data) { - CrystalDoc.initializeIndex(data); + CrystalDocs.initializeIndex(data); } Navigator = function(sidebar, searchInput, list, leaveSearchScope){ @@ -555,23 +568,23 @@ Navigator = function(sidebar, searchInput, list, leaveSearchScope){ var performingSearch = false; - document.addEventListener('CrystalDoc:searchStarted', function(){ + document.addEventListener('CrystalDocs:searchStarted', function(){ performingSearch = true; }); - document.addEventListener('CrystalDoc:searchDebounceStarted', function(){ + document.addEventListener('CrystalDocs:searchDebounceStarted', function(){ performingSearch = true; }); - document.addEventListener('CrystalDoc:searchPerformed', function(){ + document.addEventListener('CrystalDocs:searchPerformed', function(){ performingSearch = false; }); - document.addEventListener('CrystalDoc:searchDebounceStopped', function(event){ + document.addEventListener('CrystalDocs:searchDebounceStopped', function(event){ performingSearch = false; }); function delayWhileSearching(callback) { if(performingSearch){ - document.addEventListener('CrystalDoc:searchPerformed', function listener(){ - document.removeEventListener('CrystalDoc:searchPerformed', listener); + document.addEventListener('CrystalDocs:searchPerformed', function listener(){ + document.removeEventListener('CrystalDocs:searchPerformed', listener); // add some delay to let search results display kick in setTimeout(callback, 100); @@ -594,7 +607,7 @@ Navigator = function(sidebar, searchInput, list, leaveSearchScope){ var go = function() { if (!self.moveTimeout) return; self.move(upwards); - self.moveTimout = setTimeout(go, 600); + self.moveTimeout = setTimeout(go, 600); }; self.moveTimeout = setTimeout(go, 800);*/ } @@ -783,6 +796,74 @@ Navigator = function(sidebar, searchInput, list, leaveSearchScope){ this.move(); }; +CrystalDocs.initializeVersions = function () { + function loadJSON(file, callback) { + var xobj = new XMLHttpRequest(); + xobj.overrideMimeType("application/json"); + xobj.open("GET", file, true); + xobj.onreadystatechange = function() { + if (xobj.readyState == 4 && xobj.status == "200") { + callback(xobj.responseText); + } + }; + xobj.send(null); + } + + function parseJSON(json) { + CrystalDocs.loadConfig(JSON.parse(json)); + } + + $elem = document.querySelector("html > head > meta[name=\"crystal_docs.json_config_url\"]") + if ($elem == undefined) { + return + } + jsonURL = $elem.getAttribute("content") + if (jsonURL && jsonURL != "") { + loadJSON(jsonURL, parseJSON); + } +} + +CrystalDocs.loadConfig = function (config) { + var projectVersions = config["versions"] + var currentVersion = document.querySelector("html > head > meta[name=\"crystal_docs.project_version\"]").getAttribute("content") + + var currentVersionInList = projectVersions.find(function (element) { + return element.name == currentVersion + }) + + if (!currentVersionInList) { + projectVersions.unshift({ name: currentVersion, url: '#' }) + } + + $version = document.querySelector(".project-summary > .project-version") + $version.innerHTML = "" + + $select = document.createElement("select") + $select.classList.add("project-versions-nav") + $select.addEventListener("change", function () { + window.location.href = this.value + }) + projectVersions.forEach(function (version) { + $item = document.createElement("option") + $item.setAttribute("value", version.url) + $item.append(document.createTextNode(version.name)) + + if (version.name == currentVersion) { + $item.setAttribute("selected", true) + $item.setAttribute("disabled", true) + } + $select.append($item) + }); + $form = document.createElement("form") + $form.setAttribute("autocomplete", "off") + $form.append($select) + $version.append($form) +} + +document.addEventListener("DOMContentLoaded", function () { + CrystalDocs.initializeVersions() +}) + var UsageModal = function(title, content) { var $body = document.body; var self = this; @@ -840,7 +921,7 @@ document.addEventListener('DOMContentLoaded', function() { }; } - var repositoryName = document.querySelector('#repository-name').getAttribute('content'); + var repositoryName = document.querySelector('[name=repository-name]').getAttribute('content'); var typesList = document.querySelector('.types-list'); var searchInput = document.querySelector('.search-input'); var parents = document.querySelectorAll('.types-list li.parent'); @@ -849,7 +930,7 @@ document.addEventListener('DOMContentLoaded', function() { var openTypes = typesList.querySelectorAll('.current'); if (openTypes.length > 0) { var lastOpenType = openTypes[openTypes.length - 1]; - lastOpenType.scrollIntoView(); + lastOpenType.scrollIntoView(!(window.matchMedia('only screen and (max-width: 635px)')).matches); } } @@ -883,28 +964,28 @@ document.addEventListener('DOMContentLoaded', function() { } var leaveSearchScope = function(){ - CrystalDoc.toggleResultsList(false); + CrystalDocs.toggleResultsList(false); window.focus(); } var navigator = new Navigator(document.querySelector('.types-list'), searchInput, document.querySelector(".search-results"), leaveSearchScope); - CrystalDoc.loadIndex(); + CrystalDocs.loadIndex(); var searchTimeout; var lastSearchText = false; var performSearch = function() { - document.dispatchEvent(new Event("CrystalDoc:searchDebounceStarted")); + document.dispatchEvent(new Event("CrystalDocs:searchDebounceStarted")); clearTimeout(searchTimeout); searchTimeout = setTimeout(function() { var text = searchInput.value; if(text == "") { - CrystalDoc.toggleResultsList(false); + CrystalDocs.toggleResultsList(false); }else if(text == lastSearchText){ - document.dispatchEvent(new Event("CrystalDoc:searchDebounceStopped")); + document.dispatchEvent(new Event("CrystalDocs:searchDebounceStopped")); }else{ - CrystalDoc.search(text); + CrystalDocs.search(text); navigator.highlightFirst(); searchInput.focus(); } @@ -919,8 +1000,8 @@ document.addEventListener('DOMContentLoaded', function() { // TODO: Add OpenSearch description var searchQuery = location.hash.substring(3); history.pushState({searchQuery: searchQuery}, "Search for " + searchQuery, location.href.replace(/#q=.*/, "")); - searchInput.value = searchQuery; - document.addEventListener('CrystalDoc:loaded', performSearch); + searchInput.value = decodeURIComponent(searchQuery); + document.addEventListener('CrystalDocs:loaded', performSearch); } if (searchInput.value.length == 0) { @@ -1006,11 +1087,10 @@ document.addEventListener('DOMContentLoaded', function() { var scrollToEntryFromLocationHash = function() { var hash = window.location.hash; if (hash) { - var targetAnchor = unescape(hash.substr(1)); - var targetEl = document.querySelectorAll('.entry-detail[id="' + targetAnchor + '"]'); - - if (targetEl && targetEl.length > 0) { - targetEl[0].offsetParent.scrollTop = targetEl[0].offsetTop; + var targetAnchor = decodeURI(hash.substr(1)); + var targetEl = document.getElementById(targetAnchor) + if (targetEl) { + targetEl.offsetParent.scrollTop = targetEl.offsetTop; } } }; diff --git a/docs/search-index.js b/docs/search-index.js index b26c295..9b2beec 100644 --- a/docs/search-index.js +++ b/docs/search-index.js @@ -1 +1 @@ -crystal_doc_search_index_callback({"repository_name":"github.com/nats-io/nats.cr","body":"# NATS - Crystal Client\n\nSimple NATS client for the [Crystal](https://http://crystal-lang.org) programming language.\n\n[![License Apache 2](https://img.shields.io/badge/License-Apache2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)\n[![Build Status](https://travis-ci.org/nats-io/nats.cr.svg?branch=master)](http://travis-ci.org/nats-io/nats.cr)\n\n## Installation\n\n1. Add the dependency to your `shard.yml`:\n\n```yaml\n dependencies:\n nats:\n github: nats-io/nats.cr\n```\n\n2. Run `shards install`\n\n## Usage\n\n```crystal\nrequire \"nats\"\n\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc.subscribe(\"foo\") { |msg| puts \"Received '#{msg}'\"}\nnc.publish(\"foo\", \"Hello!\")\n\nsub = nc.subscribe(\"req\") do |msg|\n msg.respond(\"ANSWER is 42\")\nend\n\nanswer = nc.request(\"req\", \"Help!\")\nputs \"Received a response '#{answer}'!\"\n\nsub.close\n\nnc.flush\nnc.close\n```\n\n## License\n\nUnless otherwise noted, the NATS source files are distributed under\nthe Apache Version 2.0 license found in the LICENSE file.\n","program":{"html_id":"github.com/nats-io/nats.cr/toplevel","path":"toplevel.html","kind":"module","full_name":"Top Level Namespace","name":"Top Level Namespace","abstract":false,"superclass":null,"ancestors":[],"locations":[],"repository_name":"github.com/nats-io/nats.cr","program":true,"enum":false,"alias":false,"aliased":"","const":false,"constants":[],"included_modules":[],"extended_modules":[],"subclasses":[],"including_types":[],"namespace":null,"doc":null,"summary":null,"class_methods":[],"constructors":[],"instance_methods":[],"macros":[],"types":[{"html_id":"github.com/nats-io/nats.cr/NATS","path":"NATS.html","kind":"module","full_name":"NATS","name":"NATS","abstract":false,"superclass":null,"ancestors":[],"locations":[{"filename":"nats/nuid.cr","line_number":20,"url":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/nuid.cr"},{"filename":"nats/msg.cr","line_number":15,"url":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/msg.cr"},{"filename":"nats/subscription.cr","line_number":15,"url":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/subscription.cr"},{"filename":"nats/connection.cr","line_number":24,"url":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr"}],"repository_name":"github.com/nats-io/nats.cr","program":false,"enum":false,"alias":false,"aliased":"","const":false,"constants":[{"id":"LANG","name":"LANG","value":"\"crystal\"","doc":null,"summary":null},{"id":"VERSION","name":"VERSION","value":"\"0.0.1\"","doc":null,"summary":null}],"included_modules":[],"extended_modules":[],"subclasses":[],"including_types":[],"namespace":null,"doc":null,"summary":null,"class_methods":[],"constructors":[],"instance_methods":[],"macros":[],"types":[{"html_id":"github.com/nats-io/nats.cr/NATS/Connection","path":"NATS/Connection.html","kind":"class","full_name":"NATS::Connection","name":"Connection","abstract":false,"superclass":{"html_id":"github.com/nats-io/nats.cr/Reference","kind":"class","full_name":"Reference","name":"Reference"},"ancestors":[{"html_id":"github.com/nats-io/nats.cr/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"github.com/nats-io/nats.cr/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"nats/connection.cr","line_number":28,"url":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr"}],"repository_name":"github.com/nats-io/nats.cr","program":false,"enum":false,"alias":false,"aliased":"","const":false,"constants":[],"included_modules":[],"extended_modules":[],"subclasses":[],"including_types":[],"namespace":{"html_id":"github.com/nats-io/nats.cr/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":null,"summary":null,"class_methods":[],"constructors":[{"id":"new(host,port,user:String?=nil,pass:String?=nil,name:String?=nil,echo=true,pedantic=false)-class-method","html_id":"new(host,port,user:String?=nil,pass:String?=nil,name:String?=nil,echo=true,pedantic=false)-class-method","name":"new","doc":"Creates a new connection to a NATS Server.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc = NATS::Connection.new(\"tls://demo.nats.io\")\nnc = NATS::Connection.new(\"nats://#{user}:#{pass}@127.0.0.1:4222\")\nnc = NATS::Connection.new(4222, name: \"Sample App\", user: \"derek\", pass: \"s3cr3t\")\nnc = NATS::Connection.new(4222)\nnc = NATS::Connection.new\n```","summary":"

          Creates a new connection to a NATS Server.

          ","abstract":false,"args":[{"name":"host","doc":null,"default_value":"","external_name":"host","restriction":""},{"name":"port","doc":null,"default_value":"","external_name":"port","restriction":""},{"name":"user","doc":null,"default_value":"nil","external_name":"user","restriction":"String | ::Nil"},{"name":"pass","doc":null,"default_value":"nil","external_name":"pass","restriction":"String | ::Nil"},{"name":"name","doc":null,"default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"echo","doc":null,"default_value":"true","external_name":"echo","restriction":""},{"name":"pedantic","doc":null,"default_value":"false","external_name":"pedantic","restriction":""}],"args_string":"(host, port, user : String? = nil, pass : String? = nil, name : String? = nil, echo = true, pedantic = false)","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L55","def":{"name":"new","args":[{"name":"host","doc":null,"default_value":"","external_name":"host","restriction":""},{"name":"port","doc":null,"default_value":"","external_name":"port","restriction":""},{"name":"user","doc":null,"default_value":"nil","external_name":"user","restriction":"String | ::Nil"},{"name":"pass","doc":null,"default_value":"nil","external_name":"pass","restriction":"String | ::Nil"},{"name":"name","doc":null,"default_value":"nil","external_name":"name","restriction":"String | ::Nil"},{"name":"echo","doc":null,"default_value":"true","external_name":"echo","restriction":""},{"name":"pedantic","doc":null,"default_value":"false","external_name":"pedantic","restriction":""}],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"_ = allocate\n_.initialize(host, port, user, pass, name, echo, pedantic)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"id":"close-instance-method","html_id":"close-instance-method","name":"close","doc":"Close a connection to the NATS server.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc.close\n```","summary":"

          Close a connection to the NATS server.

          ","abstract":false,"args":[],"args_string":"","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L347","def":{"name":"close","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"if @closed\n return\nend\n@closed = true\n@out.synchronize do\n flush_outbound\n @socket.flush\nend\n@socket.close\n@subs.each do |sid, sub|\n sub.unsubscribe\nend\n@close_cb.try do |cb|\n spawn(cb.call)\nend\n"}},{"id":"closed?:Bool-instance-method","html_id":"closed?:Bool-instance-method","name":"closed?","doc":null,"summary":null,"abstract":false,"args":[],"args_string":" : Bool","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L42","def":{"name":"closed?","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"@closed"}},{"id":"flush(timeout=2.second)-instance-method","html_id":"flush(timeout=2.second)-instance-method","name":"flush","doc":"Flush will flush the connection to the server. Can specify a *timeout*.","summary":"

          Flush will flush the connection to the server.

          ","abstract":false,"args":[{"name":"timeout","doc":null,"default_value":"2.second","external_name":"timeout","restriction":""}],"args_string":"(timeout = 2.second)","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L229","def":{"name":"flush","args":[{"name":"timeout","doc":null,"default_value":"2.second","external_name":"timeout","restriction":""}],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"ch = Channel(Nil).new\n@pongs.push(ch)\n@out.synchronize do\n @buf.write(PING_SLICE)\nend\nflush_outbound\nspawn do\n sleep(timeout)\n ch.close\nend\nbegin\n ch.receive\nrescue\n {raise(\"Flush Timeout\")}\nend\n"}},{"id":"max_payload:Int32-instance-method","html_id":"max_payload:Int32-instance-method","name":"max_payload","doc":null,"summary":null,"abstract":false,"args":[],"args_string":" : Int32","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L43","def":{"name":"max_payload","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"@max_payload"}},{"id":"new_inbox-instance-method","html_id":"new_inbox-instance-method","name":"new_inbox","doc":null,"summary":null,"abstract":false,"args":[],"args_string":"","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L238","def":{"name":"new_inbox","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"\"#{@resp_sub_prefix}.#{inbox_token}\""}},{"id":"on_close(&callback)-instance-method","html_id":"on_close(&callback)-instance-method","name":"on_close","doc":"Setup a callback for when the connection closes.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc.on_close { puts \"Connection closed!\" }\nnc.close\n```","summary":"

          Setup a callback for when the connection closes.

          ","abstract":false,"args":[],"args_string":"(&callback)","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L369","def":{"name":"on_close","args":[],"double_splat":null,"splat_index":null,"yields":0,"block_arg":{"name":"callback","doc":null,"default_value":"","external_name":"callback","restriction":""},"return_type":"","visibility":"Public","body":"@close_cb = callback"}},{"id":"on_error(&callback:String->)-instance-method","html_id":"on_error(&callback:String->)-instance-method","name":"on_error","doc":"Setup a callback for an async errors that are received.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc.on_error { |e| puts \"Received an error #{e}\" }\n```","summary":"

          Setup a callback for an async errors that are received.

          ","abstract":false,"args":[],"args_string":"(&callback : String -> )","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L379","def":{"name":"on_error","args":[],"double_splat":null,"splat_index":null,"yields":1,"block_arg":{"name":"callback","doc":null,"default_value":"","external_name":"callback","restriction":"(String -> )"},"return_type":"","visibility":"Public","body":"@err_cb = callback"}},{"id":"publish(subject:String,msg)-instance-method","html_id":"publish(subject:String,msg)-instance-method","name":"publish","doc":"Publishes a messages to a given subject.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc.publish(\"foo\", \"Hello!\")\n```","summary":"

          Publishes a messages to a given subject.

          ","abstract":false,"args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":"String"},{"name":"msg","doc":null,"default_value":"","external_name":"msg","restriction":""}],"args_string":"(subject : String, msg)","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L164","def":{"name":"publish","args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":"String"},{"name":"msg","doc":null,"default_value":"","external_name":"msg","restriction":""}],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"if subject.empty?\n raise(\"Bad Subject\")\nend\nif closed?\n raise(\"Connection Closed\")\nend\ndata = msg.to_slice\ncheck_size(data)\n@out.synchronize do\n @buf.write(PUB_SLICE)\n @buf.write(\"#{subject} #{data.size}\".to_slice)\n @buf.write(CR_LF_SLICE)\n @buf.write(data)\n @buf.write(CR_LF_SLICE)\nend\nif @flush.empty?\n @flush.send(true)\nend\n"}},{"id":"publish(subject:String)-instance-method","html_id":"publish(subject:String)-instance-method","name":"publish","doc":"Publishes an empty message to a given subject.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc.publish(\"foo\")\n```","summary":"

          Publishes an empty message to a given subject.

          ","abstract":false,"args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":"String"}],"args_string":"(subject : String)","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L188","def":{"name":"publish","args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":"String"}],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"if subject.empty?\n raise(\"Bad Subject\")\nend\nif closed?\n raise(\"Connection Closed\")\nend\n@out.synchronize do\n @buf.write(\"PUB #{subject} 0\\r\\n\\r\\n\".to_slice)\nend\nif @flush.empty?\n @flush.send(true)\nend\n"}},{"id":"publish_with_reply(subject,reply:String,msg)-instance-method","html_id":"publish_with_reply(subject,reply:String,msg)-instance-method","name":"publish_with_reply","doc":"Publishes a messages to a given subject with a reply subject.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc.publish_with_reply(\"foo\", \"reply\", \"Hello!\")\n```","summary":"

          Publishes a messages to a given subject with a reply subject.

          ","abstract":false,"args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":""},{"name":"reply","doc":null,"default_value":"","external_name":"reply","restriction":"String"},{"name":"msg","doc":null,"default_value":"","external_name":"msg","restriction":""}],"args_string":"(subject, reply : String, msg)","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L220","def":{"name":"publish_with_reply","args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":""},{"name":"reply","doc":null,"default_value":"","external_name":"reply","restriction":"String"},{"name":"msg","doc":null,"default_value":"","external_name":"msg","restriction":""}],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"if subject.empty?\n raise(\"Bad Subject\")\nend\nif closed?\n raise(\"Connection Closed\")\nend\n@out.synchronize do\n @buf.write(\"PUB #{subject} #{reply} 0\\r\\n\\r\\n\".to_slice)\nend\nif @flush.empty?\n @flush.send(true)\nend\n"}},{"id":"request(subject:String,msg?,timeout=2.second)-instance-method","html_id":"request(subject:String,msg?,timeout=2.second)-instance-method","name":"request","doc":"Request will send a request to the given subject and wait up to *timeout* for a response.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nanswer = nc.request(\"req\", \"Help!\")\nputs \"Received a response '#{answer}'!\"\n```","summary":"

          Request will send a request to the given subject and wait up to timeout for a response.

          ","abstract":false,"args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":"String"},{"name":"msg?","doc":null,"default_value":"","external_name":"msg?","restriction":""},{"name":"timeout","doc":null,"default_value":"2.second","external_name":"timeout","restriction":""}],"args_string":"(subject : String, msg?, timeout = 2.second)","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L275","def":{"name":"request","args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":"String"},{"name":"msg?","doc":null,"default_value":"","external_name":"msg?","restriction":""},{"name":"timeout","doc":null,"default_value":"2.second","external_name":"timeout","restriction":""}],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"if @resp_sub_created\nelse\n create_resp_subscription\nend\ntoken = inbox_token\nreply = \"#{@resp_sub_prefix}.#{token}\"\nch = Channel(Msg | ::Nil).new\n@resp_map[token] = ch\npublish_with_reply(subject, reply, msg?)\nspawn do\n sleep(timeout)\n ch.close\nend\nbegin\n msg = ch.receive\nrescue\n @resp_map.delete(token)\n raise(\"Request Timeout\")\nend\n"}},{"id":"subscribe(subject,queue:String,&callback:Msg->)-instance-method","html_id":"subscribe(subject,queue:String,&callback:Msg->)-instance-method","name":"subscribe","doc":"Subscribe to a given subject with the queue group. Will yield to the callback provided with the message received.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc.subscribe(\"foo\", \"group1\") { |msg| puts \"Received '#{msg}'\" }\n```","summary":"

          Subscribe to a given subject with the queue group.

          ","abstract":false,"args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":""},{"name":"queue","doc":null,"default_value":"","external_name":"queue","restriction":"String"}],"args_string":"(subject, queue : String, &callback : Msg -> )","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L321","def":{"name":"subscribe","args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":""},{"name":"queue","doc":null,"default_value":"","external_name":"queue","restriction":"String"}],"double_splat":null,"splat_index":null,"yields":1,"block_arg":{"name":"callback","doc":null,"default_value":"","external_name":"callback","restriction":"(Msg -> )"},"return_type":"","visibility":"Public","body":"sid = @gsid = @gsid + 1\n@out.synchronize do\n ((((@buf << \"SUB \") << subject) << \" \") << queue) << \" #{sid}\\r\\n\"\nend\nif @flush.empty?\n @flush.send(true)\nend\n(Subscription.new(sid, self, callback)).tap do |sub|\n @subs[sid] = sub\nend\n"}},{"id":"subscribe(subject:String,queue:String?,&callback:Msg->)-instance-method","html_id":"subscribe(subject:String,queue:String?,&callback:Msg->)-instance-method","name":"subscribe","doc":null,"summary":null,"abstract":false,"args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":"String"},{"name":"queue","doc":null,"default_value":"","external_name":"queue","restriction":"String | Nil"}],"args_string":"(subject : String, queue : String?, &callback : Msg -> )","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L330","def":{"name":"subscribe","args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":"String"},{"name":"queue","doc":null,"default_value":"","external_name":"queue","restriction":"String | Nil"}],"double_splat":null,"splat_index":null,"yields":1,"block_arg":{"name":"callback","doc":null,"default_value":"","external_name":"callback","restriction":"(Msg -> )"},"return_type":"","visibility":"Public","body":"if queue.is_a?(String)\n return subscribe(subject, queue, &callback)\nend\nsubscribe(subject, &callback)\n"}},{"id":"subscribe(subject:String,&callback:Msg->)-instance-method","html_id":"subscribe(subject:String,&callback:Msg->)-instance-method","name":"subscribe","doc":"Subscribe to a given subject. Will yield to the callback provided with the message received.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc.subscribe(\"foo\") { |msg| puts \"Received '#{msg}'\" }\n```","summary":"

          Subscribe to a given subject.

          ","abstract":false,"args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":"String"}],"args_string":"(subject : String, &callback : Msg -> )","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/connection.cr#L306","def":{"name":"subscribe","args":[{"name":"subject","doc":null,"default_value":"","external_name":"subject","restriction":"String"}],"double_splat":null,"splat_index":null,"yields":1,"block_arg":{"name":"callback","doc":null,"default_value":"","external_name":"callback","restriction":"(Msg -> )"},"return_type":"","visibility":"Public","body":"sid = @gsid = @gsid + 1\n@out.synchronize do\n ((@buf << \"SUB \") << subject) << \" #{sid}\\r\\n\"\nend\nif @flush.empty?\n @flush.send(true)\nend\n(Subscription.new(sid, self, callback)).tap do |sub|\n @subs[sid] = sub\nend\n"}}],"macros":[],"types":[]},{"html_id":"github.com/nats-io/nats.cr/NATS/Msg","path":"NATS/Msg.html","kind":"class","full_name":"NATS::Msg","name":"Msg","abstract":false,"superclass":{"html_id":"github.com/nats-io/nats.cr/Reference","kind":"class","full_name":"Reference","name":"Reference"},"ancestors":[{"html_id":"github.com/nats-io/nats.cr/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"github.com/nats-io/nats.cr/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"nats/msg.cr","line_number":27,"url":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/msg.cr"}],"repository_name":"github.com/nats-io/nats.cr","program":false,"enum":false,"alias":false,"aliased":"","const":false,"constants":[],"included_modules":[],"extended_modules":[],"subclasses":[],"including_types":[],"namespace":{"html_id":"github.com/nats-io/nats.cr/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"A delivered message from a subscription.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc.subscribe(\"foo\") do |msg|\n puts \"Received '#{msg}'\"\n puts \"Subject is #{msg.subject}\"\n puts \"Reply Subject is #{msg.reply}\"\n puts \"Raw Data is #{msg.data}\"\nend\n```","summary":"

          A delivered message from a subscription.

          ","class_methods":[],"constructors":[],"instance_methods":[{"id":"data:Bytes-instance-method","html_id":"data:Bytes-instance-method","name":"data","doc":null,"summary":null,"abstract":false,"args":[],"args_string":" : Bytes","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/msg.cr#L32","def":{"name":"data","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"Bytes","visibility":"Public","body":"@data"}},{"id":"reply:String?-instance-method","html_id":"reply:String?-instance-method","name":"reply","doc":null,"summary":null,"abstract":false,"args":[],"args_string":" : String?","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/msg.cr#L31","def":{"name":"reply","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"String | ::Nil","visibility":"Public","body":"@reply"}},{"id":"respond(msg)-instance-method","html_id":"respond(msg)-instance-method","name":"respond","doc":"Allows a response to a request message to be easily sent.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nnc.subscribe(\"req\") do |msg|\n msg.respond(\"ANSWER is 42\")\nend\n```","summary":"

          Allows a response to a request message to be easily sent.

          ","abstract":false,"args":[{"name":"msg","doc":null,"default_value":"","external_name":"msg","restriction":""}],"args_string":"(msg)","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/msg.cr#L54","def":{"name":"respond","args":[{"name":"msg","doc":null,"default_value":"","external_name":"msg","restriction":""}],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"if @reply.nil?\n raise(\"No reply subject\")\nend\nif @conn.nil?\n raise(\"Not a received message\")\nend\n@conn.try(&.publish(@reply.to_s, msg))\n"}},{"id":"subject:String-instance-method","html_id":"subject:String-instance-method","name":"subject","doc":null,"summary":null,"abstract":false,"args":[],"args_string":" : String","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/msg.cr#L30","def":{"name":"subject","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"String","visibility":"Public","body":"@subject"}}],"macros":[],"types":[]},{"html_id":"github.com/nats-io/nats.cr/NATS/NUID","path":"NATS/NUID.html","kind":"class","full_name":"NATS::NUID","name":"NUID","abstract":false,"superclass":{"html_id":"github.com/nats-io/nats.cr/Reference","kind":"class","full_name":"Reference","name":"Reference"},"ancestors":[{"html_id":"github.com/nats-io/nats.cr/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"github.com/nats-io/nats.cr/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"nats/nuid.cr","line_number":21,"url":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/nuid.cr"}],"repository_name":"github.com/nats-io/nats.cr","program":false,"enum":false,"alias":false,"aliased":"","const":false,"constants":[{"id":"BASE","name":"BASE","value":"62","doc":null,"summary":null},{"id":"DIGITS","name":"DIGITS","value":"\"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\"","doc":null,"summary":null},{"id":"INC","name":"INC","value":"MAX_INC - MIN_INC","doc":null,"summary":null},{"id":"MAX_INC","name":"MAX_INC","value":"333_i64","doc":null,"summary":null},{"id":"MAX_SEQ","name":"MAX_SEQ","value":"839299365868340224_i64","doc":null,"summary":null},{"id":"MIN_INC","name":"MIN_INC","value":"33_i64","doc":null,"summary":null},{"id":"PREFIX_LENGTH","name":"PREFIX_LENGTH","value":"12","doc":null,"summary":null},{"id":"SEQ_LENGTH","name":"SEQ_LENGTH","value":"10","doc":null,"summary":null},{"id":"TOTAL_LENGTH","name":"TOTAL_LENGTH","value":"PREFIX_LENGTH + SEQ_LENGTH","doc":null,"summary":null}],"included_modules":[],"extended_modules":[],"subclasses":[],"including_types":[],"namespace":{"html_id":"github.com/nats-io/nats.cr/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":null,"summary":null,"class_methods":[],"constructors":[{"id":"new-class-method","html_id":"new-class-method","name":"new","doc":null,"summary":null,"abstract":false,"args":[],"args_string":"","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/nuid.cr#L32","def":{"name":"new","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"_ = allocate\n_.initialize\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"id":"next-instance-method","html_id":"next-instance-method","name":"next","doc":null,"summary":null,"abstract":false,"args":[],"args_string":"","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/nuid.cr#L38","def":{"name":"next","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"@seq = @seq + @inc\nif @seq >= MAX_SEQ\n reset!\nend\nl = @seq\ns_10 = DIGITS[l % BASE]\ns_09, s_08, s_07, s_06, s_05, s_04, s_03, s_02, s_01 = (l = l / BASE\nDIGITS[l % BASE]), (l = l / BASE\nDIGITS[l % BASE]), (l = l / BASE\nDIGITS[l % BASE]), (l = l / BASE\nDIGITS[l % BASE]), (l = l / BASE\nDIGITS[l % BASE]), (l = l / BASE\nDIGITS[l % BASE]), (l = l / BASE\nDIGITS[l % BASE]), (l = l / BASE\nDIGITS[l % BASE]), (l = l / BASE\nDIGITS[l % BASE])\n\"#{@prefix}#{s_01}#{s_02}#{s_03}#{s_04}#{s_05}#{s_06}#{s_07}#{s_08}#{s_09}#{s_10}\"\n"}},{"id":"randomize_prefix!-instance-method","html_id":"randomize_prefix!-instance-method","name":"randomize_prefix!","doc":null,"summary":null,"abstract":false,"args":[],"args_string":"","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/nuid.cr#L60","def":{"name":"randomize_prefix!","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"@prefix = String::Builder.build(PREFIX_LENGTH) do |io|\n Random::Secure.random_bytes(@pre_bytes)\n @pre_bytes.each do |n|\n io << \"#{DIGITS[n % BASE]}\"\n end\nend"}}],"macros":[],"types":[]},{"html_id":"github.com/nats-io/nats.cr/NATS/Subscription","path":"NATS/Subscription.html","kind":"class","full_name":"NATS::Subscription","name":"Subscription","abstract":false,"superclass":{"html_id":"github.com/nats-io/nats.cr/Reference","kind":"class","full_name":"Reference","name":"Reference"},"ancestors":[{"html_id":"github.com/nats-io/nats.cr/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"github.com/nats-io/nats.cr/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"nats/subscription.cr","line_number":24,"url":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/subscription.cr"}],"repository_name":"github.com/nats-io/nats.cr","program":false,"enum":false,"alias":false,"aliased":"","const":false,"constants":[],"included_modules":[],"extended_modules":[],"subclasses":[],"including_types":[],"namespace":{"html_id":"github.com/nats-io/nats.cr/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"A subscription to a given subject and possible queue group. Used to unsubscribe/close.\n\n```\nnc = NATS::Connection.new(\"demo.nats.io\")\nsub = nc.subscribe(\"foo\") { |msg| }\nsub.close\nsub.unsubscribe\n```","summary":"

          A subscription to a given subject and possible queue group.

          ","class_methods":[],"constructors":[],"instance_methods":[{"id":"close-instance-method","html_id":"close-instance-method","name":"close","doc":"Will unsubscribe from a subscription.","summary":"

          Will unsubscribe from a subscription.

          ","abstract":false,"args":[],"args_string":"","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/subscription.cr#L39","def":{"name":"close","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"unsubscribe"}},{"id":"closed?-instance-method","html_id":"closed?-instance-method","name":"closed?","doc":"Determines if the subscription is already closed.","summary":"

          Determines if the subscription is already closed.

          ","abstract":false,"args":[],"args_string":"","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/subscription.cr#L44","def":{"name":"closed?","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"return @msgs.closed?"}},{"id":"unsubscribe-instance-method","html_id":"unsubscribe-instance-method","name":"unsubscribe","doc":"Will unsubscribe from a subscription.","summary":"

          Will unsubscribe from a subscription.

          ","abstract":false,"args":[],"args_string":"","source_link":"https://github.com/nats-io/nats.cr/blob/ff8e1b336e5455c849a3ebea709b39d196a873bd/src/nats/subscription.cr#L31","def":{"name":"unsubscribe","args":[],"double_splat":null,"splat_index":null,"yields":null,"block_arg":null,"return_type":"","visibility":"Public","body":"if closed?\nelse\n @conn.unsubscribe(@sid)\n @msgs.close\nend"}}],"macros":[],"types":[]}]}]}}) \ No newline at end of file +crystal_doc_search_index_callback({"repository_name":"nats","body":"# NATS - Crystal Client\n\nSimple NATS client for the [Crystal](https://crystal-lang.org) programming language.\n\n[![License Apache 2](https://img.shields.io/badge/License-Apache2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)\n[![Build Status](https://travis-ci.org/nats-io/nats.cr.svg?branch=master)](http://travis-ci.org/nats-io/nats.cr)\n\n## Installation\n\n1. Add the dependency to your `shard.yml`:\n\n```yaml\n dependencies:\n nats:\n github: nats-io/nats.cr\n```\n\n2. Run `shards install`\n\n## Usage\n\n```crystal\nrequire \"nats/client\"\n\nclient = NATS::Client.new(\"nats://localhost:4222\")\nclient.connect\n\nclient.subscribe(\"foo\") do |msg|\n puts \"Received message on subject #{msg.subject}: #{msg.payload}\"\nend\n\nclient.publish(\"foo\", \"Hello, NATS!\")\n\nclient.subscribe(\"bar\") do |msg|\n msg.reply \"Received your message on bar: #{msg.payload}\"\nend\n\nresponse = client.request(\"bar\", \"Hello, bar!\")\nputs \"Received response: #{response.payload}\"\n\nclient.request(\"bar\") do |msg|\n puts \"Recieved async response: #{msg.payload}\"\nend\n\nclient.close\n```\n\n## License\n\nUnless otherwise noted, the NATS source files are distributed under\nthe Apache Version 2.0 license found in the LICENSE file.\n","program":{"html_id":"nats/toplevel","path":"toplevel.html","kind":"module","full_name":"Top Level Namespace","name":"Top Level Namespace","abstract":false,"locations":[],"repository_name":"nats","program":true,"enum":false,"alias":false,"const":false,"types":[{"html_id":"nats/NATS","path":"NATS.html","kind":"module","full_name":"NATS","name":"NATS","abstract":false,"locations":[{"filename":"src/nats.cr","line_number":3,"url":null},{"filename":"src/nats/client.cr","line_number":27,"url":null},{"filename":"src/nats/client/status.cr","line_number":15,"url":null},{"filename":"src/nats/errors.cr","line_number":15,"url":null},{"filename":"src/nats/message/connect.cr","line_number":15,"url":null},{"filename":"src/nats/message/info.cr","line_number":15,"url":null},{"filename":"src/nats/message/msg.cr","line_number":17,"url":null},{"filename":"src/nats/message/pub.cr","line_number":15,"url":null},{"filename":"src/nats/message/sub.cr","line_number":15,"url":null},{"filename":"src/nats/message/unsub.cr","line_number":15,"url":null},{"filename":"src/nats/nuid.cr","line_number":17,"url":null},{"filename":"src/nats/options.cr","line_number":15,"url":null},{"filename":"src/nats/subscription.cr","line_number":15,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"constants":[{"id":"VERSION","name":"VERSION","value":"{{ (`shards version /home/zbensley/Documents/git/nats.cr/src`).chomp.stringify }}"}],"class_methods":[{"html_id":"connect(uri:String|URI=Client::DEFAULT_URI):Client-class-method","name":"connect","doc":"Connects to a NATS server using the provided URI.\n\n*uri*: The URI of the NATS server to connect to.","summary":"

          Connects to a NATS server using the provided URI.

          ","abstract":false,"args":[{"name":"uri","default_value":"Client::DEFAULT_URI","external_name":"uri","restriction":"String | URI"}],"args_string":"(uri : String | URI = Client::DEFAULT_URI) : Client","args_html":"(uri : String | URI = Client::DEFAULT_URI) : Client","location":{"filename":"src/nats.cr","line_number":9,"url":null},"def":{"name":"connect","args":[{"name":"uri","default_value":"Client::DEFAULT_URI","external_name":"uri","restriction":"String | URI"}],"return_type":"Client","visibility":"Public","body":"(Client.new(uri)).connect"},"external_var":false}],"types":[{"html_id":"nats/NATS/AuthenticationError","path":"NATS/AuthenticationError.html","kind":"class","full_name":"NATS::AuthenticationError","name":"AuthenticationError","abstract":false,"superclass":{"html_id":"nats/NATS/ERRError","kind":"class","full_name":"NATS::ERRError","name":"ERRError"},"ancestors":[{"html_id":"nats/NATS/ERRError","kind":"class","full_name":"NATS::ERRError","name":"ERRError"},{"html_id":"nats/NATS/Error","kind":"class","full_name":"NATS::Error","name":"Error"},{"html_id":"nats/Exception","kind":"class","full_name":"Exception","name":"Exception"},{"html_id":"nats/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/errors.cr","line_number":43,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"nats/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"+AuthenticationError+ is raised when the NATS server indicates an authentication error.","summary":"

          +AuthenticationError+ is raised when the NATS server indicates an authentication error.

          ","constructors":[{"html_id":"new(msg=\"Authenticationfailed\")-class-method","name":"new","abstract":false,"args":[{"name":"msg","default_value":"\"Authentication failed\"","external_name":"msg","restriction":""}],"args_string":"(msg = \"Authentication failed\")","args_html":"(msg = "Authentication failed")","location":{"filename":"src/nats/errors.cr","line_number":44,"url":null},"def":{"name":"new","args":[{"name":"msg","default_value":"\"Authentication failed\"","external_name":"msg","restriction":""}],"visibility":"Public","body":"_ = allocate\n_.initialize(msg)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}]},{"html_id":"nats/NATS/Client","path":"NATS/Client.html","kind":"class","full_name":"NATS::Client","name":"Client","abstract":false,"superclass":{"html_id":"nats/Reference","kind":"class","full_name":"Reference","name":"Reference"},"ancestors":[{"html_id":"nats/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/client.cr","line_number":57,"url":null},{"filename":"src/nats/client/status.cr","line_number":16,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"constants":[{"id":"BUFFER_SIZE","name":"BUFFER_SIZE","value":"32768","doc":"Buffer Size for the socket","summary":"

          Buffer Size for the socket

          "},{"id":"DEFAULT_HOST","name":"DEFAULT_HOST","value":"\"localhost\"","doc":"Default Host for NATS Server","summary":"

          Default Host for NATS Server

          "},{"id":"DEFAULT_PORT","name":"DEFAULT_PORT","value":"4222","doc":"Default Port for NATS Server","summary":"

          Default Port for NATS Server

          "},{"id":"DEFAULT_URI","name":"DEFAULT_URI","value":"URI.parse(\"nats://#{DEFAULT_HOST}:#{DEFAULT_PORT}\")","doc":"Default URI for NATS Server","summary":"

          Default URI for NATS Server

          "}],"namespace":{"html_id":"nats/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"NATS Client for connecting to a NATS server.\\\nThis client allows you to subscribe and publish messages.\n\nExample:\n```\nrequire \"nats/client\"\n\nclient = NATS::Client.new(\"nats://localhost:4222\")\nclient.connect\n\nclient.subscribe(\"foo\") do |msg|\n puts \"Received message on subject #{msg.subject}: #{msg.payload}\"\nend\n\nclient.publish(\"foo\", \"Hello, NATS!\")\n\nclient.subscribe(\"bar\") do |msg|\n msg.reply \"Received your message on bar: #{msg.payload}\"\nend\n\nresponse = client.request(\"bar\", \"Hello, bar!\")\nputs \"Received response: #{response.payload}\"\n\nclient.request(\"bar\") do |msg|\n puts \"Recieved async response: #{msg.payload}\"\nend\n\nclient.close\n```","summary":"

          NATS Client for connecting to a NATS server.\\ This client allows you to subscribe and publish messages.

          ","constructors":[{"html_id":"new(uri:String|URI=DEFAULT_URI,options:Options=Options.new,user:String|Nil=nil,pass:String|Nil=nil,jwt:String|Nil=nil)-class-method","name":"new","abstract":false,"args":[{"name":"uri","default_value":"DEFAULT_URI","external_name":"uri","restriction":"String | URI"},{"name":"options","default_value":"Options.new","external_name":"options","restriction":"Options"},{"name":"user","default_value":"nil","external_name":"user","restriction":"String | ::Nil"},{"name":"pass","default_value":"nil","external_name":"pass","restriction":"String | ::Nil"},{"name":"jwt","default_value":"nil","external_name":"jwt","restriction":"String | ::Nil"}],"args_string":"(uri : String | URI = DEFAULT_URI, options : Options = Options.new, user : String | Nil = nil, pass : String | Nil = nil, jwt : String | Nil = nil)","args_html":"(uri : String | URI = DEFAULT_URI, options : Options = Options.new, user : String | Nil = nil, pass : String | Nil = nil, jwt : String | Nil = nil)","location":{"filename":"src/nats/client.cr","line_number":78,"url":null},"def":{"name":"new","args":[{"name":"uri","default_value":"DEFAULT_URI","external_name":"uri","restriction":"String | URI"},{"name":"options","default_value":"Options.new","external_name":"options","restriction":"Options"},{"name":"user","default_value":"nil","external_name":"user","restriction":"String | ::Nil"},{"name":"pass","default_value":"nil","external_name":"pass","restriction":"String | ::Nil"},{"name":"jwt","default_value":"nil","external_name":"jwt","restriction":"String | ::Nil"}],"visibility":"Public","body":"_ = allocate\n_.initialize(uri, options, user, pass, jwt)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}],"instance_methods":[{"html_id":"close-instance-method","name":"close","doc":"Closes the NATS connection and cleans up resources.","summary":"

          Closes the NATS connection and cleans up resources.

          ","abstract":false,"location":{"filename":"src/nats/client.cr","line_number":228,"url":null},"def":{"name":"close","visibility":"Public","body":"if status == Status::CLOSED\n return\nend\n\n\n@status = Status::DRAINING_SUBS\n@subs.each_value(&.unsubscribe)\n@subs.clear\n\n\n@socket_mutex.synchronize do\n @pongs.each(&.close)\n @pongs.clear\n\n if @socket.closed?\n else\n @status = Status::DRAINING_PUBS\n @socket.flush\n @socket.close\n end\n @status = Status::CLOSED\nend\n"},"external_var":false},{"html_id":"connect:self-instance-method","name":"connect","doc":"Connects to the NATS server","summary":"

          Connects to the NATS server

          ","abstract":false,"location":{"filename":"src/nats/client.cr","line_number":96,"url":null},"def":{"name":"connect","return_type":"self","visibility":"Public","body":"@status = Status::CONNECTING\nsetup_socket\n\n\nhandle_info(parse_info(@socket.read_line))\n\n\nsend_connect\nfirst_connection_ok?\n@status = Status::CONNECTED\n\n\nspawn(handle_messages)\n\nspawn(flush)\n\nself\n"},"external_var":false},{"html_id":"connected?:Bool-instance-method","name":"connected?","doc":"Checks if the client is connected to the NATS server.\\\nWill send a PING message and wait for a PONG response.","summary":"

          Checks if the client is connected to the NATS server.\\ Will send a PING message and wait for a PONG response.

          ","abstract":false,"location":{"filename":"src/nats/client.cr","line_number":252,"url":null},"def":{"name":"connected?","return_type":"Bool","visibility":"Public","body":"if status == Status::CLOSED\n return false\nend\n\nchannel = Channel(Nil).new\n@pongs.push(channel)\nsend_msg!(\"PING\")\nspawn do\n sleep(@options.timeout)\n channel.close\nend\nbegin\n channel.receive\nrescue\n {raise(TimeoutError.new(\"PING timeout\"))}\nend\ntrue\n"},"external_var":false},{"html_id":"publish(subject:String,payload:String)-instance-method","name":"publish","doc":"Publishes a message to the specified subject.\n\n*subject*: The subject to publish to.\\\n*payload*: The message payload.","summary":"

          Publishes a message to the specified subject.

          ","abstract":false,"args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"payload","external_name":"payload","restriction":"String"}],"args_string":"(subject : String, payload : String)","args_html":"(subject : String, payload : String)","location":{"filename":"src/nats/client.cr","line_number":158,"url":null},"def":{"name":"publish","args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"payload","external_name":"payload","restriction":"String"}],"visibility":"Public","body":"if status == Status::CLOSED\n raise(ClientClosedError.new)\nend\n\nmsg = Message::PUB.new(subject: subject, payload: payload)\nsend_msg!(msg.to_s)\n"},"external_var":false},{"html_id":"request(subject:String,payload:String,timeout:Time::Span|Nil=nil):Message::MSG-instance-method","name":"request","doc":"Publishes a message to the specified subject and waits for a response.\n\n*subject*: The subject to publish to.\\\n*payload*: The message payload.\\\n*timeout*: Optional timeout for waiting for a response. Will use `Options.timeout` if not set.","summary":"

          Publishes a message to the specified subject and waits for a response.

          ","abstract":false,"args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"payload","external_name":"payload","restriction":"String"},{"name":"timeout","default_value":"nil","external_name":"timeout","restriction":"Time::Span | ::Nil"}],"args_string":"(subject : String, payload : String, timeout : Time::Span | Nil = nil) : Message::MSG","args_html":"(subject : String, payload : String, timeout : Time::Span | Nil = nil) : Message::MSG","location":{"filename":"src/nats/client.cr","line_number":173,"url":null},"def":{"name":"request","args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"payload","external_name":"payload","restriction":"String"},{"name":"timeout","default_value":"nil","external_name":"timeout","restriction":"Time::Span | ::Nil"}],"return_type":"Message::MSG","visibility":"Public","body":"begin\n if status == Status::CLOSED\n raise(ClientClosedError.new)\n end\n\n msg = Message::PUB.new(subject: subject, reply_to: new_inbox, payload: payload)\n send_msg!(msg.to_s)\n channel = Channel(Message::MSG).new\n reply_sub = subscribe(msg.reply_to.to_s) do |response_msg|\n channel.send(response_msg)\n end\n spawn do\n sleep(timeout || @options.timeout)\n channel.close\n end\n\n begin\n channel.receive\n rescue\n raise(TimeoutError.new(\"Request Timeout\"))\n end\nensure\n if @subs.has_key?(reply_sub.try(&.sid))\n @subs[reply_sub.try(&.sid)].unsubscribe\n end\n if reply_sub.try(&.sid)\n @subs.delete(reply_sub.try(&.sid))\n end\nend"},"external_var":false},{"html_id":"request(subject:String,payload:String,&callback:Message::MSG->Nil)-instance-method","name":"request","doc":"Publishes a message to the specified subject and sends response to callback when available.\n\n*subject*: The subject to publish to.\\\n*payload*: The message payload.\\\n*callback*: Callback to handle the response message.","summary":"

          Publishes a message to the specified subject and sends response to callback when available.

          ","abstract":false,"args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"payload","external_name":"payload","restriction":"String"}],"args_string":"(subject : String, payload : String, &callback : Message::MSG -> Nil)","args_html":"(subject : String, payload : String, &callback : Message::MSG -> Nil)","location":{"filename":"src/nats/client.cr","line_number":206,"url":null},"def":{"name":"request","args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"payload","external_name":"payload","restriction":"String"}],"yields":1,"block_arity":1,"block_arg":{"name":"callback","external_name":"callback","restriction":"(Message::MSG -> Nil)"},"visibility":"Public","body":"if status == Status::CLOSED\n raise(ClientClosedError.new)\nend\n\nmsg = Message::PUB.new(subject: subject, reply_to: new_inbox, payload: payload)\nsend_msg(msg.to_s)\nspawn do\n begin\n channel = Channel(Message::MSG).new\n reply_sub = subscribe(msg.reply_to.to_s) do |response_msg|\n channel.send(response_msg)\n end\n callback.call(channel.receive)\n ensure\n if @subs.has_key?(reply_sub.try(&.sid))\n @subs[reply_sub.try(&.sid)].unsubscribe\n end\n if reply_sub.try(&.sid)\n @subs.delete(reply_sub.try(&.sid))\n end\n end\nend\n"},"external_var":false},{"html_id":"status:Status-instance-method","name":"status","doc":"The current status of the client connection.","summary":"

          The current status of the client connection.

          ","abstract":false,"location":{"filename":"src/nats/client.cr","line_number":68,"url":null},"def":{"name":"status","return_type":"Status","visibility":"Public","body":"@status"},"external_var":false},{"html_id":"subscribe(subject:String,queue_group:String|Nil=nil,&callback:Message::MSG->Nil):Subscription-instance-method","name":"subscribe","doc":"Subscribe to a subject, messages will be delivered to the provided callback.\n\n*subject*: The subject to subscribe to.\\\n*queue_group*: Optional queue group for load balancing.\\\n*callback*: The callback to handle incoming messages.","summary":"

          Subscribe to a subject, messages will be delivered to the provided callback.

          ","abstract":false,"args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"queue_group","default_value":"nil","external_name":"queue_group","restriction":"String | ::Nil"}],"args_string":"(subject : String, queue_group : String | Nil = nil, &callback : Message::MSG -> Nil) : Subscription","args_html":"(subject : String, queue_group : String | Nil = nil, &callback : Message::MSG -> Nil) : Subscription","location":{"filename":"src/nats/client.cr","line_number":121,"url":null},"def":{"name":"subscribe","args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"queue_group","default_value":"nil","external_name":"queue_group","restriction":"String | ::Nil"}],"yields":1,"block_arity":1,"block_arg":{"name":"callback","external_name":"callback","restriction":"(Message::MSG -> Nil)"},"return_type":"Subscription","visibility":"Public","body":"if status == Status::CLOSED\n raise(ClientClosedError.new)\nend\n\nsid = next_sid\nsub = Subscription.new(subject: subject, sid: sid, callback: callback, client: self, queue_group: queue_group)\n\nmsg = Message::SUB.new(subject: subject, queue_group: queue_group, sid: sid.to_s)\nsend_msg!(msg.to_s)\n@subs[sid] = sub\n"},"external_var":false},{"html_id":"unsubscribe(sub:Subscription)-instance-method","name":"unsubscribe","doc":"Unsubscribes from a subject.\n\n*sub*: The subscription to unsubscribe from.","summary":"

          Unsubscribes from a subject.

          ","abstract":false,"args":[{"name":"sub","external_name":"sub","restriction":"Subscription"}],"args_string":"(sub : Subscription)","args_html":"(sub : Subscription)","location":{"filename":"src/nats/client.cr","line_number":145,"url":null},"def":{"name":"unsubscribe","args":[{"name":"sub","external_name":"sub","restriction":"Subscription"}],"visibility":"Public","body":"if status == Status::CLOSED\n raise(ClientClosedError.new)\nend\n\nsid = sub.sid\nunsub = Message::UNSUB.new(sid: sid.to_s)\nsend_msg!(unsub.to_s)\n@subs.delete(sid)\n"},"external_var":false}],"types":[{"html_id":"nats/NATS/Client/Status","path":"NATS/Client/Status.html","kind":"enum","full_name":"NATS::Client::Status","name":"Status","abstract":false,"ancestors":[{"html_id":"nats/Enum","kind":"struct","full_name":"Enum","name":"Enum"},{"html_id":"nats/Comparable","kind":"module","full_name":"Comparable","name":"Comparable"},{"html_id":"nats/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/client/status.cr","line_number":17,"url":null}],"repository_name":"nats","program":false,"enum":true,"alias":false,"const":false,"constants":[{"id":"DISCONNECTED","name":"DISCONNECTED","value":"0","doc":"When the client is not actively connected.","summary":"

          When the client is not actively connected.

          "},{"id":"CONNECTED","name":"CONNECTED","value":"1","doc":"When the client is connected.","summary":"

          When the client is connected.

          "},{"id":"CLOSED","name":"CLOSED","value":"2","doc":"When the client will no longer attempt to connect to a NATS Server.","summary":"

          When the client will no longer attempt to connect to a NATS Server.

          "},{"id":"RECONNECTING","name":"RECONNECTING","value":"3","doc":"When the client has disconnected and is attempting to reconnect.","summary":"

          When the client has disconnected and is attempting to reconnect.

          "},{"id":"CONNECTING","name":"CONNECTING","value":"4","doc":"When the client is attempting to connect to a NATS Server for the first time.","summary":"

          When the client is attempting to connect to a NATS Server for the first time.

          "},{"id":"DRAINING_SUBS","name":"DRAINING_SUBS","value":"5","doc":"When the client is draining a connection before closing.","summary":"

          When the client is draining a connection before closing.

          "},{"id":"DRAINING_PUBS","name":"DRAINING_PUBS","value":"6","doc":"When the client is draining a connection before closing.","summary":"

          When the client is draining a connection before closing.

          "}],"namespace":{"html_id":"nats/NATS/Client","kind":"class","full_name":"NATS::Client","name":"Client"},"instance_methods":[{"html_id":"closed?-instance-method","name":"closed?","doc":"Returns `true` if this enum value equals `CLOSED`","summary":"

          Returns true if this enum value equals CLOSED

          ","abstract":false,"location":{"filename":"src/nats/client/status.cr","line_number":25,"url":null},"def":{"name":"closed?","visibility":"Public","body":"self == CLOSED"},"external_var":false},{"html_id":"connected?-instance-method","name":"connected?","doc":"Returns `true` if this enum value equals `CONNECTED`","summary":"

          Returns true if this enum value equals CONNECTED

          ","abstract":false,"location":{"filename":"src/nats/client/status.cr","line_number":22,"url":null},"def":{"name":"connected?","visibility":"Public","body":"self == CONNECTED"},"external_var":false},{"html_id":"connecting?-instance-method","name":"connecting?","doc":"Returns `true` if this enum value equals `CONNECTING`","summary":"

          Returns true if this enum value equals CONNECTING

          ","abstract":false,"location":{"filename":"src/nats/client/status.cr","line_number":31,"url":null},"def":{"name":"connecting?","visibility":"Public","body":"self == CONNECTING"},"external_var":false},{"html_id":"disconnected?-instance-method","name":"disconnected?","doc":"Returns `true` if this enum value equals `DISCONNECTED`","summary":"

          Returns true if this enum value equals DISCONNECTED

          ","abstract":false,"location":{"filename":"src/nats/client/status.cr","line_number":19,"url":null},"def":{"name":"disconnected?","visibility":"Public","body":"self == DISCONNECTED"},"external_var":false},{"html_id":"draining_pubs?-instance-method","name":"draining_pubs?","doc":"Returns `true` if this enum value equals `DRAINING_PUBS`","summary":"

          Returns true if this enum value equals DRAINING_PUBS

          ","abstract":false,"location":{"filename":"src/nats/client/status.cr","line_number":37,"url":null},"def":{"name":"draining_pubs?","visibility":"Public","body":"self == DRAINING_PUBS"},"external_var":false},{"html_id":"draining_subs?-instance-method","name":"draining_subs?","doc":"Returns `true` if this enum value equals `DRAINING_SUBS`","summary":"

          Returns true if this enum value equals DRAINING_SUBS

          ","abstract":false,"location":{"filename":"src/nats/client/status.cr","line_number":34,"url":null},"def":{"name":"draining_subs?","visibility":"Public","body":"self == DRAINING_SUBS"},"external_var":false},{"html_id":"reconnecting?-instance-method","name":"reconnecting?","doc":"Returns `true` if this enum value equals `RECONNECTING`","summary":"

          Returns true if this enum value equals RECONNECTING

          ","abstract":false,"location":{"filename":"src/nats/client/status.cr","line_number":28,"url":null},"def":{"name":"reconnecting?","visibility":"Public","body":"self == RECONNECTING"},"external_var":false}]}]},{"html_id":"nats/NATS/ClientClosedError","path":"NATS/ClientClosedError.html","kind":"class","full_name":"NATS::ClientClosedError","name":"ClientClosedError","abstract":false,"superclass":{"html_id":"nats/NATS/Error","kind":"class","full_name":"NATS::Error","name":"Error"},"ancestors":[{"html_id":"nats/NATS/Error","kind":"class","full_name":"NATS::Error","name":"Error"},{"html_id":"nats/Exception","kind":"class","full_name":"Exception","name":"Exception"},{"html_id":"nats/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/errors.cr","line_number":22,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"nats/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"+ClientClosed+ is raised when `NATS::Client.status == +NATS::Client::Status::CLOSED`\\\nUsually due to the socket being closed.","summary":"

          +ClientClosed+ is raised when NATS::Client.status == +NATS::Client::Status::CLOSED\\ Usually due to the socket being closed.

          ","constructors":[{"html_id":"new(msg=\"Clientisclosed\")-class-method","name":"new","abstract":false,"args":[{"name":"msg","default_value":"\"Client is closed\"","external_name":"msg","restriction":""}],"args_string":"(msg = \"Client is closed\")","args_html":"(msg = "Client is closed")","location":{"filename":"src/nats/errors.cr","line_number":23,"url":null},"def":{"name":"new","args":[{"name":"msg","default_value":"\"Client is closed\"","external_name":"msg","restriction":""}],"visibility":"Public","body":"_ = allocate\n_.initialize(msg)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}]},{"html_id":"nats/NATS/ERRError","path":"NATS/ERRError.html","kind":"class","full_name":"NATS::ERRError","name":"ERRError","abstract":false,"superclass":{"html_id":"nats/NATS/Error","kind":"class","full_name":"NATS::Error","name":"Error"},"ancestors":[{"html_id":"nats/NATS/Error","kind":"class","full_name":"NATS::Error","name":"Error"},{"html_id":"nats/Exception","kind":"class","full_name":"Exception","name":"Exception"},{"html_id":"nats/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/errors.cr","line_number":36,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"subclasses":[{"html_id":"nats/NATS/AuthenticationError","kind":"class","full_name":"NATS::AuthenticationError","name":"AuthenticationError"}],"namespace":{"html_id":"nats/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"+-ERR+ is raised when the NATS server indicates a protocol error.","summary":"

          +-ERR+ is raised when the NATS server indicates a protocol error.

          ","constructors":[{"html_id":"new(msg=\"Unknownerror\")-class-method","name":"new","abstract":false,"args":[{"name":"msg","default_value":"\"Unknown error\"","external_name":"msg","restriction":""}],"args_string":"(msg = \"Unknown error\")","args_html":"(msg = "Unknown error")","location":{"filename":"src/nats/errors.cr","line_number":37,"url":null},"def":{"name":"new","args":[{"name":"msg","default_value":"\"Unknown error\"","external_name":"msg","restriction":""}],"visibility":"Public","body":"_ = allocate\n_.initialize(msg)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}]},{"html_id":"nats/NATS/Error","path":"NATS/Error.html","kind":"class","full_name":"NATS::Error","name":"Error","abstract":false,"superclass":{"html_id":"nats/Exception","kind":"class","full_name":"Exception","name":"Exception"},"ancestors":[{"html_id":"nats/Exception","kind":"class","full_name":"Exception","name":"Exception"},{"html_id":"nats/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/errors.cr","line_number":17,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"subclasses":[{"html_id":"nats/NATS/ClientClosedError","kind":"class","full_name":"NATS::ClientClosedError","name":"ClientClosedError"},{"html_id":"nats/NATS/ERRError","kind":"class","full_name":"NATS::ERRError","name":"ERRError"},{"html_id":"nats/NATS/MSGError","kind":"class","full_name":"NATS::MSGError","name":"MSGError"},{"html_id":"nats/NATS/TimeoutError","kind":"class","full_name":"NATS::TimeoutError","name":"TimeoutError"}],"namespace":{"html_id":"nats/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"Generic NATS exception class.","summary":"

          Generic NATS exception class.

          "},{"html_id":"nats/NATS/Message","path":"NATS/Message.html","kind":"module","full_name":"NATS::Message","name":"Message","abstract":false,"locations":[{"filename":"src/nats/message/connect.cr","line_number":16,"url":null},{"filename":"src/nats/message/info.cr","line_number":16,"url":null},{"filename":"src/nats/message/msg.cr","line_number":18,"url":null},{"filename":"src/nats/message/pub.cr","line_number":16,"url":null},{"filename":"src/nats/message/sub.cr","line_number":16,"url":null},{"filename":"src/nats/message/unsub.cr","line_number":16,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"nats/NATS","kind":"module","full_name":"NATS","name":"NATS"},"types":[{"html_id":"nats/NATS/Message/CONNECT","path":"NATS/Message/CONNECT.html","kind":"struct","full_name":"NATS::Message::CONNECT","name":"CONNECT","abstract":false,"superclass":{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"nats/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"nats/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/message/connect.cr","line_number":24,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"nats/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"}],"namespace":{"html_id":"nats/NATS/Message","kind":"module","full_name":"NATS::Message","name":"Message"},"doc":"The CONNECT message is the client version of the INFO message.\\\nOnce the client has established a TCP/IP socket connection with the NATS server,\n and an INFO message has been received from the server,\n the client may send a CONNECT message to the NATS server to provide more\n information about the current connection as well as security information.\n\nSEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#connect","summary":"

          The CONNECT message is the client version of the INFO message.\\ Once the client has established a TCP/IP socket connection with the NATS server, and an INFO message has been received from the server, the client may send a CONNECT message to the NATS server to provide more information about the current connection as well as security information.

          ","constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/nats/message/connect.cr","line_number":69,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"},"external_var":false},{"html_id":"new-class-method","name":"new","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":66,"url":null},"def":{"name":"new","visibility":"Public","body":"_ = allocate\n_.initialize\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}],"instance_methods":[{"html_id":"auth_token:String|Nil-instance-method","name":"auth_token","doc":"Client authorization token.","summary":"

          Client authorization token.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":32,"url":null},"def":{"name":"auth_token","return_type":"String | ::Nil","visibility":"Public","body":"@auth_token"},"external_var":false},{"html_id":"auth_token=(auth_token:String|Nil)-instance-method","name":"auth_token=","doc":"Client authorization token.","summary":"

          Client authorization token.

          ","abstract":false,"args":[{"name":"auth_token","external_name":"auth_token","restriction":"String | ::Nil"}],"args_string":"(auth_token : String | Nil)","args_html":"(auth_token : String | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":32,"url":null},"def":{"name":"auth_token=","args":[{"name":"auth_token","external_name":"auth_token","restriction":"String | ::Nil"}],"visibility":"Public","body":"@auth_token = auth_token"},"external_var":false},{"html_id":"echo:Bool|Nil-instance-method","name":"echo","doc":"If set to false, the server (version 1.2.0+) will not send originating messages from this connection to its own subscriptions.\nClients should set this to false only for server supporting this feature,\n which is when proto in the INFO protocol is set to at least `1`.","summary":"

          If set to false, the server (version 1.2.0+) will not send originating messages from this connection to its own subscriptions.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":51,"url":null},"def":{"name":"echo","return_type":"Bool | ::Nil","visibility":"Public","body":"@echo"},"external_var":false},{"html_id":"echo=(echo:Bool|Nil)-instance-method","name":"echo=","doc":"If set to false, the server (version 1.2.0+) will not send originating messages from this connection to its own subscriptions.\nClients should set this to false only for server supporting this feature,\n which is when proto in the INFO protocol is set to at least `1`.","summary":"

          If set to false, the server (version 1.2.0+) will not send originating messages from this connection to its own subscriptions.

          ","abstract":false,"args":[{"name":"echo","external_name":"echo","restriction":"Bool | ::Nil"}],"args_string":"(echo : Bool | Nil)","args_html":"(echo : Bool | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":51,"url":null},"def":{"name":"echo=","args":[{"name":"echo","external_name":"echo","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@echo = echo"},"external_var":false},{"html_id":"headers:Bool|Nil-instance-method","name":"headers","doc":"Whether the client supports headers.\nTODO: Implement headers support","summary":"

          Whether the client supports headers.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":61,"url":null},"def":{"name":"headers","return_type":"Bool | ::Nil","visibility":"Public","body":"@headers"},"external_var":false},{"html_id":"headers=(headers:Bool|Nil)-instance-method","name":"headers=","doc":"Whether the client supports headers.\nTODO: Implement headers support","summary":"

          Whether the client supports headers.

          ","abstract":false,"args":[{"name":"headers","external_name":"headers","restriction":"Bool | ::Nil"}],"args_string":"(headers : Bool | Nil)","args_html":"(headers : Bool | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":61,"url":null},"def":{"name":"headers=","args":[{"name":"headers","external_name":"headers","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@headers = headers"},"external_var":false},{"html_id":"jwt:String|Nil-instance-method","name":"jwt","doc":"The JWT that identifies a user permissions and account.","summary":"

          The JWT that identifies a user permissions and account.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":56,"url":null},"def":{"name":"jwt","return_type":"String | ::Nil","visibility":"Public","body":"@jwt"},"external_var":false},{"html_id":"jwt=(jwt:String|Nil)-instance-method","name":"jwt=","doc":"The JWT that identifies a user permissions and account.","summary":"

          The JWT that identifies a user permissions and account.

          ","abstract":false,"args":[{"name":"jwt","external_name":"jwt","restriction":"String | ::Nil"}],"args_string":"(jwt : String | Nil)","args_html":"(jwt : String | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":56,"url":null},"def":{"name":"jwt=","args":[{"name":"jwt","external_name":"jwt","restriction":"String | ::Nil"}],"visibility":"Public","body":"@jwt = jwt"},"external_var":false},{"html_id":"lang:String|Nil-instance-method","name":"lang","doc":"The implementation language of the client.","summary":"

          The implementation language of the client.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":40,"url":null},"def":{"name":"lang","return_type":"String | ::Nil","visibility":"Public","body":"@lang"},"external_var":false},{"html_id":"lang=(lang:String|Nil)-instance-method","name":"lang=","doc":"The implementation language of the client.","summary":"

          The implementation language of the client.

          ","abstract":false,"args":[{"name":"lang","external_name":"lang","restriction":"String | ::Nil"}],"args_string":"(lang : String | Nil)","args_html":"(lang : String | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":40,"url":null},"def":{"name":"lang=","args":[{"name":"lang","external_name":"lang","restriction":"String | ::Nil"}],"visibility":"Public","body":"@lang = lang"},"external_var":false},{"html_id":"name:String|Nil-instance-method","name":"name","doc":"Client name.","summary":"

          Client name.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":38,"url":null},"def":{"name":"name","return_type":"String | ::Nil","visibility":"Public","body":"@name"},"external_var":false},{"html_id":"name=(name:String|Nil)-instance-method","name":"name=","doc":"Client name.","summary":"

          Client name.

          ","abstract":false,"args":[{"name":"name","external_name":"name","restriction":"String | ::Nil"}],"args_string":"(name : String | Nil)","args_html":"(name : String | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":38,"url":null},"def":{"name":"name=","args":[{"name":"name","external_name":"name","restriction":"String | ::Nil"}],"visibility":"Public","body":"@name = name"},"external_var":false},{"html_id":"nkey:String|Nil-instance-method","name":"nkey","doc":"The public NKey to authenticate the client.\nThis will be used to verify the signature (sig) against the nonce provided in the INFO message.","summary":"

          The public NKey to authenticate the client.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":64,"url":null},"def":{"name":"nkey","return_type":"String | ::Nil","visibility":"Public","body":"@nkey"},"external_var":false},{"html_id":"nkey=(nkey:String|Nil)-instance-method","name":"nkey=","doc":"The public NKey to authenticate the client.\nThis will be used to verify the signature (sig) against the nonce provided in the INFO message.","summary":"

          The public NKey to authenticate the client.

          ","abstract":false,"args":[{"name":"nkey","external_name":"nkey","restriction":"String | ::Nil"}],"args_string":"(nkey : String | Nil)","args_html":"(nkey : String | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":64,"url":null},"def":{"name":"nkey=","args":[{"name":"nkey","external_name":"nkey","restriction":"String | ::Nil"}],"visibility":"Public","body":"@nkey = nkey"},"external_var":false},{"html_id":"no_responders:Bool|Nil-instance-method","name":"no_responders","doc":"Enable quick replies for cases where a request is sent to a topic with no responders.","summary":"

          Enable quick replies for cases where a request is sent to a topic with no responders.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":58,"url":null},"def":{"name":"no_responders","return_type":"Bool | ::Nil","visibility":"Public","body":"@no_responders"},"external_var":false},{"html_id":"no_responders=(no_responders:Bool|Nil)-instance-method","name":"no_responders=","doc":"Enable quick replies for cases where a request is sent to a topic with no responders.","summary":"

          Enable quick replies for cases where a request is sent to a topic with no responders.

          ","abstract":false,"args":[{"name":"no_responders","external_name":"no_responders","restriction":"Bool | ::Nil"}],"args_string":"(no_responders : Bool | Nil)","args_html":"(no_responders : Bool | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":58,"url":null},"def":{"name":"no_responders=","args":[{"name":"no_responders","external_name":"no_responders","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@no_responders = no_responders"},"external_var":false},{"html_id":"pass:String|Nil-instance-method","name":"pass","doc":"Connection password.","summary":"

          Connection password.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":36,"url":null},"def":{"name":"pass","return_type":"String | ::Nil","visibility":"Public","body":"@pass"},"external_var":false},{"html_id":"pass=(pass:String|Nil)-instance-method","name":"pass=","doc":"Connection password.","summary":"

          Connection password.

          ","abstract":false,"args":[{"name":"pass","external_name":"pass","restriction":"String | ::Nil"}],"args_string":"(pass : String | Nil)","args_html":"(pass : String | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":36,"url":null},"def":{"name":"pass=","args":[{"name":"pass","external_name":"pass","restriction":"String | ::Nil"}],"visibility":"Public","body":"@pass = pass"},"external_var":false},{"html_id":"pedantic:Bool|Nil-instance-method","name":"pedantic","doc":"Turns on additional strict format checking, e.g. for properly formed subjects.","summary":"

          Turns on additional strict format checking, e.g.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":28,"url":null},"def":{"name":"pedantic","return_type":"Bool | ::Nil","visibility":"Public","body":"@pedantic"},"external_var":false},{"html_id":"pedantic=(pedantic:Bool|Nil)-instance-method","name":"pedantic=","doc":"Turns on additional strict format checking, e.g. for properly formed subjects.","summary":"

          Turns on additional strict format checking, e.g.

          ","abstract":false,"args":[{"name":"pedantic","external_name":"pedantic","restriction":"Bool | ::Nil"}],"args_string":"(pedantic : Bool | Nil)","args_html":"(pedantic : Bool | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":28,"url":null},"def":{"name":"pedantic=","args":[{"name":"pedantic","external_name":"pedantic","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@pedantic = pedantic"},"external_var":false},{"html_id":"protocol:Int32|Nil-instance-method","name":"protocol","doc":"Sending `0` (or absent) indicates client supports original protocol.\nSending `1` indicates that the client supports dynamic reconfiguration\n of cluster topology changes by asynchronously receiving INFO messages with known servers it can reconnect to.\nTODO: Support dynamic reconfiguration in the future","summary":"

          Sending 0 (or absent) indicates client supports original protocol.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":47,"url":null},"def":{"name":"protocol","return_type":"Int32 | ::Nil","visibility":"Public","body":"@protocol"},"external_var":false},{"html_id":"protocol=(protocol:Int32|Nil)-instance-method","name":"protocol=","doc":"Sending `0` (or absent) indicates client supports original protocol.\nSending `1` indicates that the client supports dynamic reconfiguration\n of cluster topology changes by asynchronously receiving INFO messages with known servers it can reconnect to.\nTODO: Support dynamic reconfiguration in the future","summary":"

          Sending 0 (or absent) indicates client supports original protocol.

          ","abstract":false,"args":[{"name":"protocol","external_name":"protocol","restriction":"Int32 | ::Nil"}],"args_string":"(protocol : Int32 | Nil)","args_html":"(protocol : Int32 | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":47,"url":null},"def":{"name":"protocol=","args":[{"name":"protocol","external_name":"protocol","restriction":"Int32 | ::Nil"}],"visibility":"Public","body":"@protocol = protocol"},"external_var":false},{"html_id":"sig:String|Nil-instance-method","name":"sig","doc":"In case the server has responded with a nonce on INFO,\n then a NATS client must use this field to reply with the signed nonce.","summary":"

          In case the server has responded with a nonce on INFO, then a NATS client must use this field to reply with the signed nonce.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":54,"url":null},"def":{"name":"sig","return_type":"String | ::Nil","visibility":"Public","body":"@sig"},"external_var":false},{"html_id":"sig=(sig:String|Nil)-instance-method","name":"sig=","doc":"In case the server has responded with a nonce on INFO,\n then a NATS client must use this field to reply with the signed nonce.","summary":"

          In case the server has responded with a nonce on INFO, then a NATS client must use this field to reply with the signed nonce.

          ","abstract":false,"args":[{"name":"sig","external_name":"sig","restriction":"String | ::Nil"}],"args_string":"(sig : String | Nil)","args_html":"(sig : String | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":54,"url":null},"def":{"name":"sig=","args":[{"name":"sig","external_name":"sig","restriction":"String | ::Nil"}],"visibility":"Public","body":"@sig = sig"},"external_var":false},{"html_id":"tls_required:Bool|Nil-instance-method","name":"tls_required","doc":"Indicates whether the client requires an SSL connection.","summary":"

          Indicates whether the client requires an SSL connection.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":30,"url":null},"def":{"name":"tls_required","return_type":"Bool | ::Nil","visibility":"Public","body":"@tls_required"},"external_var":false},{"html_id":"tls_required=(tls_required:Bool|Nil)-instance-method","name":"tls_required=","doc":"Indicates whether the client requires an SSL connection.","summary":"

          Indicates whether the client requires an SSL connection.

          ","abstract":false,"args":[{"name":"tls_required","external_name":"tls_required","restriction":"Bool | ::Nil"}],"args_string":"(tls_required : Bool | Nil)","args_html":"(tls_required : Bool | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":30,"url":null},"def":{"name":"tls_required=","args":[{"name":"tls_required","external_name":"tls_required","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@tls_required = tls_required"},"external_var":false},{"html_id":"to_s-instance-method","name":"to_s","doc":"Returns a nicely readable and concise string representation of this object,\ntypically intended for users.\n\nThis method should usually **not** be overridden. It delegates to\n`#to_s(IO)` which can be overridden for custom implementations.\n\nAlso see `#inspect`.","summary":"

          Returns a nicely readable and concise string representation of this object, typically intended for users.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":71,"url":null},"def":{"name":"to_s","visibility":"Public","body":"\"CONNECT #{to_json}\""},"external_var":false},{"html_id":"user:String|Nil-instance-method","name":"user","doc":"Connection username.","summary":"

          Connection username.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":34,"url":null},"def":{"name":"user","return_type":"String | ::Nil","visibility":"Public","body":"@user"},"external_var":false},{"html_id":"user=(user:String|Nil)-instance-method","name":"user=","doc":"Connection username.","summary":"

          Connection username.

          ","abstract":false,"args":[{"name":"user","external_name":"user","restriction":"String | ::Nil"}],"args_string":"(user : String | Nil)","args_html":"(user : String | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":34,"url":null},"def":{"name":"user=","args":[{"name":"user","external_name":"user","restriction":"String | ::Nil"}],"visibility":"Public","body":"@user = user"},"external_var":false},{"html_id":"verbose:Bool|Nil-instance-method","name":"verbose","doc":"Turns on +OK protocol acknowledgements.","summary":"

          Turns on +OK protocol acknowledgements.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":26,"url":null},"def":{"name":"verbose","return_type":"Bool | ::Nil","visibility":"Public","body":"@verbose"},"external_var":false},{"html_id":"verbose=(verbose:Bool|Nil)-instance-method","name":"verbose=","doc":"Turns on +OK protocol acknowledgements.","summary":"

          Turns on +OK protocol acknowledgements.

          ","abstract":false,"args":[{"name":"verbose","external_name":"verbose","restriction":"Bool | ::Nil"}],"args_string":"(verbose : Bool | Nil)","args_html":"(verbose : Bool | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":26,"url":null},"def":{"name":"verbose=","args":[{"name":"verbose","external_name":"verbose","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@verbose = verbose"},"external_var":false},{"html_id":"version:String|Nil-instance-method","name":"version","doc":"The version of the client.","summary":"

          The version of the client.

          ","abstract":false,"location":{"filename":"src/nats/message/connect.cr","line_number":42,"url":null},"def":{"name":"version","return_type":"String | ::Nil","visibility":"Public","body":"@version"},"external_var":false},{"html_id":"version=(version:String|Nil)-instance-method","name":"version=","doc":"The version of the client.","summary":"

          The version of the client.

          ","abstract":false,"args":[{"name":"version","external_name":"version","restriction":"String | ::Nil"}],"args_string":"(version : String | Nil)","args_html":"(version : String | Nil)","location":{"filename":"src/nats/message/connect.cr","line_number":42,"url":null},"def":{"name":"version=","args":[{"name":"version","external_name":"version","restriction":"String | ::Nil"}],"visibility":"Public","body":"@version = version"},"external_var":false}]},{"html_id":"nats/NATS/Message/INFO","path":"NATS/Message/INFO.html","kind":"struct","full_name":"NATS::Message::INFO","name":"INFO","abstract":false,"superclass":{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"nats/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"},{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"nats/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/message/info.cr","line_number":27,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"included_modules":[{"html_id":"nats/JSON/Serializable","kind":"module","full_name":"JSON::Serializable","name":"Serializable"}],"namespace":{"html_id":"nats/NATS/Message","kind":"module","full_name":"NATS::Message","name":"Message"},"doc":"A client will need to start as a plain TCP connection,\n then when the server accepts a connection from the client,\n it will send information about itself,\n the configuration and security requirements necessary for the client to successfully authenticate with the server and exchange messages.\n\nWhen using the updated client protocol (see `CONNECT`),\n INFO messages can be sent anytime by the server.\n This means clients with that protocol level need to be able to asynchronously handle INFO messages.\n\nSEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#info","summary":"

          A client will need to start as a plain TCP connection, then when the server accepts a connection from the client, it will send information about itself, the configuration and security requirements necessary for the client to successfully authenticate with the server and exchange messages.

          ","constructors":[{"html_id":"new(pull:JSON::PullParser)-class-method","name":"new","abstract":false,"args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"args_string":"(pull : JSON::PullParser)","args_html":"(pull : JSON::PullParser)","location":{"filename":"src/nats/message/info.cr","line_number":28,"url":null},"def":{"name":"new","args":[{"name":"pull","external_name":"pull","restriction":"::JSON::PullParser"}],"visibility":"Public","body":"new_from_json_pull_parser(pull)"},"external_var":false}],"instance_methods":[{"html_id":"auth_required:Bool|Nil-instance-method","name":"auth_required","doc":"If this is true, then the client should try to authenticate upon connect.","summary":"

          If this is true, then the client should try to authenticate upon connect.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":53,"url":null},"def":{"name":"auth_required","return_type":"Bool | ::Nil","visibility":"Public","body":"@auth_required"},"external_var":false},{"html_id":"auth_required=(auth_required:Bool|Nil)-instance-method","name":"auth_required=","doc":"If this is true, then the client should try to authenticate upon connect.","summary":"

          If this is true, then the client should try to authenticate upon connect.

          ","abstract":false,"args":[{"name":"auth_required","external_name":"auth_required","restriction":"Bool | ::Nil"}],"args_string":"(auth_required : Bool | Nil)","args_html":"(auth_required : Bool | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":53,"url":null},"def":{"name":"auth_required=","args":[{"name":"auth_required","external_name":"auth_required","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@auth_required = auth_required"},"external_var":false},{"html_id":"client_id:UInt64|Nil-instance-method","name":"client_id","doc":"The internal client identifier in the server.\nThis can be used to filter client connections in monitoring, correlate with error logs, etc...","summary":"

          The internal client identifier in the server.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":51,"url":null},"def":{"name":"client_id","return_type":"UInt64 | ::Nil","visibility":"Public","body":"@client_id"},"external_var":false},{"html_id":"client_id=(client_id:UInt64|Nil)-instance-method","name":"client_id=","doc":"The internal client identifier in the server.\nThis can be used to filter client connections in monitoring, correlate with error logs, etc...","summary":"

          The internal client identifier in the server.

          ","abstract":false,"args":[{"name":"client_id","external_name":"client_id","restriction":"UInt64 | ::Nil"}],"args_string":"(client_id : UInt64 | Nil)","args_html":"(client_id : UInt64 | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":51,"url":null},"def":{"name":"client_id=","args":[{"name":"client_id","external_name":"client_id","restriction":"UInt64 | ::Nil"}],"visibility":"Public","body":"@client_id = client_id"},"external_var":false},{"html_id":"client_ip:String|Nil-instance-method","name":"client_ip","doc":"The IP of the client.","summary":"

          The IP of the client.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":74,"url":null},"def":{"name":"client_ip","return_type":"String | ::Nil","visibility":"Public","body":"@client_ip"},"external_var":false},{"html_id":"client_ip=(client_ip:String|Nil)-instance-method","name":"client_ip=","doc":"The IP of the client.","summary":"

          The IP of the client.

          ","abstract":false,"args":[{"name":"client_ip","external_name":"client_ip","restriction":"String | ::Nil"}],"args_string":"(client_ip : String | Nil)","args_html":"(client_ip : String | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":74,"url":null},"def":{"name":"client_ip=","args":[{"name":"client_ip","external_name":"client_ip","restriction":"String | ::Nil"}],"visibility":"Public","body":"@client_ip = client_ip"},"external_var":false},{"html_id":"cluster:String|Nil-instance-method","name":"cluster","doc":"The name of the cluster.","summary":"

          The name of the cluster.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":78,"url":null},"def":{"name":"cluster","return_type":"String | ::Nil","visibility":"Public","body":"@cluster"},"external_var":false},{"html_id":"cluster=(cluster:String|Nil)-instance-method","name":"cluster=","doc":"The name of the cluster.","summary":"

          The name of the cluster.

          ","abstract":false,"args":[{"name":"cluster","external_name":"cluster","restriction":"String | ::Nil"}],"args_string":"(cluster : String | Nil)","args_html":"(cluster : String | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":78,"url":null},"def":{"name":"cluster=","args":[{"name":"cluster","external_name":"cluster","restriction":"String | ::Nil"}],"visibility":"Public","body":"@cluster = cluster"},"external_var":false},{"html_id":"connect_urls:Array(String)|Nil-instance-method","name":"connect_urls","doc":"List of server urls that a client can connect to.","summary":"

          List of server urls that a client can connect to.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":62,"url":null},"def":{"name":"connect_urls","return_type":"Array(String) | ::Nil","visibility":"Public","body":"@connect_urls"},"external_var":false},{"html_id":"connect_urls=(connect_urls:Array(String)|Nil)-instance-method","name":"connect_urls=","doc":"List of server urls that a client can connect to.","summary":"

          List of server urls that a client can connect to.

          ","abstract":false,"args":[{"name":"connect_urls","external_name":"connect_urls","restriction":"Array(String) | ::Nil"}],"args_string":"(connect_urls : Array(String) | Nil)","args_html":"(connect_urls : Array(String) | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":62,"url":null},"def":{"name":"connect_urls=","args":[{"name":"connect_urls","external_name":"connect_urls","restriction":"Array(String) | ::Nil"}],"visibility":"Public","body":"@connect_urls = connect_urls"},"external_var":false},{"html_id":"domain:String|Nil-instance-method","name":"domain","doc":"The configured NATS domain of the server.","summary":"

          The configured NATS domain of the server.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":80,"url":null},"def":{"name":"domain","return_type":"String | ::Nil","visibility":"Public","body":"@domain"},"external_var":false},{"html_id":"domain=(domain:String|Nil)-instance-method","name":"domain=","doc":"The configured NATS domain of the server.","summary":"

          The configured NATS domain of the server.

          ","abstract":false,"args":[{"name":"domain","external_name":"domain","restriction":"String | ::Nil"}],"args_string":"(domain : String | Nil)","args_html":"(domain : String | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":80,"url":null},"def":{"name":"domain=","args":[{"name":"domain","external_name":"domain","restriction":"String | ::Nil"}],"visibility":"Public","body":"@domain = domain"},"external_var":false},{"html_id":"git_commit:String|Nil-instance-method","name":"git_commit","doc":"The git hash at which the NATS server was built.","summary":"

          The git hash at which the NATS server was built.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":68,"url":null},"def":{"name":"git_commit","return_type":"String | ::Nil","visibility":"Public","body":"@git_commit"},"external_var":false},{"html_id":"git_commit=(git_commit:String|Nil)-instance-method","name":"git_commit=","doc":"The git hash at which the NATS server was built.","summary":"

          The git hash at which the NATS server was built.

          ","abstract":false,"args":[{"name":"git_commit","external_name":"git_commit","restriction":"String | ::Nil"}],"args_string":"(git_commit : String | Nil)","args_html":"(git_commit : String | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":68,"url":null},"def":{"name":"git_commit=","args":[{"name":"git_commit","external_name":"git_commit","restriction":"String | ::Nil"}],"visibility":"Public","body":"@git_commit = git_commit"},"external_var":false},{"html_id":"go:String-instance-method","name":"go","doc":"The version of golang the NATS server was built with.","summary":"

          The version of golang the NATS server was built with.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":37,"url":null},"def":{"name":"go","return_type":"String","visibility":"Public","body":"@go"},"external_var":false},{"html_id":"go=(go:String)-instance-method","name":"go=","doc":"The version of golang the NATS server was built with.","summary":"

          The version of golang the NATS server was built with.

          ","abstract":false,"args":[{"name":"go","external_name":"go","restriction":"String"}],"args_string":"(go : String)","args_html":"(go : String)","location":{"filename":"src/nats/message/info.cr","line_number":37,"url":null},"def":{"name":"go=","args":[{"name":"go","external_name":"go","restriction":"String"}],"visibility":"Public","body":"@go = go"},"external_var":false},{"html_id":"headers:Bool-instance-method","name":"headers","doc":"Whether the server supports headers.","summary":"

          Whether the server supports headers.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":43,"url":null},"def":{"name":"headers","return_type":"Bool","visibility":"Public","body":"@headers"},"external_var":false},{"html_id":"headers=(headers:Bool)-instance-method","name":"headers=","doc":"Whether the server supports headers.","summary":"

          Whether the server supports headers.

          ","abstract":false,"args":[{"name":"headers","external_name":"headers","restriction":"Bool"}],"args_string":"(headers : Bool)","args_html":"(headers : Bool)","location":{"filename":"src/nats/message/info.cr","line_number":43,"url":null},"def":{"name":"headers=","args":[{"name":"headers","external_name":"headers","restriction":"Bool"}],"visibility":"Public","body":"@headers = headers"},"external_var":false},{"html_id":"host:String-instance-method","name":"host","doc":"The IP address used to start the NATS server, by default this will be 0.0.0.0 and can be configured with -client_advertise host:port.","summary":"

          The IP address used to start the NATS server, by default this will be 0.0.0.0 and can be configured with -client_advertise host:port.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":39,"url":null},"def":{"name":"host","return_type":"String","visibility":"Public","body":"@host"},"external_var":false},{"html_id":"host=(host:String)-instance-method","name":"host=","doc":"The IP address used to start the NATS server, by default this will be 0.0.0.0 and can be configured with -client_advertise host:port.","summary":"

          The IP address used to start the NATS server, by default this will be 0.0.0.0 and can be configured with -client_advertise host:port.

          ","abstract":false,"args":[{"name":"host","external_name":"host","restriction":"String"}],"args_string":"(host : String)","args_html":"(host : String)","location":{"filename":"src/nats/message/info.cr","line_number":39,"url":null},"def":{"name":"host=","args":[{"name":"host","external_name":"host","restriction":"String"}],"visibility":"Public","body":"@host = host"},"external_var":false},{"html_id":"ip:String|Nil-instance-method","name":"ip","doc":"The IP of the server.","summary":"

          The IP of the server.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":72,"url":null},"def":{"name":"ip","return_type":"String | ::Nil","visibility":"Public","body":"@ip"},"external_var":false},{"html_id":"ip=(ip:String|Nil)-instance-method","name":"ip=","doc":"The IP of the server.","summary":"

          The IP of the server.

          ","abstract":false,"args":[{"name":"ip","external_name":"ip","restriction":"String | ::Nil"}],"args_string":"(ip : String | Nil)","args_html":"(ip : String | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":72,"url":null},"def":{"name":"ip=","args":[{"name":"ip","external_name":"ip","restriction":"String | ::Nil"}],"visibility":"Public","body":"@ip = ip"},"external_var":false},{"html_id":"jetstream:Bool|Nil-instance-method","name":"jetstream","doc":"Whether the server supports JetStream.","summary":"

          Whether the server supports JetStream.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":70,"url":null},"def":{"name":"jetstream","return_type":"Bool | ::Nil","visibility":"Public","body":"@jetstream"},"external_var":false},{"html_id":"jetstream=(jetstream:Bool|Nil)-instance-method","name":"jetstream=","doc":"Whether the server supports JetStream.","summary":"

          Whether the server supports JetStream.

          ","abstract":false,"args":[{"name":"jetstream","external_name":"jetstream","restriction":"Bool | ::Nil"}],"args_string":"(jetstream : Bool | Nil)","args_html":"(jetstream : Bool | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":70,"url":null},"def":{"name":"jetstream=","args":[{"name":"jetstream","external_name":"jetstream","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@jetstream = jetstream"},"external_var":false},{"html_id":"ldm:Bool|Nil-instance-method","name":"ldm","doc":"If the server supports Lame Duck Mode notifications, and the current server has transitioned to lame duck, ldm will be set to true.","summary":"

          If the server supports Lame Duck Mode notifications, and the current server has transitioned to lame duck, ldm will be set to true.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":66,"url":null},"def":{"name":"ldm","return_type":"Bool | ::Nil","visibility":"Public","body":"@ldm"},"external_var":false},{"html_id":"ldm=(ldm:Bool|Nil)-instance-method","name":"ldm=","doc":"If the server supports Lame Duck Mode notifications, and the current server has transitioned to lame duck, ldm will be set to true.","summary":"

          If the server supports Lame Duck Mode notifications, and the current server has transitioned to lame duck, ldm will be set to true.

          ","abstract":false,"args":[{"name":"ldm","external_name":"ldm","restriction":"Bool | ::Nil"}],"args_string":"(ldm : Bool | Nil)","args_html":"(ldm : Bool | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":66,"url":null},"def":{"name":"ldm=","args":[{"name":"ldm","external_name":"ldm","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@ldm = ldm"},"external_var":false},{"html_id":"max_payload:Int32-instance-method","name":"max_payload","doc":"Maximum payload size, in bytes, that the server will accept from the client.","summary":"

          Maximum payload size, in bytes, that the server will accept from the client.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":45,"url":null},"def":{"name":"max_payload","return_type":"Int32","visibility":"Public","body":"@max_payload"},"external_var":false},{"html_id":"max_payload=(max_payload:Int32)-instance-method","name":"max_payload=","doc":"Maximum payload size, in bytes, that the server will accept from the client.","summary":"

          Maximum payload size, in bytes, that the server will accept from the client.

          ","abstract":false,"args":[{"name":"max_payload","external_name":"max_payload","restriction":"Int32"}],"args_string":"(max_payload : Int32)","args_html":"(max_payload : Int32)","location":{"filename":"src/nats/message/info.cr","line_number":45,"url":null},"def":{"name":"max_payload=","args":[{"name":"max_payload","external_name":"max_payload","restriction":"Int32"}],"visibility":"Public","body":"@max_payload = max_payload"},"external_var":false},{"html_id":"nonce:String|Nil-instance-method","name":"nonce","doc":"The nonce for use in CONNECT.","summary":"

          The nonce for use in CONNECT.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":76,"url":null},"def":{"name":"nonce","return_type":"String | ::Nil","visibility":"Public","body":"@nonce"},"external_var":false},{"html_id":"nonce=(nonce:String|Nil)-instance-method","name":"nonce=","doc":"The nonce for use in CONNECT.","summary":"

          The nonce for use in CONNECT.

          ","abstract":false,"args":[{"name":"nonce","external_name":"nonce","restriction":"String | ::Nil"}],"args_string":"(nonce : String | Nil)","args_html":"(nonce : String | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":76,"url":null},"def":{"name":"nonce=","args":[{"name":"nonce","external_name":"nonce","restriction":"String | ::Nil"}],"visibility":"Public","body":"@nonce = nonce"},"external_var":false},{"html_id":"port:Int32-instance-method","name":"port","doc":"The port number the NATS server is configured to listen on.","summary":"

          The port number the NATS server is configured to listen on.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":41,"url":null},"def":{"name":"port","return_type":"Int32","visibility":"Public","body":"@port"},"external_var":false},{"html_id":"port=(port:Int32)-instance-method","name":"port=","doc":"The port number the NATS server is configured to listen on.","summary":"

          The port number the NATS server is configured to listen on.

          ","abstract":false,"args":[{"name":"port","external_name":"port","restriction":"Int32"}],"args_string":"(port : Int32)","args_html":"(port : Int32)","location":{"filename":"src/nats/message/info.cr","line_number":41,"url":null},"def":{"name":"port=","args":[{"name":"port","external_name":"port","restriction":"Int32"}],"visibility":"Public","body":"@port = port"},"external_var":false},{"html_id":"proto:Int32-instance-method","name":"proto","doc":"An integer indicating the protocol version of the server.\nThe server version 1.2.0 sets this to `1` to indicate that it supports the \"Echo\" feature.","summary":"

          An integer indicating the protocol version of the server.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":48,"url":null},"def":{"name":"proto","return_type":"Int32","visibility":"Public","body":"@proto"},"external_var":false},{"html_id":"proto=(proto:Int32)-instance-method","name":"proto=","doc":"An integer indicating the protocol version of the server.\nThe server version 1.2.0 sets this to `1` to indicate that it supports the \"Echo\" feature.","summary":"

          An integer indicating the protocol version of the server.

          ","abstract":false,"args":[{"name":"proto","external_name":"proto","restriction":"Int32"}],"args_string":"(proto : Int32)","args_html":"(proto : Int32)","location":{"filename":"src/nats/message/info.cr","line_number":48,"url":null},"def":{"name":"proto=","args":[{"name":"proto","external_name":"proto","restriction":"Int32"}],"visibility":"Public","body":"@proto = proto"},"external_var":false},{"html_id":"server_id:String-instance-method","name":"server_id","doc":"The unique identifier of the NATS server.","summary":"

          The unique identifier of the NATS server.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":31,"url":null},"def":{"name":"server_id","return_type":"String","visibility":"Public","body":"@server_id"},"external_var":false},{"html_id":"server_id=(server_id:String)-instance-method","name":"server_id=","doc":"The unique identifier of the NATS server.","summary":"

          The unique identifier of the NATS server.

          ","abstract":false,"args":[{"name":"server_id","external_name":"server_id","restriction":"String"}],"args_string":"(server_id : String)","args_html":"(server_id : String)","location":{"filename":"src/nats/message/info.cr","line_number":31,"url":null},"def":{"name":"server_id=","args":[{"name":"server_id","external_name":"server_id","restriction":"String"}],"visibility":"Public","body":"@server_id = server_id"},"external_var":false},{"html_id":"server_name:String-instance-method","name":"server_name","doc":"The name of the NATS server.","summary":"

          The name of the NATS server.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":33,"url":null},"def":{"name":"server_name","return_type":"String","visibility":"Public","body":"@server_name"},"external_var":false},{"html_id":"server_name=(server_name:String)-instance-method","name":"server_name=","doc":"The name of the NATS server.","summary":"

          The name of the NATS server.

          ","abstract":false,"args":[{"name":"server_name","external_name":"server_name","restriction":"String"}],"args_string":"(server_name : String)","args_html":"(server_name : String)","location":{"filename":"src/nats/message/info.cr","line_number":33,"url":null},"def":{"name":"server_name=","args":[{"name":"server_name","external_name":"server_name","restriction":"String"}],"visibility":"Public","body":"@server_name = server_name"},"external_var":false},{"html_id":"tls_available:Bool|Nil-instance-method","name":"tls_available","doc":"If this is true, the client can provide a valid certificate during the TLS handshake.","summary":"

          If this is true, the client can provide a valid certificate during the TLS handshake.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":60,"url":null},"def":{"name":"tls_available","return_type":"Bool | ::Nil","visibility":"Public","body":"@tls_available"},"external_var":false},{"html_id":"tls_available=(tls_available:Bool|Nil)-instance-method","name":"tls_available=","doc":"If this is true, the client can provide a valid certificate during the TLS handshake.","summary":"

          If this is true, the client can provide a valid certificate during the TLS handshake.

          ","abstract":false,"args":[{"name":"tls_available","external_name":"tls_available","restriction":"Bool | ::Nil"}],"args_string":"(tls_available : Bool | Nil)","args_html":"(tls_available : Bool | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":60,"url":null},"def":{"name":"tls_available=","args":[{"name":"tls_available","external_name":"tls_available","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@tls_available = tls_available"},"external_var":false},{"html_id":"tls_required:Bool|Nil-instance-method","name":"tls_required","doc":"If this is true, then the client must perform the TLS/1.2 handshake.\nNote, this used to be ssl_required and has been updated along with the protocol from SSL to TLS.","summary":"

          If this is true, then the client must perform the TLS/1.2 handshake.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":56,"url":null},"def":{"name":"tls_required","return_type":"Bool | ::Nil","visibility":"Public","body":"@tls_required"},"external_var":false},{"html_id":"tls_required=(tls_required:Bool|Nil)-instance-method","name":"tls_required=","doc":"If this is true, then the client must perform the TLS/1.2 handshake.\nNote, this used to be ssl_required and has been updated along with the protocol from SSL to TLS.","summary":"

          If this is true, then the client must perform the TLS/1.2 handshake.

          ","abstract":false,"args":[{"name":"tls_required","external_name":"tls_required","restriction":"Bool | ::Nil"}],"args_string":"(tls_required : Bool | Nil)","args_html":"(tls_required : Bool | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":56,"url":null},"def":{"name":"tls_required=","args":[{"name":"tls_required","external_name":"tls_required","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@tls_required = tls_required"},"external_var":false},{"html_id":"tls_verify:Bool|Nil-instance-method","name":"tls_verify","doc":"If this is true, the client must provide a valid certificate during the TLS handshake.","summary":"

          If this is true, the client must provide a valid certificate during the TLS handshake.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":58,"url":null},"def":{"name":"tls_verify","return_type":"Bool | ::Nil","visibility":"Public","body":"@tls_verify"},"external_var":false},{"html_id":"tls_verify=(tls_verify:Bool|Nil)-instance-method","name":"tls_verify=","doc":"If this is true, the client must provide a valid certificate during the TLS handshake.","summary":"

          If this is true, the client must provide a valid certificate during the TLS handshake.

          ","abstract":false,"args":[{"name":"tls_verify","external_name":"tls_verify","restriction":"Bool | ::Nil"}],"args_string":"(tls_verify : Bool | Nil)","args_html":"(tls_verify : Bool | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":58,"url":null},"def":{"name":"tls_verify=","args":[{"name":"tls_verify","external_name":"tls_verify","restriction":"Bool | ::Nil"}],"visibility":"Public","body":"@tls_verify = tls_verify"},"external_var":false},{"html_id":"version:String-instance-method","name":"version","doc":"The version of NATS.","summary":"

          The version of NATS.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":35,"url":null},"def":{"name":"version","return_type":"String","visibility":"Public","body":"@version"},"external_var":false},{"html_id":"version=(version:String)-instance-method","name":"version=","doc":"The version of NATS.","summary":"

          The version of NATS.

          ","abstract":false,"args":[{"name":"version","external_name":"version","restriction":"String"}],"args_string":"(version : String)","args_html":"(version : String)","location":{"filename":"src/nats/message/info.cr","line_number":35,"url":null},"def":{"name":"version=","args":[{"name":"version","external_name":"version","restriction":"String"}],"visibility":"Public","body":"@version = version"},"external_var":false},{"html_id":"ws_connect_urls:Array(String)|Nil-instance-method","name":"ws_connect_urls","doc":"List of server urls that a websocket client can connect to.","summary":"

          List of server urls that a websocket client can connect to.

          ","abstract":false,"location":{"filename":"src/nats/message/info.cr","line_number":64,"url":null},"def":{"name":"ws_connect_urls","return_type":"Array(String) | ::Nil","visibility":"Public","body":"@ws_connect_urls"},"external_var":false},{"html_id":"ws_connect_urls=(ws_connect_urls:Array(String)|Nil)-instance-method","name":"ws_connect_urls=","doc":"List of server urls that a websocket client can connect to.","summary":"

          List of server urls that a websocket client can connect to.

          ","abstract":false,"args":[{"name":"ws_connect_urls","external_name":"ws_connect_urls","restriction":"Array(String) | ::Nil"}],"args_string":"(ws_connect_urls : Array(String) | Nil)","args_html":"(ws_connect_urls : Array(String) | Nil)","location":{"filename":"src/nats/message/info.cr","line_number":64,"url":null},"def":{"name":"ws_connect_urls=","args":[{"name":"ws_connect_urls","external_name":"ws_connect_urls","restriction":"Array(String) | ::Nil"}],"visibility":"Public","body":"@ws_connect_urls = ws_connect_urls"},"external_var":false}]},{"html_id":"nats/NATS/Message/MSG","path":"NATS/Message/MSG.html","kind":"struct","full_name":"NATS::Message::MSG","name":"MSG","abstract":false,"superclass":{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"nats/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/message/msg.cr","line_number":22,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"nats/NATS/Message","kind":"module","full_name":"NATS::Message","name":"Message"},"doc":"The MSG protocol message is used to deliver an application message to the client.\n\nSEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#msg","summary":"

          The MSG protocol message is used to deliver an application message to the client.

          ","constructors":[{"html_id":"new(subject:String,sid:Int64,reply_to:String|Nil=nil,bytes:Int64=0,payload:String|Nil=nil,client:Client|Nil=nil)-class-method","name":"new","abstract":false,"args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"sid","external_name":"sid","restriction":"Int64"},{"name":"reply_to","default_value":"nil","external_name":"reply_to","restriction":"String | ::Nil"},{"name":"bytes","default_value":"0","external_name":"bytes","restriction":"Int64"},{"name":"payload","default_value":"nil","external_name":"payload","restriction":"String | ::Nil"},{"name":"client","default_value":"nil","external_name":"client","restriction":"Client | ::Nil"}],"args_string":"(subject : String, sid : Int64, reply_to : String | Nil = nil, bytes : Int64 = 0, payload : String | Nil = nil, client : Client | Nil = nil)","args_html":"(subject : String, sid : Int64, reply_to : String | Nil = nil, bytes : Int64 = 0, payload : String | Nil = nil, client : Client | Nil = nil)","location":{"filename":"src/nats/message/msg.cr","line_number":34,"url":null},"def":{"name":"new","args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"sid","external_name":"sid","restriction":"Int64"},{"name":"reply_to","default_value":"nil","external_name":"reply_to","restriction":"String | ::Nil"},{"name":"bytes","default_value":"0","external_name":"bytes","restriction":"Int64"},{"name":"payload","default_value":"nil","external_name":"payload","restriction":"String | ::Nil"},{"name":"client","default_value":"nil","external_name":"client","restriction":"Client | ::Nil"}],"visibility":"Public","body":"_ = allocate\n_.initialize(subject, sid, reply_to, bytes, payload, client)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}],"instance_methods":[{"html_id":"client:Client|Nil-instance-method","name":"client","doc":"NATS Client for sending replies.","summary":"

          NATS Client for sending replies.

          ","abstract":false,"location":{"filename":"src/nats/message/msg.cr","line_number":32,"url":null},"def":{"name":"client","return_type":"Client | ::Nil","visibility":"Public","body":"@client"},"external_var":false},{"html_id":"client=(client:Client|Nil)-instance-method","name":"client=","doc":"NATS Client for sending replies.","summary":"

          NATS Client for sending replies.

          ","abstract":false,"args":[{"name":"client","external_name":"client","restriction":"Client | ::Nil"}],"args_string":"(client : Client | Nil)","args_html":"(client : Client | Nil)","location":{"filename":"src/nats/message/msg.cr","line_number":32,"url":null},"def":{"name":"client=","args":[{"name":"client","external_name":"client","restriction":"Client | ::Nil"}],"visibility":"Public","body":"@client = client"},"external_var":false},{"html_id":"payload:String|Nil-instance-method","name":"payload","doc":"The message payload data.","summary":"

          The message payload data.

          ","abstract":false,"location":{"filename":"src/nats/message/msg.cr","line_number":30,"url":null},"def":{"name":"payload","return_type":"String | ::Nil","visibility":"Public","body":"@payload"},"external_var":false},{"html_id":"payload=(payload:String|Nil)-instance-method","name":"payload=","doc":"The message payload data.","summary":"

          The message payload data.

          ","abstract":false,"args":[{"name":"payload","external_name":"payload","restriction":"String | ::Nil"}],"args_string":"(payload : String | Nil)","args_html":"(payload : String | Nil)","location":{"filename":"src/nats/message/msg.cr","line_number":30,"url":null},"def":{"name":"payload=","args":[{"name":"payload","external_name":"payload","restriction":"String | ::Nil"}],"visibility":"Public","body":"@payload = payload"},"external_var":false},{"html_id":"reply(payload:String|Nil=nil)-instance-method","name":"reply","doc":"Reply to this message when the reply_to subject is set.\n\n*payload*: The payload to send in the reply.","summary":"

          Reply to this message when the reply_to subject is set.

          ","abstract":false,"args":[{"name":"payload","default_value":"nil","external_name":"payload","restriction":"String | ::Nil"}],"args_string":"(payload : String | Nil = nil)","args_html":"(payload : String | Nil = nil)","location":{"filename":"src/nats/message/msg.cr","line_number":54,"url":null},"def":{"name":"reply","args":[{"name":"payload","default_value":"nil","external_name":"payload","restriction":"String | ::Nil"}],"visibility":"Public","body":"if reply_to\n msg = PUB.new(subject: reply_to.to_s, payload: payload)\n\n @client.try(&.send_msg!(msg.to_s))\nelse\n raise(MSGError.new(\"reply_to is nil\"))\nend"},"external_var":false},{"html_id":"reply_to:String|Nil-instance-method","name":"reply_to","doc":"The subject on which the publisher is listening for responses.","summary":"

          The subject on which the publisher is listening for responses.

          ","abstract":false,"location":{"filename":"src/nats/message/msg.cr","line_number":28,"url":null},"def":{"name":"reply_to","return_type":"String | ::Nil","visibility":"Public","body":"@reply_to"},"external_var":false},{"html_id":"reply_to=(reply_to:String|Nil)-instance-method","name":"reply_to=","doc":"The subject on which the publisher is listening for responses.","summary":"

          The subject on which the publisher is listening for responses.

          ","abstract":false,"args":[{"name":"reply_to","external_name":"reply_to","restriction":"String | ::Nil"}],"args_string":"(reply_to : String | Nil)","args_html":"(reply_to : String | Nil)","location":{"filename":"src/nats/message/msg.cr","line_number":28,"url":null},"def":{"name":"reply_to=","args":[{"name":"reply_to","external_name":"reply_to","restriction":"String | ::Nil"}],"visibility":"Public","body":"@reply_to = reply_to"},"external_var":false},{"html_id":"sid:Int64-instance-method","name":"sid","doc":"The unique alphanumeric subscription ID of the subject.","summary":"

          The unique alphanumeric subscription ID of the subject.

          ","abstract":false,"location":{"filename":"src/nats/message/msg.cr","line_number":26,"url":null},"def":{"name":"sid","return_type":"Int64","visibility":"Public","body":"@sid"},"external_var":false},{"html_id":"sid=(sid:Int64)-instance-method","name":"sid=","doc":"The unique alphanumeric subscription ID of the subject.","summary":"

          The unique alphanumeric subscription ID of the subject.

          ","abstract":false,"args":[{"name":"sid","external_name":"sid","restriction":"Int64"}],"args_string":"(sid : Int64)","args_html":"(sid : Int64)","location":{"filename":"src/nats/message/msg.cr","line_number":26,"url":null},"def":{"name":"sid=","args":[{"name":"sid","external_name":"sid","restriction":"Int64"}],"visibility":"Public","body":"@sid = sid"},"external_var":false},{"html_id":"subject:String-instance-method","name":"subject","doc":"Subject name this message was received on.","summary":"

          Subject name this message was received on.

          ","abstract":false,"location":{"filename":"src/nats/message/msg.cr","line_number":24,"url":null},"def":{"name":"subject","return_type":"String","visibility":"Public","body":"@subject"},"external_var":false},{"html_id":"subject=(subject:String)-instance-method","name":"subject=","doc":"Subject name this message was received on.","summary":"

          Subject name this message was received on.

          ","abstract":false,"args":[{"name":"subject","external_name":"subject","restriction":"String"}],"args_string":"(subject : String)","args_html":"(subject : String)","location":{"filename":"src/nats/message/msg.cr","line_number":24,"url":null},"def":{"name":"subject=","args":[{"name":"subject","external_name":"subject","restriction":"String"}],"visibility":"Public","body":"@subject = subject"},"external_var":false},{"html_id":"to_s:String|Nil-instance-method","name":"to_s","doc":"Helper method to return the payload","summary":"

          Helper method to return the payload

          ","abstract":false,"location":{"filename":"src/nats/message/msg.cr","line_number":47,"url":null},"def":{"name":"to_s","return_type":"String | ::Nil","visibility":"Public","body":"payload"},"external_var":false}]},{"html_id":"nats/NATS/Message/PUB","path":"NATS/Message/PUB.html","kind":"struct","full_name":"NATS::Message::PUB","name":"PUB","abstract":false,"superclass":{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"nats/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/message/pub.cr","line_number":23,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"nats/NATS/Message","kind":"module","full_name":"NATS::Message","name":"Message"},"doc":"The PUB message publishes the message payload to the given subject name, optionally supplying a reply subject.\\\nIf a reply subject is supplied, it will be delivered to eligible subscribers along with the supplied payload.\n\nNOTE: that the payload itself is optional.\n\nSEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#pub","summary":"

          The PUB message publishes the message payload to the given subject name, optionally supplying a reply subject.\\ If a reply subject is supplied, it will be delivered to eligible subscribers along with the supplied payload.

          ","constructors":[{"html_id":"new(subject:String,reply_to:String|Nil=nil,payload:String|Nil=nil,callback:Message::MSG->Nil|Nil=nil)-class-method","name":"new","abstract":false,"args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"reply_to","default_value":"nil","external_name":"reply_to","restriction":"String | ::Nil"},{"name":"payload","default_value":"nil","external_name":"payload","restriction":"String | ::Nil"},{"name":"callback","default_value":"nil","external_name":"callback","restriction":"(Message::MSG -> Nil) | ::Nil"}],"args_string":"(subject : String, reply_to : String | Nil = nil, payload : String | Nil = nil, callback : Message::MSG -> Nil | Nil = nil)","args_html":"(subject : String, reply_to : String | Nil = nil, payload : String | Nil = nil, callback : Message::MSG -> Nil | Nil = nil)","location":{"filename":"src/nats/message/pub.cr","line_number":33,"url":null},"def":{"name":"new","args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"reply_to","default_value":"nil","external_name":"reply_to","restriction":"String | ::Nil"},{"name":"payload","default_value":"nil","external_name":"payload","restriction":"String | ::Nil"},{"name":"callback","default_value":"nil","external_name":"callback","restriction":"(Message::MSG -> Nil) | ::Nil"}],"visibility":"Public","body":"_ = allocate\n_.initialize(subject, reply_to, payload, callback)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}],"instance_methods":[{"html_id":"callback:Message::MSG->Nil|Nil-instance-method","name":"callback","doc":"The callback to be invoked when a message is received.","summary":"

          The callback to be invoked when a message is received.

          ","abstract":false,"location":{"filename":"src/nats/message/pub.cr","line_number":31,"url":null},"def":{"name":"callback","return_type":"(Message::MSG -> Nil) | ::Nil","visibility":"Public","body":"@callback"},"external_var":false},{"html_id":"callback=(callback:Message::MSG->Nil|Nil)-instance-method","name":"callback=","doc":"The callback to be invoked when a message is received.","summary":"

          The callback to be invoked when a message is received.

          ","abstract":false,"args":[{"name":"callback","external_name":"callback","restriction":"(Message::MSG -> Nil) | ::Nil"}],"args_string":"(callback : Message::MSG -> Nil | Nil)","args_html":"(callback : Message::MSG -> Nil | Nil)","location":{"filename":"src/nats/message/pub.cr","line_number":31,"url":null},"def":{"name":"callback=","args":[{"name":"callback","external_name":"callback","restriction":"(Message::MSG -> Nil) | ::Nil"}],"visibility":"Public","body":"@callback = callback"},"external_var":false},{"html_id":"payload:String|Nil-instance-method","name":"payload","doc":"The message payload data.","summary":"

          The message payload data.

          ","abstract":false,"location":{"filename":"src/nats/message/pub.cr","line_number":29,"url":null},"def":{"name":"payload","return_type":"String | ::Nil","visibility":"Public","body":"@payload"},"external_var":false},{"html_id":"payload=(payload:String|Nil)-instance-method","name":"payload=","doc":"The message payload data.","summary":"

          The message payload data.

          ","abstract":false,"args":[{"name":"payload","external_name":"payload","restriction":"String | ::Nil"}],"args_string":"(payload : String | Nil)","args_html":"(payload : String | Nil)","location":{"filename":"src/nats/message/pub.cr","line_number":29,"url":null},"def":{"name":"payload=","args":[{"name":"payload","external_name":"payload","restriction":"String | ::Nil"}],"visibility":"Public","body":"@payload = payload"},"external_var":false},{"html_id":"reply_to:String|Nil-instance-method","name":"reply_to","doc":"The reply subject that subscribers can use to send a response back to the publisher/requestor.","summary":"

          The reply subject that subscribers can use to send a response back to the publisher/requestor.

          ","abstract":false,"location":{"filename":"src/nats/message/pub.cr","line_number":27,"url":null},"def":{"name":"reply_to","return_type":"String | ::Nil","visibility":"Public","body":"@reply_to"},"external_var":false},{"html_id":"reply_to=(reply_to:String|Nil)-instance-method","name":"reply_to=","doc":"The reply subject that subscribers can use to send a response back to the publisher/requestor.","summary":"

          The reply subject that subscribers can use to send a response back to the publisher/requestor.

          ","abstract":false,"args":[{"name":"reply_to","external_name":"reply_to","restriction":"String | ::Nil"}],"args_string":"(reply_to : String | Nil)","args_html":"(reply_to : String | Nil)","location":{"filename":"src/nats/message/pub.cr","line_number":27,"url":null},"def":{"name":"reply_to=","args":[{"name":"reply_to","external_name":"reply_to","restriction":"String | ::Nil"}],"visibility":"Public","body":"@reply_to = reply_to"},"external_var":false},{"html_id":"subject:String-instance-method","name":"subject","doc":"The destination subject to publish to.","summary":"

          The destination subject to publish to.

          ","abstract":false,"location":{"filename":"src/nats/message/pub.cr","line_number":25,"url":null},"def":{"name":"subject","return_type":"String","visibility":"Public","body":"@subject"},"external_var":false},{"html_id":"subject=(subject:String)-instance-method","name":"subject=","doc":"The destination subject to publish to.","summary":"

          The destination subject to publish to.

          ","abstract":false,"args":[{"name":"subject","external_name":"subject","restriction":"String"}],"args_string":"(subject : String)","args_html":"(subject : String)","location":{"filename":"src/nats/message/pub.cr","line_number":25,"url":null},"def":{"name":"subject=","args":[{"name":"subject","external_name":"subject","restriction":"String"}],"visibility":"Public","body":"@subject = subject"},"external_var":false},{"html_id":"to_s-instance-method","name":"to_s","doc":"Returns a nicely readable and concise string representation of this object,\ntypically intended for users.\n\nThis method should usually **not** be overridden. It delegates to\n`#to_s(IO)` which can be overridden for custom implementations.\n\nAlso see `#inspect`.","summary":"

          Returns a nicely readable and concise string representation of this object, typically intended for users.

          ","abstract":false,"location":{"filename":"src/nats/message/pub.cr","line_number":42,"url":null},"def":{"name":"to_s","visibility":"Public","body":"if reply_to.nil?\n \"PUB #{subject} #{bytes}#{CR_LF}#{payload}\"\nelse\n \"PUB #{subject} #{reply_to} #{bytes}#{CR_LF}#{payload}\"\nend"},"external_var":false}]},{"html_id":"nats/NATS/Message/SUB","path":"NATS/Message/SUB.html","kind":"struct","full_name":"NATS::Message::SUB","name":"SUB","abstract":false,"superclass":{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"nats/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/message/sub.cr","line_number":20,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"nats/NATS/Message","kind":"module","full_name":"NATS::Message","name":"Message"},"doc":"SUB initiates a subscription to a subject, optionally joining a distributed queue group.\n\nSEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#sub","summary":"

          SUB initiates a subscription to a subject, optionally joining a distributed queue group.

          ","constructors":[{"html_id":"new(subject:String,sid:String,queue_group:String|Nil=nil)-class-method","name":"new","abstract":false,"args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"sid","external_name":"sid","restriction":"String"},{"name":"queue_group","default_value":"nil","external_name":"queue_group","restriction":"String | ::Nil"}],"args_string":"(subject : String, sid : String, queue_group : String | Nil = nil)","args_html":"(subject : String, sid : String, queue_group : String | Nil = nil)","location":{"filename":"src/nats/message/sub.cr","line_number":28,"url":null},"def":{"name":"new","args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"sid","external_name":"sid","restriction":"String"},{"name":"queue_group","default_value":"nil","external_name":"queue_group","restriction":"String | ::Nil"}],"visibility":"Public","body":"_ = allocate\n_.initialize(subject, sid, queue_group)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}],"instance_methods":[{"html_id":"queue_group:String|Nil-instance-method","name":"queue_group","doc":"If specified, the subscriber will join this queue group.","summary":"

          If specified, the subscriber will join this queue group.

          ","abstract":false,"location":{"filename":"src/nats/message/sub.cr","line_number":24,"url":null},"def":{"name":"queue_group","return_type":"String | ::Nil","visibility":"Public","body":"@queue_group"},"external_var":false},{"html_id":"queue_group=(queue_group:String|Nil)-instance-method","name":"queue_group=","doc":"If specified, the subscriber will join this queue group.","summary":"

          If specified, the subscriber will join this queue group.

          ","abstract":false,"args":[{"name":"queue_group","external_name":"queue_group","restriction":"String | ::Nil"}],"args_string":"(queue_group : String | Nil)","args_html":"(queue_group : String | Nil)","location":{"filename":"src/nats/message/sub.cr","line_number":24,"url":null},"def":{"name":"queue_group=","args":[{"name":"queue_group","external_name":"queue_group","restriction":"String | ::Nil"}],"visibility":"Public","body":"@queue_group = queue_group"},"external_var":false},{"html_id":"sid:String-instance-method","name":"sid","doc":"A unique alphanumeric subscription ID, generated by the client.","summary":"

          A unique alphanumeric subscription ID, generated by the client.

          ","abstract":false,"location":{"filename":"src/nats/message/sub.cr","line_number":26,"url":null},"def":{"name":"sid","return_type":"String","visibility":"Public","body":"@sid"},"external_var":false},{"html_id":"sid=(sid:String)-instance-method","name":"sid=","doc":"A unique alphanumeric subscription ID, generated by the client.","summary":"

          A unique alphanumeric subscription ID, generated by the client.

          ","abstract":false,"args":[{"name":"sid","external_name":"sid","restriction":"String"}],"args_string":"(sid : String)","args_html":"(sid : String)","location":{"filename":"src/nats/message/sub.cr","line_number":26,"url":null},"def":{"name":"sid=","args":[{"name":"sid","external_name":"sid","restriction":"String"}],"visibility":"Public","body":"@sid = sid"},"external_var":false},{"html_id":"subject:String-instance-method","name":"subject","doc":"The subject name to subscribe to.","summary":"

          The subject name to subscribe to.

          ","abstract":false,"location":{"filename":"src/nats/message/sub.cr","line_number":22,"url":null},"def":{"name":"subject","return_type":"String","visibility":"Public","body":"@subject"},"external_var":false},{"html_id":"subject=(subject:String)-instance-method","name":"subject=","doc":"The subject name to subscribe to.","summary":"

          The subject name to subscribe to.

          ","abstract":false,"args":[{"name":"subject","external_name":"subject","restriction":"String"}],"args_string":"(subject : String)","args_html":"(subject : String)","location":{"filename":"src/nats/message/sub.cr","line_number":22,"url":null},"def":{"name":"subject=","args":[{"name":"subject","external_name":"subject","restriction":"String"}],"visibility":"Public","body":"@subject = subject"},"external_var":false},{"html_id":"to_s-instance-method","name":"to_s","doc":"Returns a nicely readable and concise string representation of this object,\ntypically intended for users.\n\nThis method should usually **not** be overridden. It delegates to\n`#to_s(IO)` which can be overridden for custom implementations.\n\nAlso see `#inspect`.","summary":"

          Returns a nicely readable and concise string representation of this object, typically intended for users.

          ","abstract":false,"location":{"filename":"src/nats/message/sub.cr","line_number":35,"url":null},"def":{"name":"to_s","visibility":"Public","body":"if queue_group.nil?\n \"SUB #{subject} #{sid}\"\nelse\n \"SUB #{subject} #{queue_group} #{sid}\"\nend"},"external_var":false}]},{"html_id":"nats/NATS/Message/UNSUB","path":"NATS/Message/UNSUB.html","kind":"struct","full_name":"NATS::Message::UNSUB","name":"UNSUB","abstract":false,"superclass":{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"nats/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/message/unsub.cr","line_number":21,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"nats/NATS/Message","kind":"module","full_name":"NATS::Message","name":"Message"},"doc":"UNSUB unsubscribes the connection from the specified subject,\n or auto-unsubscribes after the specified number of messages has been received.\n\nSEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#unsub","summary":"

          UNSUB unsubscribes the connection from the specified subject, or auto-unsubscribes after the specified number of messages has been received.

          ","constructors":[{"html_id":"new(sid:String,max_msgs:Int64|Nil=nil)-class-method","name":"new","abstract":false,"args":[{"name":"sid","external_name":"sid","restriction":"String"},{"name":"max_msgs","default_value":"nil","external_name":"max_msgs","restriction":"Int64 | ::Nil"}],"args_string":"(sid : String, max_msgs : Int64 | Nil = nil)","args_html":"(sid : String, max_msgs : Int64 | Nil = nil)","location":{"filename":"src/nats/message/unsub.cr","line_number":27,"url":null},"def":{"name":"new","args":[{"name":"sid","external_name":"sid","restriction":"String"},{"name":"max_msgs","default_value":"nil","external_name":"max_msgs","restriction":"Int64 | ::Nil"}],"visibility":"Public","body":"_ = allocate\n_.initialize(sid, max_msgs)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}],"instance_methods":[{"html_id":"max_msgs:Int64|Nil-instance-method","name":"max_msgs","doc":"If specified, the subscriber will join this queue group.","summary":"

          If specified, the subscriber will join this queue group.

          ","abstract":false,"location":{"filename":"src/nats/message/unsub.cr","line_number":25,"url":null},"def":{"name":"max_msgs","return_type":"Int64 | ::Nil","visibility":"Public","body":"@max_msgs"},"external_var":false},{"html_id":"max_msgs=(max_msgs:Int64|Nil)-instance-method","name":"max_msgs=","doc":"If specified, the subscriber will join this queue group.","summary":"

          If specified, the subscriber will join this queue group.

          ","abstract":false,"args":[{"name":"max_msgs","external_name":"max_msgs","restriction":"Int64 | ::Nil"}],"args_string":"(max_msgs : Int64 | Nil)","args_html":"(max_msgs : Int64 | Nil)","location":{"filename":"src/nats/message/unsub.cr","line_number":25,"url":null},"def":{"name":"max_msgs=","args":[{"name":"max_msgs","external_name":"max_msgs","restriction":"Int64 | ::Nil"}],"visibility":"Public","body":"@max_msgs = max_msgs"},"external_var":false},{"html_id":"sid:String-instance-method","name":"sid","doc":"The unique alphanumeric subscription ID of the subject to unsubscribe from.","summary":"

          The unique alphanumeric subscription ID of the subject to unsubscribe from.

          ","abstract":false,"location":{"filename":"src/nats/message/unsub.cr","line_number":23,"url":null},"def":{"name":"sid","return_type":"String","visibility":"Public","body":"@sid"},"external_var":false},{"html_id":"sid=(sid:String)-instance-method","name":"sid=","doc":"The unique alphanumeric subscription ID of the subject to unsubscribe from.","summary":"

          The unique alphanumeric subscription ID of the subject to unsubscribe from.

          ","abstract":false,"args":[{"name":"sid","external_name":"sid","restriction":"String"}],"args_string":"(sid : String)","args_html":"(sid : String)","location":{"filename":"src/nats/message/unsub.cr","line_number":23,"url":null},"def":{"name":"sid=","args":[{"name":"sid","external_name":"sid","restriction":"String"}],"visibility":"Public","body":"@sid = sid"},"external_var":false},{"html_id":"to_s-instance-method","name":"to_s","doc":"Returns a nicely readable and concise string representation of this object,\ntypically intended for users.\n\nThis method should usually **not** be overridden. It delegates to\n`#to_s(IO)` which can be overridden for custom implementations.\n\nAlso see `#inspect`.","summary":"

          Returns a nicely readable and concise string representation of this object, typically intended for users.

          ","abstract":false,"location":{"filename":"src/nats/message/unsub.cr","line_number":33,"url":null},"def":{"name":"to_s","visibility":"Public","body":"if max_msgs.nil?\n \"UNSUB #{sid}\"\nelse\n \"UNSUB #{sid} #{max_msgs}\"\nend"},"external_var":false}]}]},{"html_id":"nats/NATS/MSGError","path":"NATS/MSGError.html","kind":"class","full_name":"NATS::MSGError","name":"MSGError","abstract":false,"superclass":{"html_id":"nats/NATS/Error","kind":"class","full_name":"NATS::Error","name":"Error"},"ancestors":[{"html_id":"nats/NATS/Error","kind":"class","full_name":"NATS::Error","name":"Error"},{"html_id":"nats/Exception","kind":"class","full_name":"Exception","name":"Exception"},{"html_id":"nats/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/errors.cr","line_number":50,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"nats/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"+MSGError+ is raised when there is a problem with a +NATS::Message::MSG+.","summary":"

          +MSGError+ is raised when there is a problem with a +NATS::Message::MSG+.

          ","constructors":[{"html_id":"new(msg=\"MSGerror\")-class-method","name":"new","abstract":false,"args":[{"name":"msg","default_value":"\"MSG error\"","external_name":"msg","restriction":""}],"args_string":"(msg = \"MSG error\")","args_html":"(msg = "MSG error")","location":{"filename":"src/nats/errors.cr","line_number":51,"url":null},"def":{"name":"new","args":[{"name":"msg","default_value":"\"MSG error\"","external_name":"msg","restriction":""}],"visibility":"Public","body":"_ = allocate\n_.initialize(msg)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}]},{"html_id":"nats/NATS/NUID","path":"NATS/NUID.html","kind":"class","full_name":"NATS::NUID","name":"NUID","abstract":false,"superclass":{"html_id":"nats/Reference","kind":"class","full_name":"Reference","name":"Reference"},"ancestors":[{"html_id":"nats/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/nuid.cr","line_number":21,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"constants":[{"id":"BASE","name":"BASE","value":"62"},{"id":"DIGITS","name":"DIGITS","value":"\"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\""},{"id":"INC","name":"INC","value":"MAX_INC - MIN_INC"},{"id":"MAX_INC","name":"MAX_INC","value":"333_i64"},{"id":"MAX_SEQ","name":"MAX_SEQ","value":"839299365868340224_i64"},{"id":"MIN_INC","name":"MIN_INC","value":"33_i64"},{"id":"PREFIX_LENGTH","name":"PREFIX_LENGTH","value":"12"},{"id":"SEQ_LENGTH","name":"SEQ_LENGTH","value":"10"},{"id":"TOTAL_LENGTH","name":"TOTAL_LENGTH","value":"PREFIX_LENGTH + SEQ_LENGTH"}],"namespace":{"html_id":"nats/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"Copied and modified from nats-pure repo.\n\nSEE: https://github.com/nats-io/nats-pure.rb/blob/master/lib/nats/nuid.rb","summary":"

          Copied and modified from nats-pure repo.

          ","constructors":[{"html_id":"new-class-method","name":"new","abstract":false,"location":{"filename":"src/nats/nuid.cr","line_number":32,"url":null},"def":{"name":"new","visibility":"Public","body":"_ = allocate\n_.initialize\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}],"instance_methods":[{"html_id":"next-instance-method","name":"next","abstract":false,"location":{"filename":"src/nats/nuid.cr","line_number":38,"url":null},"def":{"name":"next","visibility":"Public","body":"@seq = @seq + @inc\nif @seq >= MAX_SEQ\n reset!\nend\nl = @seq\n\n\n\n\ns_10 = DIGITS[l % BASE]\n\ns_09, s_08, s_07, s_06, s_05, s_04, s_03, s_02, s_01 = (l = l // BASE\nDIGITS[l % BASE]), (l = l // BASE\nDIGITS[l % BASE]), (l = l // BASE\nDIGITS[l % BASE]), (l = l // BASE\nDIGITS[l % BASE]), (l = l // BASE\nDIGITS[l % BASE]), (l = l // BASE\nDIGITS[l % BASE]), (l = l // BASE\nDIGITS[l % BASE]), (l = l // BASE\nDIGITS[l % BASE]), (l = l // BASE\nDIGITS[l % BASE])\n\"#{@prefix}#{s_01}#{s_02}#{s_03}#{s_04}#{s_05}#{s_06}#{s_07}#{s_08}#{s_09}#{s_10}\"\n"},"external_var":false},{"html_id":"randomize_prefix!-instance-method","name":"randomize_prefix!","abstract":false,"location":{"filename":"src/nats/nuid.cr","line_number":60,"url":null},"def":{"name":"randomize_prefix!","visibility":"Public","body":"@prefix = String::Builder.build(PREFIX_LENGTH) do |io|\n Random::Secure.random_bytes(@pre_bytes)\n @pre_bytes.each do |n|\n io << DIGITS[n % BASE]\n end\nend"},"external_var":false}]},{"html_id":"nats/NATS/Options","path":"NATS/Options.html","kind":"struct","full_name":"NATS::Options","name":"Options","abstract":false,"superclass":{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"nats/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/options.cr","line_number":21,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"nats/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"Adapted from the nats.go library.\n\nNOTE: Currently only some options are implemented.\n\nSEE: https://github.com/nats-io/nats.go/blob/8a48023f77877dcfc140d0b9c25603c6cbedfaab/nats.go#L152","summary":"

          Adapted from the nats.go library.

          ","constructors":[{"html_id":"new-class-method","name":"new","abstract":false,"location":{"filename":"src/nats/options.cr","line_number":21,"url":null},"def":{"name":"new","visibility":"Public","body":"x = allocate\nif x.responds_to?(:finalize)\n ::GC.add_finalizer(x)\nend\nx\n"},"external_var":false}],"instance_methods":[{"html_id":"flush_interval:Time::Span-instance-method","name":"flush_interval","doc":"Specific to nats.cr","summary":"

          Specific to nats.cr

          ","abstract":false,"location":{"filename":"src/nats/options.cr","line_number":38,"url":null},"def":{"name":"flush_interval","return_type":"Time::Span","visibility":"Public","body":"@flush_interval"},"external_var":false},{"html_id":"flush_interval=(flush_interval:Time::Span)-instance-method","name":"flush_interval=","doc":"Specific to nats.cr","summary":"

          Specific to nats.cr

          ","abstract":false,"args":[{"name":"flush_interval","external_name":"flush_interval","restriction":"Time::Span"}],"args_string":"(flush_interval : Time::Span)","args_html":"(flush_interval : Time::Span)","location":{"filename":"src/nats/options.cr","line_number":38,"url":null},"def":{"name":"flush_interval=","args":[{"name":"flush_interval","external_name":"flush_interval","restriction":"Time::Span"}],"visibility":"Public","body":"@flush_interval = flush_interval"},"external_var":false},{"html_id":"initialize-instance-method","name":"initialize","abstract":false,"location":{"filename":"src/nats/options.cr","line_number":21,"url":null},"def":{"name":"initialize","visibility":"Public","body":""},"external_var":false},{"html_id":"pedantic:Bool-instance-method","name":"pedantic","doc":"property ping_interval : Time::Span = 2.minutes\nproperty max_pings_out : Int32 = 2\nproperty sub_chan_len : Int32 = 64 * 1024 # 64k\nproperty reconnect_buf_size : Int32 = 8 * 1024 * 1024 # 8MB\nproperty drain_timeout : Time::Span = 30.seconds\nproperty flusher_timeout : Time::Span = 1.minute","summary":"

          property ping_interval : Time::Span = 2.minutes property max_pings_out : Int32 = 2 property sub_chan_len : Int32 = 64 * 1024 # 64k property reconnect_buf_size : Int32 = 8 * 1024 * 1024 # 8MB property drain_timeout : Time::Span = 30.seconds property flusher_timeout : Time::Span = 1.minute

          ","abstract":false,"location":{"filename":"src/nats/options.cr","line_number":35,"url":null},"def":{"name":"pedantic","return_type":"Bool","visibility":"Public","body":"@pedantic"},"external_var":false},{"html_id":"pedantic=(pedantic:Bool)-instance-method","name":"pedantic=","doc":"property ping_interval : Time::Span = 2.minutes\nproperty max_pings_out : Int32 = 2\nproperty sub_chan_len : Int32 = 64 * 1024 # 64k\nproperty reconnect_buf_size : Int32 = 8 * 1024 * 1024 # 8MB\nproperty drain_timeout : Time::Span = 30.seconds\nproperty flusher_timeout : Time::Span = 1.minute","summary":"

          property ping_interval : Time::Span = 2.minutes property max_pings_out : Int32 = 2 property sub_chan_len : Int32 = 64 * 1024 # 64k property reconnect_buf_size : Int32 = 8 * 1024 * 1024 # 8MB property drain_timeout : Time::Span = 30.seconds property flusher_timeout : Time::Span = 1.minute

          ","abstract":false,"args":[{"name":"pedantic","external_name":"pedantic","restriction":"Bool"}],"args_string":"(pedantic : Bool)","args_html":"(pedantic : Bool)","location":{"filename":"src/nats/options.cr","line_number":35,"url":null},"def":{"name":"pedantic=","args":[{"name":"pedantic","external_name":"pedantic","restriction":"Bool"}],"visibility":"Public","body":"@pedantic = pedantic"},"external_var":false},{"html_id":"timeout:Time::Span-instance-method","name":"timeout","doc":"From nats.go\nproperty allow_reconnect : Bool = true\nproperty max_reconnect : Int32 = 60\nproperty reconnect_wait : Time::Span = 2.seconds\nproperty reconnect_jitter : Time::Span = 100.milliseconds\nproperty reconnect_jitter_tls : Time::Span = 1.second","summary":"

          From nats.go property allow_reconnect : Bool = true property max_reconnect : Int32 = 60 property reconnect_wait : Time::Span = 2.seconds property reconnect_jitter : Time::Span = 100.milliseconds property reconnect_jitter_tls : Time::Span = 1.second

          ","abstract":false,"location":{"filename":"src/nats/options.cr","line_number":28,"url":null},"def":{"name":"timeout","return_type":"Time::Span","visibility":"Public","body":"@timeout"},"external_var":false},{"html_id":"timeout=(timeout:Time::Span)-instance-method","name":"timeout=","doc":"From nats.go\nproperty allow_reconnect : Bool = true\nproperty max_reconnect : Int32 = 60\nproperty reconnect_wait : Time::Span = 2.seconds\nproperty reconnect_jitter : Time::Span = 100.milliseconds\nproperty reconnect_jitter_tls : Time::Span = 1.second","summary":"

          From nats.go property allow_reconnect : Bool = true property max_reconnect : Int32 = 60 property reconnect_wait : Time::Span = 2.seconds property reconnect_jitter : Time::Span = 100.milliseconds property reconnect_jitter_tls : Time::Span = 1.second

          ","abstract":false,"args":[{"name":"timeout","external_name":"timeout","restriction":"Time::Span"}],"args_string":"(timeout : Time::Span)","args_html":"(timeout : Time::Span)","location":{"filename":"src/nats/options.cr","line_number":28,"url":null},"def":{"name":"timeout=","args":[{"name":"timeout","external_name":"timeout","restriction":"Time::Span"}],"visibility":"Public","body":"@timeout = timeout"},"external_var":false}]},{"html_id":"nats/NATS/Subscription","path":"NATS/Subscription.html","kind":"struct","full_name":"NATS::Subscription","name":"Subscription","abstract":false,"superclass":{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},"ancestors":[{"html_id":"nats/Struct","kind":"struct","full_name":"Struct","name":"Struct"},{"html_id":"nats/Value","kind":"struct","full_name":"Value","name":"Value"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/subscription.cr","line_number":17,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"nats/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"Represents a subscription to a NATS subject.","summary":"

          Represents a subscription to a NATS subject.

          ","constructors":[{"html_id":"new(subject:String,sid:UInt64,callback:Message::MSG->Nil,client:Client,queue_group:String|Nil=nil)-class-method","name":"new","abstract":false,"args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"sid","external_name":"sid","restriction":"UInt64"},{"name":"callback","external_name":"callback","restriction":"(Message::MSG -> Nil)"},{"name":"client","external_name":"client","restriction":"Client"},{"name":"queue_group","default_value":"nil","external_name":"queue_group","restriction":"String | ::Nil"}],"args_string":"(subject : String, sid : UInt64, callback : Message::MSG -> Nil, client : Client, queue_group : String | Nil = nil)","args_html":"(subject : String, sid : UInt64, callback : Message::MSG -> Nil, client : Client, queue_group : String | Nil = nil)","location":{"filename":"src/nats/subscription.cr","line_number":29,"url":null},"def":{"name":"new","args":[{"name":"subject","external_name":"subject","restriction":"String"},{"name":"sid","external_name":"sid","restriction":"UInt64"},{"name":"callback","external_name":"callback","restriction":"(Message::MSG -> Nil)"},{"name":"client","external_name":"client","restriction":"Client"},{"name":"queue_group","default_value":"nil","external_name":"queue_group","restriction":"String | ::Nil"}],"visibility":"Public","body":"_ = allocate\n_.initialize(subject, sid, callback, client, queue_group)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}],"instance_methods":[{"html_id":"callback:Message::MSG->Nil-instance-method","name":"callback","doc":"The callback to be invoked when a message is received.","summary":"

          The callback to be invoked when a message is received.

          ","abstract":false,"location":{"filename":"src/nats/subscription.cr","line_number":25,"url":null},"def":{"name":"callback","return_type":"(Message::MSG -> Nil)","visibility":"Public","body":"@callback"},"external_var":false},{"html_id":"callback=(callback:Message::MSG->Nil)-instance-method","name":"callback=","doc":"The callback to be invoked when a message is received.","summary":"

          The callback to be invoked when a message is received.

          ","abstract":false,"args":[{"name":"callback","external_name":"callback","restriction":"(Message::MSG -> Nil)"}],"args_string":"(callback : Message::MSG -> Nil)","args_html":"(callback : Message::MSG -> Nil)","location":{"filename":"src/nats/subscription.cr","line_number":25,"url":null},"def":{"name":"callback=","args":[{"name":"callback","external_name":"callback","restriction":"(Message::MSG -> Nil)"}],"visibility":"Public","body":"@callback = callback"},"external_var":false},{"html_id":"client:Client-instance-method","name":"client","doc":"The client that owns this subscription.","summary":"

          The client that owns this subscription.

          ","abstract":false,"location":{"filename":"src/nats/subscription.cr","line_number":27,"url":null},"def":{"name":"client","return_type":"Client","visibility":"Public","body":"@client"},"external_var":false},{"html_id":"queue_group:String|Nil-instance-method","name":"queue_group","doc":"If specified, the subscriber will join this queue group.","summary":"

          If specified, the subscriber will join this queue group.

          ","abstract":false,"location":{"filename":"src/nats/subscription.cr","line_number":21,"url":null},"def":{"name":"queue_group","return_type":"String | ::Nil","visibility":"Public","body":"@queue_group"},"external_var":false},{"html_id":"sid:UInt64-instance-method","name":"sid","doc":"A unique alphanumeric subscription ID, generated by the client.","summary":"

          A unique alphanumeric subscription ID, generated by the client.

          ","abstract":false,"location":{"filename":"src/nats/subscription.cr","line_number":23,"url":null},"def":{"name":"sid","return_type":"UInt64","visibility":"Public","body":"@sid"},"external_var":false},{"html_id":"subject:String-instance-method","name":"subject","doc":"The subject name to subscribe to.","summary":"

          The subject name to subscribe to.

          ","abstract":false,"location":{"filename":"src/nats/subscription.cr","line_number":19,"url":null},"def":{"name":"subject","return_type":"String","visibility":"Public","body":"@subject"},"external_var":false},{"html_id":"unsubscribe-instance-method","name":"unsubscribe","abstract":false,"location":{"filename":"src/nats/subscription.cr","line_number":38,"url":null},"def":{"name":"unsubscribe","visibility":"Public","body":"client.unsubscribe(self)"},"external_var":false}]},{"html_id":"nats/NATS/TimeoutError","path":"NATS/TimeoutError.html","kind":"class","full_name":"NATS::TimeoutError","name":"TimeoutError","abstract":false,"superclass":{"html_id":"nats/NATS/Error","kind":"class","full_name":"NATS::Error","name":"Error"},"ancestors":[{"html_id":"nats/NATS/Error","kind":"class","full_name":"NATS::Error","name":"Error"},{"html_id":"nats/Exception","kind":"class","full_name":"Exception","name":"Exception"},{"html_id":"nats/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"nats/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/nats/errors.cr","line_number":29,"url":null}],"repository_name":"nats","program":false,"enum":false,"alias":false,"const":false,"namespace":{"html_id":"nats/NATS","kind":"module","full_name":"NATS","name":"NATS"},"doc":"+Timeout+ is raised when `NATS::Options.timeout` is reached.","summary":"

          +Timeout+ is raised when NATS::Options.timeout is reached.

          ","constructors":[{"html_id":"new(msg=\"Timeoutoccurred\")-class-method","name":"new","abstract":false,"args":[{"name":"msg","default_value":"\"Timeout occurred\"","external_name":"msg","restriction":""}],"args_string":"(msg = \"Timeout occurred\")","args_html":"(msg = "Timeout occurred")","location":{"filename":"src/nats/errors.cr","line_number":30,"url":null},"def":{"name":"new","args":[{"name":"msg","default_value":"\"Timeout occurred\"","external_name":"msg","restriction":""}],"visibility":"Public","body":"_ = allocate\n_.initialize(msg)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"},"external_var":false}]}]}]}}) \ No newline at end of file diff --git a/shard.yml b/shard.yml index 9f0fe79..f61e9e7 100644 --- a/shard.yml +++ b/shard.yml @@ -1,20 +1,14 @@ name: nats -version: 0.0.4 +version: 0.0.5 +crystal: ">= 1.0, < 2.0" +license: Apache-2.0 authors: - Derek Collison + - Zach Bensley -github: nats-io/nats.cr - -targets: - nats-pub: - main: bin/nats-pub.cr - nats-sub: - main: bin/nats-sub.cr - nats-req: - main: bin/nats-req.cr +description: | + Simple NATS client for the [Crystal](https://crystal-lang.org) programming language. +github: nats-io/nats.cr repository: "https://github.com/nats-io/nats.cr" -crystal: ">= 1.30, < 2.0" - -license: Apache-2.0 diff --git a/spec/nats/auth_spec.cr b/spec/nats/auth_spec.cr deleted file mode 100644 index 2f8c1a5..0000000 --- a/spec/nats/auth_spec.cr +++ /dev/null @@ -1,32 +0,0 @@ -require "../spec_helper" - -describe "NATS::Connection#auth" do - user = "user" - pass = "s3cr3t" - - auth_uri = URI.parse("nats://#{user}:#{pass}@127.0.0.1:4333") - noauth_uri = URI.parse("nats://127.0.0.1:4333") - - auth_server : NATSServer | Nil = nil - - Spec.after_each do - auth_server.try(&.shutdown) - auth_server = nil - end - - describe "#new" do - it "should connect with correct user/pass" do - auth_server = NATSServer.start(auth_uri) - nc = NATS::Connection.new(auth_uri) - nc.should_not be_nil - nc.close - end - - it "should fail with no user/pass" do - auth_server = NATSServer.start(auth_uri) - expect_raises(Exception) do - NATS::Connection.new(noauth_uri) - end - end - end -end diff --git a/spec/nats/basic_spec.cr b/spec/nats/basic_spec.cr deleted file mode 100644 index e2550ac..0000000 --- a/spec/nats/basic_spec.cr +++ /dev/null @@ -1,190 +0,0 @@ -require "../spec_helper" - -describe NATS::Connection do - uri = URI.parse("nats://127.0.0.1:4322") - server : NATSServer | Nil = nil - - Spec.before_each do - server = NATSServer.start(uri) - end - - Spec.after_each do - server.try(&.shutdown) - sleep(20.millisecond) - server = nil - end - - describe "#new" do - it "Should raise when failing to connect" do - expect_raises(Exception) do - NATS::Connection.new("nats://127.0.0.1:4333") - end - end - - it "Should do basic connect with proper uri" do - nc = NATS::Connection.new(uri) - nc.should_not be_nil - nc.close - end - end - - describe "#close" do - it "Should report closed when closed" do - nc = NATS::Connection.new(uri) - nc.closed?.should be_false - nc.close - nc.closed?.should be_true - end - end - - describe "#on_close" do - it "Should call on_close callback when closing" do - nc = NATS::Connection.new(uri) - ch = Channel(Bool).new - nc.on_close { ch.send(true) } - nc.close - wait(ch) - end - - it "Should call on_close when connection closed underneath" do - nc = NATS::Connection.new(uri) - ch = Channel(Bool).new - nc.on_close { ch.send(true) } - server.try(&.shutdown) - wait(ch) - end - end - - describe "#new_inbox" do - it "Should properly create _INBOX subjects" do - nc = NATS::Connection.new(uri) - inbox = nc.new_inbox - inbox.should start_with("_INBOX") - inbox.split(".").size.should eq(3) - end - end - - describe "#publish" do - it "Should not raise when doing a publish" do - nc = NATS::Connection.new(uri) - nc.publish("foo", "Hello!") - nc.close - end - - it "Should raise on empty subject" do - nc = NATS::Connection.new(uri) - expect_raises(Exception) { nc.publish("", "Hello!") } - end - - it "Should raise on closed connection" do - nc = NATS::Connection.new(uri) - nc.close - expect_raises(Exception) { nc.publish("foo", "Hello!") } - end - - it "Should raise on too big of a payload" do - nc = NATS::Connection.new(uri) - expect_raises(Exception) { nc.publish("foo", "abc"*10_000_000) } - end - - it "Should deliver an error on bad subject" do - nc = NATS::Connection.new(uri, pedantic: true) - ch = Channel(Bool).new - nc.on_error do |e| - e.should contain("Invalid Publish Subject") - ch.send(true) - end - nc.publish("foo..", "abc") - wait(ch) - nc.close - end - end - - describe "#publish_with_reply" do - it "Should attach a reply subject" do - nc = NATS::Connection.new(uri) - ch = Channel(Bool).new - nc.subscribe("foo") do |msg| - msg.should_not be_nil - msg.reply.should_not be_nil - msg.reply.to_s.should eq("respond") - ch.send(true) - end - nc.publish_with_reply("foo", "respond", "Hello!") - wait(ch) - nc.close - end - end - - describe "#subscribe" do - it "Should receive messages it subscribed to" do - nc = NATS::Connection.new(uri) - ch = Channel(Bool).new - nc.subscribe("foo") { ch.send(true) } - nc.publish("foo", "Hello!") - wait(ch) - nc.close - end - - it "Should receive messages it subscribed to as a group" do - nc = NATS::Connection.new(uri) - ch = Channel(Bool).new - nc.subscribe("foo", "bar") { ch.send(true) } - nc.subscribe("foo", "bar") { ch.send(true) } - nc.publish("foo", "Hello!") - nc.publish("foo", "Hello!") - wait(ch) - wait(ch) - end - - it "Should not receive messages after unssubscribe" do - nc = NATS::Connection.new(uri) - ch = Channel(Bool).new - sub = nc.subscribe("foo") { ch.send(true) } - nc.publish("foo", "Hello!") - wait(ch) - sub.unsubscribe - nc.publish("foo", "Hello!") - spawn { sleep 20.millisecond; ch.close } - expect_raises(Exception) { ch.receive } - sub.closed?.should be_true - # Unsubscribing/closing twice should be ok. - sub.close - end - end - - describe "#request" do - it "Should receive requests with reply subjects" do - nc = NATS::Connection.new(uri) - nc.subscribe("request") do |msg| - msg.should_not be_nil - msg.reply.should_not be_nil - msg.reply.to_s.should start_with("_INBOX") - nc.publish(msg.reply.to_s, "42") - end - answer = nc.request("request", "Help!") - answer.to_s.should eq("42") - nc.close - end - - it "Should timeout correctly" do - nc = NATS::Connection.new(uri) - elapsed = Time.measure do - answer = nc.request("request", "Help!", 10.millisecond) - rescue - end - elapsed.should be_close(10.millisecond, 5.millisecond) - nc.close - end - - it "Should be able to respond to request message" do - nc = NATS::Connection.new(uri) - nc.subscribe("request") do |req| - req.respond("42") - end - answer = nc.request("request", "Help!") - answer.to_s.should eq("42") - nc.close - end - end -end diff --git a/spec/nats/client_spec.cr b/spec/nats/client_spec.cr new file mode 100644 index 0000000..cff85b0 --- /dev/null +++ b/spec/nats/client_spec.cr @@ -0,0 +1,210 @@ +# Copyright 2019-2025 The NATS Authors +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +require "../spec_helper" + +describe NATS::Client do + uri = URI.parse("nats://127.0.0.1:4322") + server : NATSServer | Nil = nil + + # Authentication testing + user = "user" + pass = "s3cr3t" + auth_uri = URI.parse("nats://#{user}:#{pass}@127.0.0.1:4333") + noauth_uri = URI.parse("nats://127.0.0.1:4333") + auth_server : NATSServer | Nil = nil + + Spec.before_each do + server = NATSServer.start(uri) + end + + Spec.after_each do + server.try(&.shutdown) + server = nil + auth_server.try(&.shutdown) + auth_server = nil + end + + describe "#connect" do + it "connects to the NATS server" do + client = NATS::Client.new(uri).connect + client.status.should eq NATS::Client::Status::CONNECTED + client.@socket.closed?.should be_false + client.close + end + + it "will upgrade to a TLS connection", tags: "slow" do + client = NATS::Client.new(URI.parse("tls://demo.nats.io")).connect + client.@socket.should be_a(OpenSSL::SSL::Socket::Client) + client.status.should eq NATS::Client::Status::CONNECTED + client.close + end + + describe "authentication" do + it "connects with a User/Pass" do + auth_server = NATSServer.start(auth_uri) + client = NATS::Client.new(noauth_uri, user: user, pass: pass).connect + client.status.should eq NATS::Client::Status::CONNECTED + client.close + end + + it "connects with User/Pass URI" do + auth_server = NATSServer.start(auth_uri) + client = NATS::Client.new(auth_uri).connect + client.status.should eq NATS::Client::Status::CONNECTED + client.close + end + + it "fails to connect with wrong User/Pass" do + auth_server = NATSServer.start(auth_uri) + expect_raises(NATS::AuthenticationError) do + client = NATS::Client.new(noauth_uri, user: user, pass: "wrong").connect + end + end + end + end + + describe "*status*" do + it "is DISCONNECTED when first created" do + client = NATS::Client.new(uri) + client.status.should eq NATS::Client::Status::DISCONNECTED + end + + it "is CONNECTED after connecting" do + client = NATS::Client.new(uri).connect + client.status.should eq NATS::Client::Status::CONNECTED + client.close + end + + it "is CLOSED after closing" do + client = NATS::Client.new(uri).connect + client.close + client.status.should eq NATS::Client::Status::CLOSED + end + + it "is CLOSED if the server closes" do + client = NATS::Client.new(uri).connect + server.try(&.shutdown) + sleep 1.millisecond # Allow time for the client to detect the server shutdown + client.status.should eq NATS::Client::Status::CLOSED + end + end + + describe "#connected?" do + it "is connected to the server" do + client = NATS::Client.new(uri).connect + (client.connected?).should be_true + client.close + end + + it "is not connected when the socket is closed" do + client = NATS::Client.new(uri).connect + client.close + (client.connected?).should be_false + end + end + + describe "#subscribe" do + it "returns a Subscription object" do + client = NATS::Client.new(uri).connect + subject = "spec.nats.client.subscribe" + + subscription = client.subscribe(subject) do |msg| + # Do nothing + end + + subscription.should be_a(NATS::Subscription) + subscription.subject.should eq subject + client.close + end + + it "subscribes to a subject and receives messages" do + client = NATS::Client.new(uri).connect + subject = "spec.nats.client.subscribe" + message = "Test message" + + received_messages = [] of String + client.subscribe(subject) do |msg| + received_messages << msg.payload.to_s + end + + client.publish(subject, message) + sleep 1.millisecond # Allow time for the message to be processed + + received_messages.should eq [message] + client.close + end + + it "subscribes and can reply" do + client = NATS::Client.new(uri).connect + subject = "spec.nats.client.subscribe" + + client.subscribe(subject) do |msg| + msg.reply("PONG") + end + + response = client.request(subject, "PING") + + response.try &.payload.should eq "PONG" + client.close + end + end + + describe "#publish" do + it "raises an error if subject is empty" do + client = NATS::Client.new(uri).connect + expect_raises(ArgumentError) do + client.publish("", "Test message") + end + client.close + end + end + + describe "#request" do + it "should raise +NATS::TimeoutError+ if request takes too long" do + client = NATS::Client.new(uri).connect + subject = "spec.nats.client.subscribe" + + client.subscribe(subject) do |msg| + sleep 10.milliseconds + msg.reply("PONG") + rescue + end + + expect_raises(NATS::TimeoutError) do + client.request(subject, "PING", 5.milliseconds) + end + + client.close + end + + it "should accept async requests" do + client = NATS::Client.new(uri).connect + subject = "spec.nats.client.subscribe" + + client.subscribe(subject) do |msg| + msg.reply("PONG") + end + + response = "" + client.request(subject, "PING") do |msg| + response = "PONG" + end + sleep 1.millisecond # Allow time for the async request to be processed + response.should eq "PONG" + + client.close + end + end +end diff --git a/spec/nats/tls_spec.cr b/spec/nats/tls_spec.cr deleted file mode 100644 index 8d89be6..0000000 --- a/spec/nats/tls_spec.cr +++ /dev/null @@ -1,26 +0,0 @@ -require "../spec_helper" - -describe "NATS::Connection#TLS" do - tls_uri = "tls://demo.nats.io" - - describe "#new" do - it "should connect to a TLS based server" do - nc = NATS::Connection.new(tls_uri) - nc.should_not be_nil - nc.close - end - end - - describe "#subscribe" do - it "Should receive messages it subscribed to" do - nc = NATS::Connection.new(tls_uri) - inbox = nc.new_inbox - ch = Channel(Bool).new - ch = Channel(Bool).new - nc.subscribe(inbox) { ch.send(true) } - nc.publish(inbox, "Hello!") - wait(ch) - nc.close - end - end -end diff --git a/spec/nats_spec.cr b/spec/nats_spec.cr index 99a24e5..5173699 100644 --- a/spec/nats_spec.cr +++ b/spec/nats_spec.cr @@ -1,2 +1,38 @@ +# Copyright 2019-2025 The NATS Authors +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + require "./spec_helper" require "./nats/*" + +describe NATS do + uri = URI.parse("nats://127.0.0.1:4322") + server : NATSServer | Nil = nil + + Spec.before_each do + server = NATSServer.start(uri) + end + + Spec.after_each do + server.try(&.shutdown) + server = nil + end + + describe "#connect" do + it "returns a NATS::Client" do + client = NATS.connect(uri) + client.should be_a(NATS::Client) + client.close + end + end +end diff --git a/spec/spec_helper.cr b/spec/spec_helper.cr index 5607b86..0d4490b 100644 --- a/spec/spec_helper.cr +++ b/spec/spec_helper.cr @@ -1,20 +1,34 @@ +# Copyright 2019-2025 The NATS Authors +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + require "spec" require "socket" require "../src/nats" -require "../src/nats/connection" +require "../src/nats/client" class NATSServer getter? was_running - def self.start(uri = NATS::CONNECTION::DEFAULT_URI) + def self.start(uri = NATS::Client::DEFAULT_URI) server = NATSServer.new(uri) server.start(true) return server end - getter uri + getter uri : URI - def initialize(uri = NATS::CONNECTION::DEFAULT_URI, flags : String? = nil, config_file : String? = nil) + def initialize(uri = NATS::Client::DEFAULT_URI, flags : String? = nil, config_file : String? = nil) @uri = uri.is_a?(URI) ? uri : URI.parse(uri) @flags = flags @config_file = config_file @@ -31,9 +45,14 @@ class NATSServer end args += " #{@flags}".split if @flags - args << "-DV" if ENV["DEBUG_NATS_TEST"]? == "true" + if ENV["DEBUG_NATS_TEST"]? == "true" + args << "-DV" + kwargs = {output: STDOUT, error: STDERR} + else + kwargs = {output: Process::Redirect::Close, error: Process::Redirect::Close} + end - @p = Process.new("nats-server", args) + @p = Process.new("nats-server", args, **kwargs) raise "Server could not start, already running?" if @p.nil? || @p.try(&.terminated?) wait_for_server(@uri, 10) if wait_for_server end diff --git a/src/nats.cr b/src/nats.cr index 2f6aebf..601375f 100644 --- a/src/nats.cr +++ b/src/nats.cr @@ -1,3 +1,15 @@ require "./nats/*" -# TODO: Write documentation for `NATS` +module NATS + VERSION = {{ `shards version #{__DIR__}`.chomp.stringify }} + + # Connects to a NATS server using the provided URI. + # + # *uri*: The URI of the NATS server to connect to. + def self.connect(uri : String | URI = Client::DEFAULT_URI) : Client + Client.new(uri).connect + end + + # :nodoc: + private CR_LF = "\r\n" +end diff --git a/src/nats/client.cr b/src/nats/client.cr new file mode 100644 index 0000000..188a025 --- /dev/null +++ b/src/nats/client.cr @@ -0,0 +1,485 @@ +# Copyright 2019-2025 The NATS Authors +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +require "json" +require "openssl" +require "random/secure" +require "socket" +require "uri" + +require "./errors" +require "./nuid" +require "./options" +require "./client/*" +require "./message/*" + +module NATS + # NATS Client for connecting to a NATS server.\ + # This client allows you to subscribe and publish messages. + # + # Example: + # ``` + # require "nats/client" + # + # client = NATS::Client.new("nats://localhost:4222") + # client.connect + # + # client.subscribe("foo") do |msg| + # puts "Received message on subject #{msg.subject}: #{msg.payload}" + # end + # + # client.publish("foo", "Hello, NATS!") + # + # client.subscribe("bar") do |msg| + # msg.reply "Received your message on bar: #{msg.payload}" + # end + # + # response = client.request("bar", "Hello, bar!") + # puts "Received response: #{response.payload}" + # + # client.request("bar") do |msg| + # puts "Recieved async response: #{msg.payload}" + # end + # + # client.close + # ``` + class Client + # Default Port for NATS Server + DEFAULT_PORT = 4222 + # Default Host for NATS Server + DEFAULT_HOST = "localhost" + # Default URI for NATS Server + DEFAULT_URI = URI.parse "nats://#{DEFAULT_HOST}:#{DEFAULT_PORT}" + # Buffer Size for the socket + BUFFER_SIZE = 32_768 + + # The current status of the client connection. + getter status : Status = Status::DISCONNECTED + + @uri : URI + @server_info : Message::INFO | Nil + @subs : Hash(UInt64, Subscription) = Hash(UInt64, Subscription).new + @sid : UInt64 = 0 + @socket : TCPSocket | OpenSSL::SSL::Socket::Client + @socket_mutex : Mutex = Mutex.new + @pongs : Deque(Channel(Nil)) = Deque(Channel(Nil)).new + + def initialize( + uri : String | URI = DEFAULT_URI, + @options : Options = Options.new, + @user : String? = nil, + @pass : String? = nil, + @jwt : String? = nil, + ) + @uri = uri.is_a?(URI) ? uri : URI.parse(uri) + @user = @uri.user if @user.nil? && @uri.user + @pass = @uri.password if @pass.nil? && @uri.password + @socket = uninitialized TCPSocket + + # Inbox setup + @nuid = NUID.new + @resp_sub_prefix = "_INBOX.#{@nuid.next}" + end + + # Connects to the NATS server + def connect : self + @status = Status::CONNECTING + setup_socket + + # Get server info + handle_info(parse_info(@socket.read_line)) + + # Time to connect! + send_connect + first_connection_ok? + @status = Status::CONNECTED + + # Handle inbound messages + spawn handle_messages + # Handle async outbound messages + spawn flush + + self + end + + # Subscribe to a subject, messages will be delivered to the provided callback. + # + # *subject*: The subject to subscribe to.\ + # *queue_group*: Optional queue group for load balancing.\ + # *callback*: The callback to handle incoming messages. + def subscribe(subject : String, queue_group : String? = nil, &callback : Message::MSG -> Nil) : Subscription + raise ClientClosedError.new if status == Status::CLOSED + + sid = next_sid + sub = Subscription.new( + subject: subject, + sid: sid, + callback: callback, + client: self, + queue_group: queue_group + ) + + msg = Message::SUB.new( + subject: subject, + queue_group: queue_group, + sid: sid.to_s + ) + send_msg!(msg.to_s) + @subs[sid] = sub + end + + # Unsubscribes from a subject. + # + # *sub*: The subscription to unsubscribe from. + def unsubscribe(sub : Subscription) + raise ClientClosedError.new if status == Status::CLOSED + + sid = sub.sid + unsub = Message::UNSUB.new(sid: sid.to_s) + send_msg!(unsub.to_s) + @subs.delete(sid) + end + + # Publishes a message to the specified subject. + # + # *subject*: The subject to publish to.\ + # *payload*: The message payload. + def publish(subject : String, payload : String) + raise ClientClosedError.new if status == Status::CLOSED + + msg = Message::PUB.new( + subject: subject, + payload: payload + ) + send_msg!(msg.to_s) + end + + # Publishes a message to the specified subject and waits for a response. + # + # *subject*: The subject to publish to.\ + # *payload*: The message payload.\ + # *timeout*: Optional timeout for waiting for a response. Will use `Options.timeout` if not set. + def request(subject : String, payload : String, timeout : Time::Span? = nil) : Message::MSG + raise ClientClosedError.new if status == Status::CLOSED + + msg = Message::PUB.new( + subject: subject, + reply_to: new_inbox, + payload: payload + ) + send_msg!(msg.to_s) + channel = Channel(Message::MSG).new + reply_sub = subscribe(msg.reply_to.to_s) do |response_msg| + channel.send(response_msg) + end + spawn do + sleep timeout || @options.timeout + channel.close + end + + begin + channel.receive + rescue + raise TimeoutError.new("Request Timeout") + end + ensure + @subs[reply_sub.try(&.sid)].unsubscribe if @subs.has_key?(reply_sub.try(&.sid)) + @subs.delete(reply_sub.try(&.sid)) if reply_sub.try(&.sid) + end + + # Publishes a message to the specified subject and sends response to callback when available. + # + # *subject*: The subject to publish to.\ + # *payload*: The message payload.\ + # *callback*: Callback to handle the response message. + def request(subject : String, payload : String, &callback : Message::MSG -> Nil) + raise ClientClosedError.new if status == Status::CLOSED + + msg = Message::PUB.new( + subject: subject, + reply_to: new_inbox, + payload: payload + ) + send_msg(msg.to_s) + spawn do + channel = Channel(Message::MSG).new + reply_sub = subscribe(msg.reply_to.to_s) do |response_msg| + channel.send(response_msg) + end + callback.call(channel.receive) + ensure + @subs[reply_sub.try(&.sid)].unsubscribe if @subs.has_key?(reply_sub.try(&.sid)) + @subs.delete(reply_sub.try(&.sid)) if reply_sub.try(&.sid) + end + end + + # Closes the NATS connection and cleans up resources. + def close + return if status == Status::CLOSED + + # Close all subscriptions + @status = Status::DRAINING_SUBS + @subs.each_value(&.unsubscribe) + @subs.clear + + # Holding the mutex to ensure no other operations are performed while closing + @socket_mutex.synchronize do + @pongs.each(&.close) # Close all pending PONG channels + @pongs.clear + + unless @socket.closed? + @status = Status::DRAINING_PUBS + @socket.flush + @socket.close + end + @status = Status::CLOSED + end + end + + # Checks if the client is connected to the NATS server.\ + # Will send a PING message and wait for a PONG response. + def connected? : Bool + return false if status == Status::CLOSED + + channel = Channel(Nil).new + @pongs.push(channel) + send_msg!("PING") + spawn do + sleep @options.timeout + channel.close + end + channel.receive rescue {raise TimeoutError.new("PING timeout")} + true + end + + # Regex patterns for parsing NATS protocol messages from the server + + # INFO - Sent to client after initial TCP/IP connection.\ + # SEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#info + private INFO = /\AINFO\s+(?[^\r\n]+)/i + # MSG - Delivers a message payload to a subscriber.\ + # SEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#msg + private MSG = /\AMSG\s+(?[^\s]+)\s+(?[^\s]+)\s+(?:(?[^\s]+)\s+)?(?\d+)/i + # HMSG - Delivers a message payload to a subscriber with NATS headers.\ + # SEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#hmsg + private HMSG = /\AHPUB\s+(?[^\s]+)\s+(?[^\s]+)\s+(?:(?[^\s]+)\s+)?(?\d+)\s+(?\d+)/i + # PING - keep-alive message.\ + # SEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#ping-pong + private PING = /\APING\s*/i + # PONG - keep-alive response.\ + # SEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#ping-pong + private PONG = /\APONG\s*/i + # ERR - Indicates a protocol error. May cause client disconnect.\ + # SEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#ok-err + private ERR = /\A-ERR\s+'(?.+)?'/i + # OK - Acknowledges well-formed protocol message in verbose mode.\ + # SEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#ok-err + private OK = /\A\+OK\s*/i + + # Handles incoming messages from the server. + # + # NOTE: This is intended to be run in a separate fiber. + private def handle_messages + until status == Status::CLOSED + case line = @socket.gets(CR_LF) + when INFO + handle_info(parse_info(line.to_s)) + when PING + send_msg!("PONG") + when PONG + channel = @pongs.pop? + channel.try &.send(nil) # Notify the waiting channel that a PONG was received + when ERR + raise ERRError.new($~["message"] || "Unknown error") + when OK + next + when MSG + bytes = $~["bytes"].to_i64 + if bytes > 0 + payload = Bytes.new(bytes) + @socket.read_fully(payload) + payload = String.new(payload) + else + payload = nil + end + 2.times { @socket.read_byte } # Consume the trailing "\r\n" after the payload + + msg = Message::MSG.new( + subject: $~["subject"], + sid: $~["sid"].to_i64, + reply_to: $~["reply"]? || nil, + payload: payload, + bytes: bytes, + client: self + ) + @subs[msg.sid].callback.call(msg) + when HMSG + next # TODO: Handle HMSG + else + return close if @socket.closed? || line.nil? # Socket has been closed on us + + raise Error.new("Unexpected response from server: #{line}") + end + end + rescue e : IO::Error + return if status == Status::CLOSED # The socket may have been closed on us while waiting for messages + raise e + rescue e : IO::EOFError + return close # Socket has been closed on us + end + + # Parses the INFO message from the server. + private def parse_info(info : String) : Message::INFO + if match = INFO.match(info) + Message::INFO.from_json(match["options"].to_s) + else + raise Error.new("Invalid INFO message: #{info}") + end + end + + private def handle_info(info : Message::INFO) + @server_info = info + tls_upgrade if (@server_info.try(&.tls_required) || @uri.scheme == "tls") && !@socket.is_a?(OpenSSL::SSL::Socket::Client) + end + + # Sets up the socket connection to the NATS server. + private def setup_socket + @socket_mutex.synchronize do + @socket = TCPSocket.new(@uri.host || DEFAULT_HOST, @uri.port || DEFAULT_PORT) + @socket.as(TCPSocket).tcp_nodelay = true + @socket.as(TCPSocket).sync = true + @socket.as(TCPSocket).read_buffering = true + @socket.as(TCPSocket).buffer_size = BUFFER_SIZE + @socket.as(TCPSocket).write_timeout = @options.timeout + end + end + + # Upgrades the socket to use TLS if required by the server. + private def tls_upgrade + @socket_mutex.synchronize do + @socket = OpenSSL::SSL::Socket::Client.new(@socket) + @socket.as(OpenSSL::SSL::Socket::Client).sync_close = true + @socket.as(OpenSSL::SSL::Socket::Client).sync = true + @socket.as(OpenSSL::SSL::Socket::Client).read_buffering = true + @socket.as(OpenSSL::SSL::Socket::Client).buffer_size = BUFFER_SIZE + @socket.as(OpenSSL::SSL::Socket::Client).write_timeout = @options.timeout + end + end + + # Sends a CONNECT message to the NATS server. + private def send_connect + msg = Message::CONNECT.new + msg.pedantic = @options.pedantic + msg.user = @user if @user + msg.pass = @pass if @pass + msg.jwt = @jwt if @jwt + msg.sig = @server_info.try &.nonce + msg.tls_required = true if @uri.scheme == "tls" + + send_msg!(msg.to_s) + end + + # Used during the initial connection to the NATS server. + private def first_connection_ok? : Bool + send_msg!("PING") + read_timeout! do + case line = @socket.gets(CR_LF) + when PONG + true + when ERR + if $~["message"] =~ /Authorization Violation\z/ + raise AuthenticationError.new + else + raise ERRError.new($~["message"] || "Unknown error") + end + else + raise Error.new("Unexpected response from server: #{line}") + end + end + end + + # Sends a message to the NATS server.\ + # Doesn't wait for other messages to be written to the socket. + # + # *msg*: The message to send. + protected def send_msg!(msg : String) + raise ClientClosedError.new if status == Status::CLOSED + + @socket_mutex.synchronize do + @socket.write((msg + CR_LF).to_slice) + @socket.flush + end + end + + # Sends a message to the NATS server to be sent later. + # + # *msg*: The message to send. + protected def send_msg(msg : String) + raise ClientClosedError.new if status == Status::CLOSED + + @socket_mutex.synchronize do + @socket.write((msg + CR_LF).to_slice) + end + end + + # Flushes the socket periodically to handle async messages. + # + # NOTE: This is intended to be run in a separate fiber. + private def flush + until status == Status::CLOSED + @socket_mutex.synchronize do + @socket.flush + end + sleep @options.flush_interval + end + end + + private def next_sid : UInt64 + @sid += 1 + end + + # Use the same inbox suffix length as nats.go.\ + # SEE: https://github.com/nats-io/nats.go/blob/8a48023f77877dcfc140d0b9c25603c6cbedfaab/nats.go#L4239 + private TOKEN_LENGTH = 8 + + private def new_inbox : String + reply_sub_suffix = String::Builder.build(TOKEN_LENGTH) do |io| + Random::Secure.random_bytes(TOKEN_LENGTH).each do |n| + io << NUID::DIGITS[n % NUID::BASE] + end + end + "#{@resp_sub_prefix}.#{reply_sub_suffix}" + end + + # Enables temporary read timeout for the socket.\ + # This is useful for operations that may block indefinitely, such as waiting for a PONG response. + private def read_timeout!(&) + if @socket.is_a?(OpenSSL::SSL::Socket::Client) + @socket.as(OpenSSL::SSL::Socket::Client).read_timeout = @options.timeout + else + @socket.as(TCPSocket).read_timeout = @options.timeout + end + + begin + yield + ensure + if @socket.is_a?(OpenSSL::SSL::Socket::Client) + @socket.as(OpenSSL::SSL::Socket::Client).read_timeout = nil + else + @socket.as(TCPSocket).read_timeout = nil + end + end + end + end +end diff --git a/src/nats/client/status.cr b/src/nats/client/status.cr new file mode 100644 index 0000000..36bcebb --- /dev/null +++ b/src/nats/client/status.cr @@ -0,0 +1,40 @@ +# Copyright 2019-2025 The NATS Authors +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +module NATS + class Client + enum Status + # When the client is not actively connected. + DISCONNECTED + + # When the client is connected. + CONNECTED + + # When the client will no longer attempt to connect to a NATS Server. + CLOSED + + # When the client has disconnected and is attempting to reconnect. + RECONNECTING + + # When the client is attempting to connect to a NATS Server for the first time. + CONNECTING + + # When the client is draining a connection before closing. + DRAINING_SUBS + + # :ditto: + DRAINING_PUBS + end + end +end diff --git a/src/nats/connection.cr b/src/nats/connection.cr deleted file mode 100644 index 9b2541b..0000000 --- a/src/nats/connection.cr +++ /dev/null @@ -1,550 +0,0 @@ -# Copyright 2019-2020 The NATS Authors -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -require "socket" -require "uri" -require "json" -require "openssl" - -require "./nuid" -require "./msg" -require "./subscription" - -module NATS - VERSION = "0.0.2" - LANG = "crystal" - - class Connection - # :nodoc: - DEFAULT_PORT = 4222 - # :nodoc: - DEFAULT_AUTH_PORT = 4443 - # :nodoc: - DEFAULT_PRE = "nats://127.0.0.1:" - # :nodoc: - DEFAULT_URI = URI.parse("#{DEFAULT_PRE}#{DEFAULT_PORT}") - # :nodoc: - BUFFER_SIZE = 32768 - # :nodoc: - MAX_PAYLOAD = 1_000_000 - - getter? closed - getter max_payload - - # Creates a new connection to a NATS Server. - # - # ``` - # nc = NATS::Connection.new("demo.nats.io") - # nc = NATS::Connection.new("tls://demo.nats.io") - # nc = NATS::Connection.new("nats://#{user}:#{pass}@127.0.0.1:4222") - # nc = NATS::Connection.new(4222, name: "Sample App", user: "derek", pass: "s3cr3t") - # nc = NATS::Connection.new(4222) - # nc = NATS::Connection.new - # ``` - def initialize( - host, port, - @user : String? = nil, - @pass : String? = nil, - @name : String? = nil, - @echo = true, - @pedantic = false - ) - # For new style INBOX behavior. - @nuid = NUID.new - @resp_sub_prefix = "_INBOX.#{@nuid.next}" - @rand = Random.new - - # This will be updated when we receive an INFO from the server. - @max_payload = MAX_PAYLOAD - - # For flush - @pongs = Deque(Channel(Nil)).new - - # FIXME(dlc) - timeouts on connect. - # dns_timeout = nil, connect_timeout = nil - @socket = TCPSocket.new(host, port) - if (s = @socket).is_a?(TCPSocket) - s.tcp_nodelay = true - s.sync = false - s.read_buffering = true - s.buffer_size = BUFFER_SIZE - end - - # For efficient batched writes - @out = Mutex.new - - @closed = false - @gsid = 0 - @subs = {} of Int32 => (Subscription | InternalSubscription) - @resp_map = {} of String => Channel(Msg?) - @resp_sub_created = false - - # read in the INFO block here inline before we start up - # the inbound fiber. - # TODO(dlc) put read timeout here. - @server_info = uninitialized Hash(String, JSON::Any) - process_first_info - - # send connect - send_connect - - # send ping and expect pong. - connect_ok? - - # spawn our inbound processing fiber - spawn inbound - - # spawn for our outbound - spawn outbound - end - - # :nodoc: - def self.new(**args) - new(DEFAULT_URI, **args) - end - - # :nodoc: - def self.new(port : Int, **args) - new(URI.parse("#{DEFAULT_PRE}#{port}"), **args) - end - - # :nodoc: - def self.new(url : String, **args) - # We want to allow simple strings, e.g. demo.nats.io - # so make sure to add on scheme and port if needed. - url = "nats://#{url}" unless url.includes? "://" - unless url.index(/:\d/) != nil - url = "#{url}:#{DEFAULT_PORT}" if url.starts_with? "nats" - url = "#{url}:#{DEFAULT_AUTH_PORT}" if url.starts_with? "tls" - end - new(URI.parse(url), **args) - end - - # :nodoc: - def self.new(uri : URI, **args) - host = uri.host - port = uri.port - raise "Invalid URI" if host.nil? || port.nil? - new(host, port, uri.user, uri.password, **args) - end - - private def out_sync - @out.synchronize do - yield - end - end - - private def check_size(data) - if data.size > @max_payload - raise "Payload too big" - end - end - - # Publishes a messages to a given subject. - # - # ``` - # nc = NATS::Connection.new("demo.nats.io") - # nc.publish("foo", "Hello!") - # ``` - def publish(subject : String, msg) - # raise ArgumentError.new("Connection closed") if closed? - raise "Bad Subject" if subject.empty? - raise "Connection Closed" if closed? - - data = msg.to_slice - check_size(data) - - @out.synchronize do - @socket.write(PUB_SLICE) - @socket.write(subject.to_slice) - @socket << ' ' << data.size - @socket.write(CR_LF_SLICE) - @socket.write(data) - @socket.write(CR_LF_SLICE) - end - end - - # Publishes an empty message to a given subject. - # - # ``` - # nc = NATS::Connection.new("demo.nats.io") - # nc.publish("foo") - # ``` - def publish(subject : String) - raise "Bad Subject" if subject.empty? - raise "Connection Closed" if closed? - - @out.synchronize do - @socket.write(PUB_SLICE) - @socket.write(subject.to_slice) - @socket.write(" 0\r\n\r\n".to_slice) - end - end - - # Publishes a messages to a given subject with a reply subject. - # - # ``` - # nc = NATS::Connection.new("demo.nats.io") - # nc.publish_with_reply("foo", "reply", "Hello!") - # ``` - def publish_with_reply(subject, reply : String, msg = nil) - raise "Bad Subject" if subject.empty? - raise "Connection Closed" if closed? - - if msg - data = msg.to_slice - check_size(data) - else - data = Bytes.empty - end - - @out.synchronize do - @socket.write(PUB_SLICE) - @socket.write(subject.to_slice) - @socket << ' ' - @socket.write(reply.to_slice) - @socket << ' ' << data.size - @socket.write(CR_LF_SLICE) - @socket.write(data) - @socket.write(CR_LF_SLICE) - end - end - - # Flush will flush the connection to the server. Can specify a *timeout*. - def flush(timeout = 2.second) - ch = Channel(Nil).new - @pongs.push(ch) - @out.synchronize { @socket.write(PING_SLICE) } - flush_outbound - spawn { sleep timeout; ch.close } - ch.receive rescue {raise "Flush Timeout"} - end - - def new_inbox - "#{@resp_sub_prefix}.#{inbox_token}" - end - - # :nodoc: - TOKEN_LENGTH = 8 # Matches Go implementation - - private def inbox_token - rn = @rand.rand(Int64::MAX) - String::Builder.build(TOKEN_LENGTH) do |io| - (0...TOKEN_LENGTH).each do - io << NUID::DIGITS[rn % NUID::BASE] - rn //= NUID::BASE - end - end - end - - private def create_resp_subscription - return if @resp_sub_created - @resp_sub_created = true - internal_subscribe("#{@resp_sub_prefix}.*") - end - - protected def handle_resp(msg) - token = msg.subject[@resp_sub_prefix.size + 1..-1] - ch = @resp_map[token] - ch.send(msg) - @resp_map.delete(token) - end - - # Request will send a request to the given subject and wait up to *timeout* for a response. - # - # ``` - # nc = NATS::Connection.new("demo.nats.io") - # answer = nc.request("req", "Help!") - # puts "Received a response '#{answer}'!" - # ``` - def request(subject : String, msg?, timeout = 2.second) - create_resp_subscription unless @resp_sub_created - token = inbox_token - reply = "#{@resp_sub_prefix}.#{token}" - ch = Channel(Msg?).new - @resp_map[token] = ch - publish_with_reply(subject, reply, msg?) - spawn { sleep timeout; ch.close } - begin - msg = ch.receive - rescue - @resp_map.delete(token) - raise "Request Timeout" - end - end - - private def internal_subscribe(subject : String) - sid = @gsid += 1 - @out.synchronize do - @socket.write("SUB ".to_slice) - @socket.write(subject.to_slice) - @socket << ' ' << sid - @socket.write(CR_LF_SLICE) - end - - InternalSubscription.new(sid, self).tap do |sub| - @subs[sid] = sub - end - end - - # Subscribe to a given subject. Will yield to the callback provided with the message received. - # - # ``` - # nc = NATS::Connection.new("demo.nats.io") - # nc.subscribe("foo") { |msg| puts "Received '#{msg}'" } - # ``` - def subscribe(subject : String, &callback : Msg ->) - sid = @gsid += 1 - @out.synchronize do - @socket.write("SUB ".to_slice) - @socket.write(subject.to_slice) - @socket << ' ' << sid - @socket.write(CR_LF_SLICE) - end - - Subscription.new(sid, self, callback).tap do |sub| - @subs[sid] = sub - end - end - - # Subscribe to a given subject with the queue group. Will yield to the callback provided with the message received. - # - # ``` - # nc = NATS::Connection.new("demo.nats.io") - # nc.subscribe("foo", "group1") { |msg| puts "Received '#{msg}'" } - # ``` - def subscribe(subject, queue : String, &callback : Msg ->) - sid = @gsid += 1 - @out.synchronize do - @socket.write("SUB ".to_slice) - @socket.write(subject.to_slice) - @socket << ' ' - @socket.write(queue.to_slice) - @socket << ' ' << sid - @socket.write(CR_LF_SLICE) - end - - Subscription.new(sid, self, callback).tap do |sub| - @subs[sid] = sub - end - end - - def subscribe(subject : String, queue : String | Nil, &callback : Msg ->) - return subscribe(subject, queue, &callback) if queue.is_a?(String) - subscribe(subject, &callback) - end - - protected def unsubscribe(sid) - return if closed? - @out.synchronize do - @socket.write("UNSUB ".to_slice) - @socket << sid - @socket.write(CR_LF_SLICE) - end - end - - # Close a connection to the NATS server. - # - # ``` - # nc = NATS::Connection.new("demo.nats.io") - # nc.close - # ``` - def close - return if @closed - @closed = true - flush_outbound - @socket.close unless @socket.closed? - rescue - ensure - @subs.each { |sid, sub| sub.unsubscribe } - # TODO(dlc) - pop any calls in flush. - @close_cb.try do |cb| - spawn cb.call - end - end - - # Setup a callback for when the connection closes. - # - # ``` - # nc = NATS::Connection.new("demo.nats.io") - # nc.on_close { puts "Connection closed!" } - # nc.close - # ``` - def on_close(&callback) - @close_cb = callback - end - - # Setup a callback for an async errors that are received. - # - # ``` - # nc = NATS::Connection.new("demo.nats.io") - # nc.on_error { |e| puts "Received an error #{e}" } - # ``` - def on_error(&callback : String ->) - @err_cb = callback - end - - # :nodoc: - def finalize - close unless closed? - end - - # :nodoc: - INFO = /\AINFO\s+([^\r\n]+)/i - # :nodoc: - MSG = /\AMSG\s+([^\s]+)\s+([^\s]+)\s+(([^\s]+)[^\S\r\n]+)?(\d+)/i - # :nodoc: - PING = /\APING\s*/i - # :nodoc: - PONG = /\APONG\s*/i - # :nodoc: - ERR = /\A-ERR\s+('.+')?/i - # :nodoc: - OK = /\A\+OK\s*/i - - # :nodoc: - CR_LF = "\r\n" - # :nodoc: - CR_LF_SLICE = CR_LF.to_slice - # :nodoc: - PUB_SLICE = "PUB ".to_slice - # :nodoc: - PING_SLICE = "PING\r\n".to_slice - # :nodoc: - PONG_SLICE = "PONG\r\n".to_slice - - # TODO(dlc) - Performance is off from what I expected. Blind read *should* be handled by IO::Buffered. - # Should try manual blind read and hand rolled parser similar to Golang. Also make sure Channels is not slowdown. - private def inbound - until closed? - case data = @socket.gets '\n' - when Nil # Remove this from the compile-time type - close - when .starts_with?("MSG ") - starting_point = 4 # "MSG " - if (subject_end = data.index(' ', starting_point)) && (sid_end = data.index(' ', subject_end + 1)) - subject = data[starting_point...subject_end] - sid = data[subject_end + 1...sid_end].to_i - - # Figure out if we got a reply_to and set it and bytesize accordingly - reply_to_with_byte_size = data[sid_end + 1...-2] - if boundary = reply_to_with_byte_size.index(' ') - reply_to = reply_to_with_byte_size[0...boundary] - bytesize = reply_to_with_byte_size[boundary + 1..-1].to_i - else - bytesize = reply_to_with_byte_size.to_i - end - else - raise Exception.new("Invalid message declaration: #{data}") - end - - payload = Bytes.new(bytesize) - @socket.read_fully?(payload) || raise "Unexpected EOF" - 2.times { @socket.read_byte } # CRLF - - @subs[sid].send(Msg.new(subject, payload, reply_to, self)) - when PING - @out.synchronize { @socket.write(PONG_SLICE) } - flush_outbound - when PONG - ch = @pongs.pop? - ch.send(nil) unless ch.nil? - when OK - when ERR - # TODO(dlc) - Not default to puts? - puts "NATS: Received an ERR #{$1}" if @err_cb.nil? - @err_cb.try do |cb| - cb.call($1) - end - else - raise "Protocol Error" unless data.to_s.empty? - close - end - end - rescue ex - close - end - - private def flush_outbound - @out.synchronize do - @socket.flush unless @socket.closed? - end - rescue - end - - private def outbound - until closed? - sleep 3.milliseconds - flush_outbound - end - end - - private def connect_ok? - auth_required = @server_info["auth_required"].as_bool rescue false - tls_required = @server_info["tls_required"].as_bool rescue false - return unless auth_required || tls_required - # Don't need synchronize yet. - - @socket.write(PING_SLICE) - @socket.flush - case data = @socket.gets(CR_LF) - when PONG - return - when ERR - raise $1 - else - raise "Connection Terminated" - end - end - - private def process_first_info - # TODO(dlc) - timeouts - line = @socket.read_line - - # TODO(dlc) - Could use JSON.mapping here with Info class. - if match = line.match(INFO) - info_json = match.captures.first - @server_info = JSON.parse(info_json.to_s).as_h - if max_payload = @server_info["max_payload"]? - @max_payload = max_payload.as_i - end - else - raise "INFO not valid" - end - - # FIXME(dlc) - client side certs, etc. - tls_required = @server_info["tls_required"].as_bool rescue false - @socket = OpenSSL::SSL::Socket::Client.new(@socket) if tls_required - end - - private def send_connect - @socket << "CONNECT " - JSON.build(@socket) do |json| - json.object do - json.field "verbose", false - json.field "pedantic", @pedantic - json.field "lang", LANG - json.field "version", VERSION - json.field "protocol", 1 - - json.field "name", @name.to_s if @name - - json.field "user", @user.to_s if @user - json.field "pass", @pass.to_s if @pass - end - end - @socket << "\r\n" - end - end -end diff --git a/src/nats/errors.cr b/src/nats/errors.cr new file mode 100644 index 0000000..fe262d9 --- /dev/null +++ b/src/nats/errors.cr @@ -0,0 +1,55 @@ +# Copyright 2019-2025 The NATS Authors +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +module NATS + # Generic NATS exception class. + class Error < Exception + end + + # +ClientClosed+ is raised when `NATS::Client.status == +NATS::Client::Status::CLOSED`\ + # Usually due to the socket being closed. + class ClientClosedError < Error + def initialize(msg = "Client is closed") + super(msg) + end + end + + # +Timeout+ is raised when `NATS::Options.timeout` is reached. + class TimeoutError < Error + def initialize(msg = "Timeout occurred") + super(msg) + end + end + + # +-ERR+ is raised when the NATS server indicates a protocol error. + class ERRError < Error + def initialize(msg = "Unknown error") + super(msg) + end + end + + # +AuthenticationError+ is raised when the NATS server indicates an authentication error. + class AuthenticationError < ERRError + def initialize(msg = "Authentication failed") + super(msg) + end + end + + # +MSGError+ is raised when there is a problem with a +NATS::Message::MSG+. + class MSGError < Error + def initialize(msg = "MSG error") + super(msg) + end + end +end diff --git a/src/nats/message/connect.cr b/src/nats/message/connect.cr new file mode 100644 index 0000000..3f59138 --- /dev/null +++ b/src/nats/message/connect.cr @@ -0,0 +1,76 @@ +# Copyright 2019-2025 The NATS Authors +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +module NATS + module Message + # The CONNECT message is the client version of the INFO message.\ + # Once the client has established a TCP/IP socket connection with the NATS server, + # and an INFO message has been received from the server, + # the client may send a CONNECT message to the NATS server to provide more + # information about the current connection as well as security information. + # + # SEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#connect + struct CONNECT + # Turns on +OK protocol acknowledgements. + property verbose : Bool? = false + # Turns on additional strict format checking, e.g. for properly formed subjects. + property pedantic : Bool? = false + # Indicates whether the client requires an SSL connection. + property tls_required : Bool? = false + # Client authorization token. + property auth_token : String? = nil + # Connection username. + property user : String? = nil + # Connection password. + property pass : String? = nil + # Client name. + property name : String? = nil + # The implementation language of the client. + property lang : String? = "crystal" + # The version of the client. + property version : String? = NATS::VERSION + # Sending `0` (or absent) indicates client supports original protocol. + # Sending `1` indicates that the client supports dynamic reconfiguration + # of cluster topology changes by asynchronously receiving INFO messages with known servers it can reconnect to. + # TODO: Support dynamic reconfiguration in the future + property protocol : Int32? = 0 + # If set to false, the server (version 1.2.0+) will not send originating messages from this connection to its own subscriptions. + # Clients should set this to false only for server supporting this feature, + # which is when proto in the INFO protocol is set to at least `1`. + property echo : Bool? = nil + # In case the server has responded with a nonce on INFO, + # then a NATS client must use this field to reply with the signed nonce. + property sig : String? = nil + # The JWT that identifies a user permissions and account. + property jwt : String? = nil + # Enable quick replies for cases where a request is sent to a topic with no responders. + property no_responders : Bool? = nil + # Whether the client supports headers. + # TODO: Implement headers support + property headers : Bool? = false + # The public NKey to authenticate the client. + # This will be used to verify the signature (sig) against the nonce provided in the INFO message. + property nkey : String? = nil + + def initialize + end + + include JSON::Serializable + + def to_s + "CONNECT #{to_json}" + end + end + end +end diff --git a/src/nats/message/info.cr b/src/nats/message/info.cr new file mode 100644 index 0000000..a17f66f --- /dev/null +++ b/src/nats/message/info.cr @@ -0,0 +1,83 @@ +# Copyright 2019-2025 The NATS Authors +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +module NATS + module Message + # A client will need to start as a plain TCP connection, + # then when the server accepts a connection from the client, + # it will send information about itself, + # the configuration and security requirements necessary for the client to successfully authenticate with the server and exchange messages. + # + # When using the updated client protocol (see `CONNECT`), + # INFO messages can be sent anytime by the server. + # This means clients with that protocol level need to be able to asynchronously handle INFO messages. + # + # SEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#info + struct INFO + include JSON::Serializable + + # The unique identifier of the NATS server. + property server_id : String + # The name of the NATS server. + property server_name : String + # The version of NATS. + property version : String + # The version of golang the NATS server was built with. + property go : String + # The IP address used to start the NATS server, by default this will be 0.0.0.0 and can be configured with -client_advertise host:port. + property host : String + # The port number the NATS server is configured to listen on. + property port : Int32 + # Whether the server supports headers. + property headers : Bool + # Maximum payload size, in bytes, that the server will accept from the client. + property max_payload : Int32 + # An integer indicating the protocol version of the server. + # The server version 1.2.0 sets this to `1` to indicate that it supports the "Echo" feature. + property proto : Int32 + # The internal client identifier in the server. + # This can be used to filter client connections in monitoring, correlate with error logs, etc... + property client_id : UInt64? = nil + # If this is true, then the client should try to authenticate upon connect. + property auth_required : Bool? = false + # If this is true, then the client must perform the TLS/1.2 handshake. + # Note, this used to be ssl_required and has been updated along with the protocol from SSL to TLS. + property tls_required : Bool? = false + # If this is true, the client must provide a valid certificate during the TLS handshake. + property tls_verify : Bool? = false + # If this is true, the client can provide a valid certificate during the TLS handshake. + property tls_available : Bool? = false + # List of server urls that a client can connect to. + property connect_urls : Array(String)? = nil + # List of server urls that a websocket client can connect to. + property ws_connect_urls : Array(String)? = nil + # If the server supports Lame Duck Mode notifications, and the current server has transitioned to lame duck, ldm will be set to true. + property ldm : Bool? = false + # The git hash at which the NATS server was built. + property git_commit : String? = nil + # Whether the server supports JetStream. + property jetstream : Bool? = false + # The IP of the server. + property ip : String? = nil + # The IP of the client. + property client_ip : String? = nil + # The nonce for use in CONNECT. + property nonce : String? = nil + # The name of the cluster. + property cluster : String? = nil + # The configured NATS domain of the server. + property domain : String? = nil + end + end +end diff --git a/src/nats/message/msg.cr b/src/nats/message/msg.cr new file mode 100644 index 0000000..8fc3736 --- /dev/null +++ b/src/nats/message/msg.cr @@ -0,0 +1,68 @@ +# Copyright 2019-2025 The NATS Authors +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +require "./pub" + +module NATS + module Message + # The MSG protocol message is used to deliver an application message to the client. + # + # SEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#msg + struct MSG + # Subject name this message was received on. + property subject : String + # The unique alphanumeric subscription ID of the subject. + property sid : Int64 + # The subject on which the publisher is listening for responses. + property reply_to : String? = nil + # The message payload data. + property payload : String? = nil + # NATS Client for sending replies. + property client : Client? = nil + + def initialize( + @subject : String, + @sid : Int64, + @reply_to : String? = nil, + bytes : Int64 = 0, + @payload : String? = nil, + @client : Client? = nil, + ) + raise MSGError.new("Payload is invalid") if payload && payload.bytesize != bytes + raise MSGError.new("Client needed for reply") if reply_to && client.nil? + end + + # Helper method to return the payload + def to_s : String? + payload + end + + # Reply to this message when the reply_to subject is set. + # + # *payload*: The payload to send in the reply. + def reply(payload : String? = nil) + if reply_to + msg = PUB.new( + subject: reply_to.to_s, + payload: payload + ) + + @client.try &.send_msg!(msg.to_s) + else + raise MSGError.new("reply_to is nil") + end + end + end + end +end diff --git a/src/nats/message/pub.cr b/src/nats/message/pub.cr new file mode 100644 index 0000000..a68a3f1 --- /dev/null +++ b/src/nats/message/pub.cr @@ -0,0 +1,55 @@ +# Copyright 2019-2025 The NATS Authors +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +module NATS + module Message + # The PUB message publishes the message payload to the given subject name, optionally supplying a reply subject.\ + # If a reply subject is supplied, it will be delivered to eligible subscribers along with the supplied payload. + # + # NOTE: that the payload itself is optional. + # + # SEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#pub + struct PUB + # The destination subject to publish to. + property subject : String + # The reply subject that subscribers can use to send a response back to the publisher/requestor. + property reply_to : String? = nil + # The message payload data. + property payload : String? = nil + # The callback to be invoked when a message is received. + property callback : (Message::MSG -> Nil)? = nil # TODO: Handle callback + + def initialize( + @subject : String, + @reply_to : String? = nil, + @payload : String? = nil, + @callback : (Message::MSG -> Nil)? = nil, + ) + raise ArgumentError.new("Subject cannot be empty") if subject.empty? + end + + def to_s + if reply_to.nil? + "PUB #{subject} #{bytes}#{CR_LF}#{payload}" + else + "PUB #{subject} #{reply_to} #{bytes}#{CR_LF}#{payload}" + end + end + + private def bytes + payload.try &.bytesize || 0 + end + end + end +end diff --git a/src/nats/message/sub.cr b/src/nats/message/sub.cr new file mode 100644 index 0000000..6a3ac61 --- /dev/null +++ b/src/nats/message/sub.cr @@ -0,0 +1,44 @@ +# Copyright 2019-2025 The NATS Authors +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +module NATS + module Message + # SUB initiates a subscription to a subject, optionally joining a distributed queue group. + # + # SEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#sub + struct SUB + # The subject name to subscribe to. + property subject : String + # If specified, the subscriber will join this queue group. + property queue_group : String? = nil + # A unique alphanumeric subscription ID, generated by the client. + property sid : String + + def initialize( + @subject : String, + @sid : String, + @queue_group : String? = nil, + ) + end + + def to_s + if queue_group.nil? + "SUB #{subject} #{sid}" + else + "SUB #{subject} #{queue_group} #{sid}" + end + end + end + end +end diff --git a/src/nats/message/unsub.cr b/src/nats/message/unsub.cr new file mode 100644 index 0000000..0de14d9 --- /dev/null +++ b/src/nats/message/unsub.cr @@ -0,0 +1,42 @@ +# Copyright 2019-2025 The NATS Authors +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +module NATS + module Message + # UNSUB unsubscribes the connection from the specified subject, + # or auto-unsubscribes after the specified number of messages has been received. + # + # SEE: https://docs.nats.io/reference/reference-protocols/nats-protocol#unsub + struct UNSUB + # The unique alphanumeric subscription ID of the subject to unsubscribe from. + property sid : String + # If specified, the subscriber will join this queue group. + property max_msgs : Int64? = nil + + def initialize( + @sid : String, + @max_msgs : Int64? = nil, + ) + end + + def to_s + if max_msgs.nil? + "UNSUB #{sid}" + else + "UNSUB #{sid} #{max_msgs}" + end + end + end + end +end diff --git a/src/nats/msg.cr b/src/nats/msg.cr deleted file mode 100644 index 7b66dbf..0000000 --- a/src/nats/msg.cr +++ /dev/null @@ -1,60 +0,0 @@ -# Copyright 2019-2020 The NATS Authors -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -module NATS - # A delivered message from a subscription. - # - # ``` - # nc = NATS::Connection.new("demo.nats.io") - # nc.subscribe("foo") do |msg| - # puts "Received '#{msg}'" - # puts "Subject is #{msg.subject}" - # puts "Reply Subject is #{msg.reply}" - # puts "Raw Data is #{msg.data}" - # end - # ``` - struct Msg - getter subject : String - getter reply : String? - getter data : Bytes - - @conn : Connection | Nil - - # :nodoc: - def to_s(io : IO) - io.write data - end - - # :nodoc: - def initialize(@subject, @data, @reply = nil) - end - - protected def initialize(@subject, @data, @reply = nil, @conn = nil) - end - - # Allows a response to a request message to be easily sent. - # - # ``` - # nc = NATS::Connection.new("demo.nats.io") - # nc.subscribe("req") do |msg| - # msg.respond("ANSWER is 42") - # end - # ``` - def respond(msg) - raise "No reply subject" if @reply.nil? - raise "Not a received message" if @conn.nil? - @conn.try(&.publish(@reply.to_s, msg)) - end - end -end diff --git a/src/nats/nuid.cr b/src/nats/nuid.cr index d9157de..4e5168f 100644 --- a/src/nats/nuid.cr +++ b/src/nats/nuid.cr @@ -1,4 +1,4 @@ -# Copyright 2019-2020 The NATS Authors +# Copyright 2019-2025 The NATS Authors # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at @@ -14,10 +14,10 @@ require "random/secure" -# Copied and modified from nats-pure repo. -# https://github.com/nats-io/nats-pure.rb/blob/master/lib/nats/nuid.rb - module NATS + # Copied and modified from nats-pure repo. + # + # SEE: https://github.com/nats-io/nats-pure.rb/blob/master/lib/nats/nuid.rb class NUID DIGITS = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz" BASE = 62 diff --git a/src/nats/options.cr b/src/nats/options.cr new file mode 100644 index 0000000..fd964fc --- /dev/null +++ b/src/nats/options.cr @@ -0,0 +1,40 @@ +# Copyright 2019-2025 The NATS Authors +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +module NATS + # Adapted from the nats.go library. + # + # NOTE: Currently only some options are implemented. + # + # SEE: https://github.com/nats-io/nats.go/blob/8a48023f77877dcfc140d0b9c25603c6cbedfaab/nats.go#L152 + struct Options + # From nats.go + # property allow_reconnect : Bool = true + # property max_reconnect : Int32 = 60 + # property reconnect_wait : Time::Span = 2.seconds + # property reconnect_jitter : Time::Span = 100.milliseconds + # property reconnect_jitter_tls : Time::Span = 1.second + property timeout : Time::Span = 2.seconds + # property ping_interval : Time::Span = 2.minutes + # property max_pings_out : Int32 = 2 + # property sub_chan_len : Int32 = 64 * 1024 # 64k + # property reconnect_buf_size : Int32 = 8 * 1024 * 1024 # 8MB + # property drain_timeout : Time::Span = 30.seconds + # property flusher_timeout : Time::Span = 1.minute + property pedantic : Bool = false + + # Specific to nats.cr + property flush_interval : Time::Span = 100.milliseconds + end +end diff --git a/src/nats/subscription.cr b/src/nats/subscription.cr index a6212fb..26a9f32 100644 --- a/src/nats/subscription.cr +++ b/src/nats/subscription.cr @@ -1,4 +1,4 @@ -# Copyright 2019-2020 The NATS Authors +# Copyright 2019-2025 The NATS Authors # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at @@ -13,62 +13,30 @@ # module NATS - # A subscription to a given subject and possible queue group. Used to unsubscribe/close. - # - # ``` - # nc = NATS::Connection.new("demo.nats.io") - # sub = nc.subscribe("foo") { |msg| } - # sub.close - # sub.unsubscribe - # ``` - class Subscription - protected def initialize(@sid : Int32, @conn : Connection, @cb : Msg ->) - @msgs = Channel(Msg?).new(128) - spawn process_msgs + # Represents a subscription to a NATS subject. + struct Subscription + # The subject name to subscribe to. + getter subject : String + # If specified, the subscriber will join this queue group. + getter queue_group : String? = nil + # A unique alphanumeric subscription ID, generated by the client. + getter sid : UInt64 + # The callback to be invoked when a message is received. + property callback : Message::MSG -> Nil + # The client that owns this subscription. + getter client : Client + + def initialize( + @subject : String, + @sid : UInt64, + @callback : Message::MSG -> Nil, + @client : Client, + @queue_group : String? = nil, + ) end - # Will unsubscribe from a subscription. def unsubscribe - unless closed? - @conn.unsubscribe(@sid) - @msgs.close - end - end - - # ditto - def close - unsubscribe - end - - # Determines if the subscription is already closed. - def closed? - return @msgs.closed? - end - - protected def send(msg : Msg) - @msgs.send(msg) unless @msgs.closed? - end - - private def process_msgs - until @conn.closed? - msg = @msgs.receive - break if msg.nil? # FIXME(dlc) - I think nil ok. - @cb.call(msg) - end - rescue # for when msgs channel gets closed. - end - end - - private class InternalSubscription - def initialize(@sid : Int32, @conn : Connection) - end - - def unsubscribe - @conn.unsubscribe(@sid) - end - - def send(msg : Msg) - @conn.handle_resp(msg) + client.unsubscribe(self) end end end