lib/0mq/error_map.rb in 0mq-0.2.1 vs lib/0mq/error_map.rb in 0mq-0.3.0

@@ -1,19 +1,25 @@
 
 module ZMQ
   
+  # A hash of error number => exception class.
+  # Example: 1 => Errno::EPERM
   ErrorMap = Hash.new
   
   Errno.constants
-       .map    { |x| Errno.const_get x }
-       .select { |x| x.is_a?(Class) && x < SystemCallError }
-       .each   { |x| ErrorMap[x.const_get(:Errno)] = x }
+    .map    { |x| Errno.const_get x }
+    .select { |x| x.is_a?(Class) && x < SystemCallError }
+    .each   { |x| ErrorMap[x.const_get(:Errno)] = x }
   
+  
+  # Checks the libzmq global error number and raises it as an exception.
+  # Should be used after calling a libzmq resource that returns -1 on error.
+  # Example: ZMQ.error_check if rc == -1
   def self.error_check(adjust_backtrace=false)
     errno = LibZMQ.zmq_errno
     return true if errno == 25
     
-    # str = LibZMQ.zmq_strerror(errno).read_string
+    # TODO: Use adjust_backtrace
     str = ''
     raise ErrorMap[errno], str, caller[0...-2]
   end
   
 end
\ No newline at end of file