Skip to content

Commit b73ec51

Browse files
committed
Add more documentaiton to Client and Channel class.
1 parent 05e3249 commit b73ec51

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

lib/rabbitmq/channel.rb

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,23 @@
11

22
module RabbitMQ
3+
4+
# A {Channel} holds a connection to a RabbitMQ server and is associated
5+
# with a specific channel id number for categorizing message flow.
6+
# It also provides convenient wrapper methods for common uses of
7+
# the underlying {Client}.
8+
#
9+
# A {Channel} is not threadsafe; both the {Channel} and its associated
10+
# {Client} should not be shared between threads. If they are shared without
11+
# appropriate locking mechanisms, the behavior is undefined and might result
12+
# in catastrophic process failures like segmentation faults in the underlying
13+
# C library. A {Channel} can be safely used in a multithreaded application by
14+
# only passing control and message data between threads.
15+
#
16+
# To use a {Channel} effectively, it is necessary to understand the
17+
# methods available in the underlying AMQP protocol. Please refer to
18+
# the protocol documentation for more information about specific methods:
19+
# http://www.rabbitmq.com/amqp-0-9-1-reference.html
20+
#
321
class Channel
422

523
attr_reader :client

lib/rabbitmq/client.rb

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ module RabbitMQ
1313
# C library. A {Client} can be safely used in a multithreaded application by
1414
# only passing control and message data between threads.
1515
#
16+
# To use a {Client} effectively, it is necessary to understand the
17+
# methods available in the underlying AMQP protocol. Please refer to
18+
# the protocol documentation for more information about specific methods:
19+
# http://www.rabbitmq.com/amqp-0-9-1-reference.html
20+
#
1621
class Client
1722

1823
# Create a new {Client} instance with the given properties.

0 commit comments

Comments
 (0)