Packages

class MessageProducer[T] extends WriteStream[T]

Represents a stream of message that can be written to.

Linear Supertypes
WriteStream[T], StreamBase, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MessageProducer
  2. WriteStream
  3. StreamBase
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MessageProducer(_asJava: AnyRef)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def address(): String

    returns

    The address to which the producer produces messages.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def asJava: AnyRef
    Definition Classes
    MessageProducerWriteStreamStreamBase
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. def close(handler: Handler[AsyncResult[Unit]]): Unit

    Same as io.vertx.scala.core.eventbus.MessageProducer#close but with an handler called when the operation completes

  9. def close(): Unit

    Closes the producer, this method should be called when the message producer is not used anymore.

  10. def closeFuture(): scala.concurrent.Future[Unit]

    Like close but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  11. def deliveryOptions(options: DeliveryOptions): MessageProducer[T]

    Update the delivery options of this producer.

    Update the delivery options of this producer. * @param options the new options see DeliveryOptions

    returns

    this producer object

  12. def drainHandler(handler: Handler[Unit]): MessageProducer[T]

    Set a drain handler on the stream.

    Set a drain handler on the stream. If the write queue is full, then the handler will be called when the write queue is ready to accept buffers again. See io.vertx.scala.core.streams.Pump for an example of this being used.

    The stream implementation defines when the drain handler, for example it could be when the queue size has been reduced to maxSize / 2. * @param handler the handler

    returns

    a reference to this, so the API can be used fluently

    Definition Classes
    MessageProducerWriteStream
  13. def end(handler: Handler[AsyncResult[Unit]]): Unit

    Closes the producer, calls io.vertx.scala.core.eventbus.MessageProducer#close

    Definition Classes
    MessageProducerWriteStream
  14. def end(): Unit

    Closes the producer, calls io.vertx.scala.core.eventbus.MessageProducer#close

    Definition Classes
    MessageProducerWriteStream
  15. def end(data: T, handler: Handler[AsyncResult[Unit]]): Unit

    Same as but with an handler called when the operation completes

    Same as but with an handler called when the operation completes

    Definition Classes
    MessageProducerWriteStream
  16. def end(data: T): Unit

    Same as io.vertx.scala.core.eventbus.MessageProducer#end but writes some data to the stream before ending.

    Same as io.vertx.scala.core.eventbus.MessageProducer#end but writes some data to the stream before ending. * @param data the data to write

    Definition Classes
    MessageProducerWriteStream
  17. def endFuture(): scala.concurrent.Future[Unit]

    Like end but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Like end but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Definition Classes
    MessageProducerWriteStream
  18. def endFuture(data: T): scala.concurrent.Future[Unit]

    Like end but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Like end but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Definition Classes
    MessageProducerWriteStream
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  21. def exceptionHandler(handler: Handler[Throwable]): MessageProducer[T]

    Set an exception handler on the write stream.

    Set an exception handler on the write stream. * @param handler the exception handler

    returns

    a reference to this, so the API can be used fluently

    Definition Classes
    MessageProducerWriteStreamStreamBase
  22. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. def send[R](message: T, replyHandler: Handler[AsyncResult[Message[R]]])(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[R]): MessageProducer[T]

    Like io.vertx.scala.core.eventbus.MessageProducer#send but specifying a replyHandler that will be called if the recipient subsequently replies to the message.

    Like io.vertx.scala.core.eventbus.MessageProducer#send but specifying a replyHandler that will be called if the recipient subsequently replies to the message. * @param message the message to send

    replyHandler

    reply handler will be called when any reply from the recipient is received, may be null

    returns

    reference to this for fluency

  30. def send(message: T): MessageProducer[T]

    This method actually sends a message using the send semantic regardless this producer is a sender or a publisher.

    This method actually sends a message using the send semantic regardless this producer is a sender or a publisher. * @param message the message to send

    returns

    reference to this for fluency

  31. def sendFuture[R](message: T)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[R]): scala.concurrent.Future[Message[R]]

    Like send but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  32. def setWriteQueueMaxSize(maxSize: Int): MessageProducer[T]

    Set the maximum size of the write queue to maxSize.

    Set the maximum size of the write queue to maxSize. You will still be able to write to the stream even if there is more than maxSize items in the write queue. This is used as an indicator by classes such as Pump to provide flow control.

    The value is defined by the implementation of the stream, e.g in bytes for a io.vertx.scala.core.net.NetSocket, the number of io.vertx.scala.core.eventbus.Message for a io.vertx.scala.core.eventbus.MessageProducer, etc... * @param maxSize the max size of the write stream

    returns

    a reference to this, so the API can be used fluently

    Definition Classes
    MessageProducerWriteStream
  33. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  34. def toString(): String
    Definition Classes
    AnyRef → Any
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  38. def write(data: T, handler: Handler[AsyncResult[Unit]]): MessageProducer[T]

    Same as but with an handler called when the operation completes

    Same as but with an handler called when the operation completes

    Definition Classes
    MessageProducerWriteStream
  39. def write(data: T): MessageProducer[T]

    Write some data to the stream.

    Write some data to the stream. The data is put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the io.vertx.scala.core.streams.WriteStream#writeQueueFull method before writing. This is done automatically if using a io.vertx.scala.core.streams.Pump. * @param data the data to write

    returns

    a reference to this, so the API can be used fluently

    Definition Classes
    MessageProducerWriteStream
  40. def writeFuture(data: T): scala.concurrent.Future[Unit]

    Like write but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Like write but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Definition Classes
    MessageProducerWriteStream
  41. def writeQueueFull(): Boolean

    This will return true if there are more bytes in the write queue than the value set using io.vertx.scala.core.eventbus.MessageProducer#setWriteQueueMaxSize * @return true if write queue is full

    This will return true if there are more bytes in the write queue than the value set using io.vertx.scala.core.eventbus.MessageProducer#setWriteQueueMaxSize * @return true if write queue is full

    Definition Classes
    MessageProducerWriteStream

Inherited from WriteStream[T]

Inherited from StreamBase

Inherited from AnyRef

Inherited from Any

Ungrouped