EventBusImpl.HandlerRegistration (Vert.x Core 3.0.0 API)

java.lang.Object
- io.vertx.core.eventbus.impl.EventBusImpl.HandlerRegistration<T>

All Implemented Interfaces:

MessageConsumer<T>, Handler<Message<T>>, ReadStream<Message<T>>, StreamBase

Enclosing class:

EventBusImpl
```
public class EventBusImpl.HandlerRegistration<T>
extends Object
implements MessageConsumer<T>, Handler<Message<T>>
```

Constructor Summary

Constructors
Constructor and Description
`HandlerRegistration(String address, boolean replyHandler, boolean localOnly, long timeoutID)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`address()`
`ReadStream<T>`	`bodyStream()`
`void`	`completionHandler(Handler<AsyncResult<Void>> completionHandler)` Optional method which can be called to indicate when the registration has been propagated across the cluster.
`void`	`discardHandler(Handler<Message<T>> handler)`
`MessageConsumer<T>`	`endHandler(Handler<Void> endHandler)` Set an end handler.
`MessageConsumer<T>`	`exceptionHandler(Handler<Throwable> handler)` Set an exception handler on the read stream.
`int`	`getMaxBufferedMessages()`
`void`	`handle(Message<T> event)` Something has happened, so handle it.
`MessageConsumer<T>`	`handler(Handler<Message<T>> handler)` Set a data handler.
`boolean`	`isRegistered()`
`MessageConsumer<T>`	`pause()` Pause the `ReadSupport`.
`MessageConsumer<T>`	`resume()` Resume reading.
`MessageConsumer<T>`	`setMaxBufferedMessages(int maxBufferedMessages)` Set the number of messages this registration will buffer when this stream is paused.
`void`	`unregister()` Unregisters the handler which created this registration
`void`	`unregister(Handler<AsyncResult<Void>> completionHandler)` Unregisters the handler which created this registration

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HandlerRegistration
```
public HandlerRegistration(String address,
                           boolean replyHandler,
                           boolean localOnly,
                           long timeoutID)
```
- Method Detail
  - setMaxBufferedMessages
```
public MessageConsumer<T> setMaxBufferedMessages(int maxBufferedMessages)
```
    Description copied from interface: MessageConsumer
    
    Set the number of messages this registration will buffer when this stream is paused. The default value is 0. When a new value is set, buffered messages may be discarded to reach the new value.
    
    Specified by:
    
    setMaxBufferedMessages in interface MessageConsumer<T>
    
    Parameters:
    
    maxBufferedMessages - the maximum number of messages that can be buffered
    
    Returns:
    
    this registration
  - getMaxBufferedMessages
```
public int getMaxBufferedMessages()
```
    Specified by:
    
    getMaxBufferedMessages in interface MessageConsumer<T>
    
    Returns:
    
    the maximum number of messages that can be buffered when this stream is paused
  - address
```
public String address()
```
    Specified by:
    
    address in interface MessageConsumer<T>
    
    Returns:
    
    The address the handler was registered with.
  - completionHandler
```
public void completionHandler(Handler<AsyncResult<Void>> completionHandler)
```
    Description copied from interface: MessageConsumer
    
    Optional method which can be called to indicate when the registration has been propagated across the cluster.
    
    Specified by:
    
    completionHandler in interface MessageConsumer<T>
    
    Parameters:
    
    completionHandler - the completion handler
  - unregister
```
public void unregister()
```
    Description copied from interface: MessageConsumer
    
    Unregisters the handler which created this registration
    
    Specified by:
    
    unregister in interface MessageConsumer<T>
  - unregister
```
public void unregister(Handler<AsyncResult<Void>> completionHandler)
```
    Description copied from interface: MessageConsumer
    
    Unregisters the handler which created this registration
    
    Specified by:
    
    unregister in interface MessageConsumer<T>
    
    Parameters:
    
    completionHandler - the handler called when the unregister is done. For example in a cluster when all nodes of the event bus have been unregistered.
  - handle
```
public void handle(Message<T> event)
```
    Description copied from interface: Handler
    
    Something has happened, so handle it.
    
    Specified by:
    
    handle in interface Handler<Message<T>>
    
    Parameters:
    
    event - the event to handle
  - discardHandler
```
public void discardHandler(Handler<Message<T>> handler)
```
  - handler
```
public MessageConsumer<T> handler(Handler<Message<T>> handler)
```
    Description copied from interface: ReadStream
    
    Set a data handler. As data is read, the handler will be called with the data.
    
    Specified by:
    
    handler in interface MessageConsumer<T>
    
    Specified by:
    
    handler in interface ReadStream<Message<T>>
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - bodyStream
```
public ReadStream<T> bodyStream()
```
    Specified by:
    
    bodyStream in interface MessageConsumer<T>
    
    Returns:
    
    a read stream for the body of the message stream.
  - isRegistered
```
public boolean isRegistered()
```
    Specified by:
    
    isRegistered in interface MessageConsumer<T>
    
    Returns:
    
    true if the current consumer is registered
  - pause
```
public MessageConsumer<T> pause()
```
    Description copied from interface: ReadStream
    
    Pause the ReadSupport. While it's paused, no data will be sent to the dataHandler
    
    Specified by:
    
    pause in interface MessageConsumer<T>
    
    Specified by:
    
    pause in interface ReadStream<Message<T>>
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - resume
```
public MessageConsumer<T> resume()
```
    Description copied from interface: ReadStream
    
    Resume reading. If the ReadSupport has been paused, reading will recommence on it.
    
    Specified by:
    
    resume in interface MessageConsumer<T>
    
    Specified by:
    
    resume in interface ReadStream<Message<T>>
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - endHandler
```
public MessageConsumer<T> endHandler(Handler<Void> endHandler)
```
    Description copied from interface: ReadStream
    
    Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.
    
    Specified by:
    
    endHandler in interface MessageConsumer<T>
    
    Specified by:
    
    endHandler in interface ReadStream<Message<T>>
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - exceptionHandler
```
public MessageConsumer<T> exceptionHandler(Handler<Throwable> handler)
```
    Description copied from interface: ReadStream
    
    Set an exception handler on the read stream.
    
    Specified by:
    
    exceptionHandler in interface MessageConsumer<T>
    
    Specified by:
    
    exceptionHandler in interface ReadStream<Message<T>>
    
    Specified by:
    
    exceptionHandler in interface StreamBase
    
    Parameters:
    
    handler - the exception handler
    
    Returns:
    
    a reference to this, so the API can be used fluently

Class EventBusImpl.HandlerRegistration<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HandlerRegistration

Method Detail

setMaxBufferedMessages

getMaxBufferedMessages

address

completionHandler

unregister

unregister

handle

discardHandler

handler

bodyStream

isRegistered

pause

resume

endHandler

exceptionHandler