amqp-dsl

<!DOCTYPE html> <html> <head> <title>AmqpDsl.coffee</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <div id="jump_to"> Jump To … <div id="jump_wrapper"> <div id="jump_page"> <a class="source" href="example-advanced.html"> example-advanced.coffee </a> <a class="source" href="example-connection.html"> example-connection.coffee </a> <a class="source" href="example-simple.html"> example-simple.coffee </a> <a class="source" href="AmqpDsl.html"> AmqpDsl.coffee </a> <a class="source" href="AmqpExchange.html"> AmqpExchange.coffee </a> <a class="source" href="AmqpQueue.html"> AmqpQueue.coffee </a> <a class="source" href="IndexedList.html"> IndexedList.coffee </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> AmqpDsl.coffee </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">¶</a> </div> Amqp-DSL - Fluent interface for node-amqp </td> <td class="code"> <div class="highlight"><pre>async = require 'async' IndexedList = require './IndexedList' AmqpQueue = require './AmqpQueue' AmqpExchange = require './AmqpExchange' module.exports = class AmqpDsl LISTENNERS =['error','close','ready']</pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> <h1>Public API</h1> <h3>require('amqp-dsl').login</h3> <ul> <li><code>login( options = {} )</code></li> </ul> </td> <td class="code"> <div class="highlight"><pre> AmqpDsl.login = (opt = {}) -> new AmqpDsl(opt) constructor:(opt = {}) -></pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> Defaults </td> <td class="code"> <div class="highlight"><pre> @_login = '' @_password = '' @_host = '' @_port = 5672 @_vhost = '/' @_conn = null @_callback = -></pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> Constructor arguments </td> <td class="code"> <div class="highlight"><pre> opt.login and (@_login = opt.login) opt.password and (@_password = opt.password) opt.host and (@_host = opt.host) opt.port and (@_port = opt.port) opt.vhost and (@_vhost = opt.vhost) opt.login and (@_login = opt.login)</pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> Events </td> <td class="code"> <div class="highlight"><pre> @_events = {}</pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> Exchanges </td> <td class="code"> <div class="highlight"><pre> @_exchanges = new IndexedList()</pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">¶</a> </div> Queues </td> <td class="code"> <div class="highlight"><pre> @_queues = new IndexedList() </pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">¶</a> </div> <h3>.on</h3> <ul> <li><code>on( event, listener )</code></li> </ul> </td> <td class="code"> <div class="highlight"><pre> on:( event, listener ) -> if !~LISTENNERS.indexOf(event) throw new Error("Event '#{event}' is invalid") @_events[event] = [] if(!@_events[event]) @_events[event].push(listener) this </pre></div> </td> </tr> <tr id="section-9"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-9">¶</a> </div> <h3>.exchange</h3> <ul> <li><code>.exchange( name, options )</code></li> <li><code>.exchange( name, callback(exchange) )</code></li> <li><code>.exchange( name, options, callback(exchange) )</code></li> </ul> </td> <td class="code"> <div class="highlight"><pre> exchange:( name, options, openCallback ) -> @_exchanges.set(name, new AmqpExchange(name, options, openCallback)) this </pre></div> </td> </tr> <tr id="section-10"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-10">¶</a> </div> <h3>.queue</h3> <ul> <li><code>.queue( name, options )</code></li> <li><code>.queue( name, callback(queue) )</code></li> <li><code>.queue( name, options, callback(queue) )</code></li> </ul> </td> <td class="code"> <div class="highlight"><pre> queue:( name, options, openCallback ) -> @_queues.set(name, new AmqpQueue(name, options, openCallback)) this </pre></div> </td> </tr> <tr id="section-11"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-11">¶</a> </div> <h3>.queue(...).subscribe</h3> <ul> <li><code>.subscribe( callback(message, header, deliveryInfo) )</code></li> <li><code>.subscribe( options, callback(message, header, deliveryInfo) )</code></li> </ul> </td> <td class="code"> <div class="highlight"><pre> subscribe:( options, messageListener ) -> queue = @_queues.last() throw new Error("At least one queue must be declared") if !queue queue.subscribe(options, messageListener) this </pre></div> </td> </tr> <tr id="section-12"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-12">¶</a> </div> <h3>.queue(...).bind</h3> <ul> <li><code>.bind( name, routingKey )</code></li> </ul> </td> <td class="code"> <div class="highlight"><pre> bind:( name, routingKey ) -> queue = @_queues.last() throw new Error("At least one queue must be declared") if !queue queue.bind(name, routingKey) this </pre></div> </td> </tr> <tr id="section-13"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-13">¶</a> </div> <h3>.connect</h3> <ul> <li><code>.connect( amqp, callback(err, amqp) )</code></li> <li><code>.connect( callback(err, amqp) )</code></li> </ul> <code>amqp</code> parameter is an hashtable which contain <pre><code> queues: sampleQueue:[Amqp::Queue] exchanges: sampleExchange:[Amqp::Exchange] connection: [Amqp::Connection] </code></pre> </td> <td class="code"> <div class="highlight"><pre> connect:(amqp, @_callback)-> if typeof amqp is "function" @_callback = amqp amqp = require 'amqp' @_connect(amqp) null </pre></div> </td> </tr> <tr id="section-14"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-14">¶</a> </div> <h1>Private API</h1> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-15"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-15">¶</a> </div> Create the connection to amqp and bind events </td> <td class="code"> <div class="highlight"><pre> _connect:(amqp) -></pre></div> </td> </tr> <tr id="section-16"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-16">¶</a> </div> Create connection </td> <td class="code"> <div class="highlight"><pre> @conn = amqp.createConnection({ host: @_host, port: @_port, login: @_login, password: @_password, vhost: @_vhost })</pre></div> </td> </tr> <tr id="section-17"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-17">¶</a> </div> When the connection will be ready, connect the exchanges </td> <td class="code"> <div class="highlight"><pre> @on 'ready', () => @_connectExchanges(@_connectQueues.bind(this))</pre></div> </td> </tr> <tr id="section-18"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-18">¶</a> </div> Set event listeners </td> <td class="code"> <div class="highlight"><pre> @conn.on(event, @_getListenerFor(event)) for event of @_events </pre></div> </td> </tr> <tr id="section-19"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-19">¶</a> </div> Return a listener fonction for the event <code>event</code>. </td> <td class="code"> <div class="highlight"><pre> _getListenerFor: (event) -> if @_events[event].length == 1 return @_events[event][0] else return (args...) => listener.apply(null, args) for listener in @_events[event] true </pre></div> </td> </tr> <tr id="section-20"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-20">¶</a> </div> Connect to exchanges </td> <td class="code"> <div class="highlight"><pre> _connectExchanges:(next) -> async.forEach @_exchanges.list(), @_connectExchange.bind(@), (err) => if err throw new Error("Couldn't connect to the exchanges: #{err.message}") return next() </pre></div> </td> </tr> <tr id="section-21"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-21">¶</a> </div> Exchange connection iterator </td> <td class="code"> <div class="highlight"><pre> _connectExchange:(exchange, callback) -> @conn.exchange exchange.name, exchange.options, (exchangeRef) -> exchange.ref = exchangeRef exchange.openCallback(exchangeRef) callback(null, true)</pre></div> </td> </tr> <tr id="section-22"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-22">¶</a> </div> Connect to queues </td> <td class="code"> <div class="highlight"><pre> _connectQueues:() -> async.forEach @_queues.list(), @_connectQueue.bind(@), (err) => if err throw new Error("Couldn't connect to the queues: #{err.message}") return @_done() </pre></div> </td> </tr> <tr id="section-23"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-23">¶</a> </div> Queue connection iterator </td> <td class="code"> <div class="highlight"><pre> _connectQueue:(queue, callback) -> @conn.queue queue.name, queue.options, (queueRef) -> queue.ref = queueRef queue.openCallback(queueRef) if queue.exchangeName queueRef.bind queue.exchangeName, queue.routingKey if queue.messageListener queueRef.subscribe queue.sOptions, queue.messageListener callback(null, true) </pre></div> </td> </tr> <tr id="section-24"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-24">¶</a> </div> When everything's connected, trigger the final callback </td> <td class="code"> <div class="highlight"><pre> _done:() -> msg = queues : {} exchanges : {} connection : @conn for k,v of @_queues.index() msg.queues[k] = v.ref for k,v of @_exchanges.index() msg.exchanges[k] = v.ref @_callback(null, msg) </pre></div> </td> </tr> </tbody> </table> </div> </body> </html>