org.jenkinsci.plugins.rabbitmqconsumer.channels

クラス PublishRMQChannel

java.lang.Object

org.jenkinsci.plugins.rabbitmqconsumer.channels.AbstractRMQChannel

org.jenkinsci.plugins.rabbitmqconsumer.channels.PublishRMQChannel

すべての実装されたインタフェース:

com.rabbitmq.client.ShutdownListener, EventListener, RMQChannelNotifier, PublishChannel

public class PublishRMQChannel
extends AbstractRMQChannel
implements PublishChannel

Handle class for RabbitMQ publish channel.

作成者:

rinrinne a.k.a. rin_ne

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
class	PublishRMQChannel.PrepareTask A class to prepare publising
class	PublishRMQChannel.PublishTask A class to publish message.

フィールドのサマリー

クラスから継承されたフィールド org.jenkinsci.plugins.rabbitmqconsumer.channels.AbstractRMQChannel

channel, rmqChannelListeners, state

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
PublishRMQChannel() Creates instance.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addListener(RMQChannelListener listener) Adds channel listener.
Future<PublishResult>	publish(String exchangeName, String routingKey, com.rabbitmq.client.AMQP.BasicProperties props, byte[] body) Publish message.
void	removeListener(RMQChannelListener listener) Remove channel listener.
PublishResult	setupExchange(String exchangeName, String queueName) Setup exchange.
PublishResult	setupExchange(String exchangeName, String queueName, ExchangeType exchangeType, String routingKey) Setup exchange.

クラスから継承されたメソッド org.jenkinsci.plugins.rabbitmqconsumer.channels.AbstractRMQChannel

addRMQChannelListener, close, getChannel, isOpen, isOpenRMQChannel, notifyOnCloseCompleted, notifyOnOpen, notifyRMQChannelListeners, open, removeRMQChannelListener, shutdownCompleted

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェースから継承されたメソッド org.jenkinsci.plugins.rabbitmqconsumer.publishers.PublishChannel

isOpen

コンストラクタの詳細

PublishRMQChannel

public PublishRMQChannel()

Creates instance.

メソッドの詳細

publish

public Future<PublishResult> publish(String exchangeName,
                                     String routingKey,
                                     com.rabbitmq.client.AMQP.BasicProperties props,
                                     byte[] body)

Publish message. The usage of this method is the same as original amqp client library. See "Publising message"section in API guide. http://www.rabbitmq.com/api-guide.html This is non-blocking method. The message you provide is published from other thread. Note that the message still not published even if return from this method.

定義:

publish インタフェース内 PublishChannel

パラメータ:

exchangeName - the name of exchange.

routingKey - the routing key.

props - the properties of AMQP message.

body - the message body.

戻り値:

instance of Future class that computes PublishResult.

setupExchange

public PublishResult setupExchange(String exchangeName,
                                   String queueName)

Setup exchange. Fanout type exchange is declared then binded to queue in RabbitMQ. Note that this is blocking method.

定義:

setupExchange インタフェース内 PublishChannel

パラメータ:

exchangeName - the exchange name. If null, unique name is used. You can get it from PublishResult.getExchangeName().

queueName - the queue name. this is mandatory.

戻り値:

instance of PublishResult.

setupExchange

public PublishResult setupExchange(String exchangeName,
                                   String queueName,
                                   ExchangeType exchangeType,
                                   String routingKey)

Setup exchange. Exchange is declared then binded to queue in RabbitMQ. Note that this is blocking method.

定義:

setupExchange インタフェース内 PublishChannel

パラメータ:

exchangeName - the exchange name. If null, unique name is used. You can get it from PublishResult.getExchangeName().

queueName - the queue name. this is mandatory.

exchangeType - the exchange type.

routingKey - the routing key. Key usage is decided by exchange type.

戻り値:

instance of PublishResult.

addListener

public void addListener(RMQChannelListener listener)

Adds channel listener.

定義:

addListener インタフェース内 PublishChannel

パラメータ:

listener - the listener.

removeListener

public void removeListener(RMQChannelListener listener)

Remove channel listener.

定義:

removeListener インタフェース内 PublishChannel

パラメータ:

listener - the listener.