lib/onstomp/interfaces/connection_events.rb in onstomp-1.0.2 vs lib/onstomp/interfaces/connection_events.rb in onstomp-1.0.3
- old
+ new
@@ -10,37 +10,37 @@
# Binds a callback to be invoked when a connection has been fully
# established between broker and client.
# @yield [client, connection] callback invoked when event is triggered
# @yieldparam [OnStomp::Client] client
# @yieldparam [OnStomp::Connections::Base] connection that triggered
- # the event (in general the same as +client.connection+)
+ # the event (in general the same as `client.connection`)
create_event_methods :established, :on
# @api gem:1 STOMP:1.1
# Binds a callback to be invoked when a connection has been died due to
# insufficient data transfer.
# @note Only applies to STOMP 1.1 connections with heartbeating enabled.
# @yield [client, connection] callback invoked when event is triggered
# @yieldparam [OnStomp::Client] client
# @yieldparam [OnStomp::Connections::Base] connection that triggered
- # the event (in general the same as +client.connection+)
+ # the event (in general the same as `client.connection`)
create_event_methods :died, :on
# @api gem:1 STOMP:1.0,1.1
# Binds a callback to be invoked when a connection has been terminated
# (eg: closed unexpectedly due to an exception)
# @yield [client, connection] callback invoked when event is triggered
# @yieldparam [OnStomp::Client] client
# @yieldparam [OnStomp::Connections::Base] connection that triggered
- # the event (in general the same as +client.connection+)
+ # the event (in general the same as `client.connection`)
create_event_methods :terminated, :on
# @api gem:1 STOMP:1.0,1.1
# Binds a callback to be invoked when a connection has been closed, either
# through a graceful disconnect or unexpectedly.
# @note If connection is closed unexpectedly, {#on_died} is triggered first,
# followed by this event.
# @yield [client, connection] callback invoked when event is triggered
# @yieldparam [OnStomp::Client] client
# @yieldparam [OnStomp::Connections::Base] connection that triggered
- # the event (in general the same as +client.connection+)
+ # the event (in general the same as `client.connection`)
create_event_methods :closed, :on
# @endgroup
# Triggers a connection specific event.