vertx-lang-scala-docs_2.12 3.5.0 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package core
  Definition Classes
    scala
-  package eventbus
  Definition Classes
    core
- DeliveryOptions
- EventBus
- EventBusOptions
- Message
- MessageConsumer
- MessageProducer
- SendContext

c

io.vertx.scala.core.eventbus

# MessageProducer 

###
Companion object MessageProducer

#### 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
     MessageProducer → WriteStream → StreamBase
7.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( ... )
8.  def close(): Unit

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

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

   Update the delivery options of this producer.

   Update the delivery options of this producer.

   options

     the new optionssee DeliveryOptions

   returns

     this producer object

10.  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`.

    handler

      the handler

    returns

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

    Definition Classes
      MessageProducer → WriteStream
11.  def end(): Unit

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

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

    Definition Classes
      MessageProducer → WriteStream
12.  def end(t: 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.

    Definition Classes
      MessageProducer → WriteStream
13.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
14.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
15.  def exceptionHandler(handler: Handler[Throwable]): MessageProducer[T]

    Set an exception handler on the write stream.

    Set an exception handler on the write stream.

    handler

      the exception handler

    returns

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

    Definition Classes
      MessageProducer → WriteStream → StreamBase
16.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
17.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
18.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
19.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
20.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
21.  final def notify(): Unit
    Definition Classes
      AnyRef
22.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
23.  def send[R](message: T, replyHandler: Handler[AsyncResult[Message[R]]])(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[R]): MessageProducer[T]
24.  def send(message: T): MessageProducer[T]

    Synonym for io.vertx.scala.core.eventbus.MessageProducer#write.

    Synonym for io.vertx.scala.core.eventbus.MessageProducer#write.

    message

      the message to send

    returns

      reference to this for fluency

25.  def sendFuture[R](message: T)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[R]): scala.concurrent.Future[Message[R]]
26.  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...

    maxSize

      the max size of the write stream

    returns

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

    Definition Classes
      MessageProducer → WriteStream
27.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
28.  def toString(): String
    Definition Classes
      AnyRef → Any
29.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
30.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
31.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
32.  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.

    data

      the data to write

    returns

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

    Definition Classes
      MessageProducer → WriteStream
33.  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

    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

    returns

      true if write queue is full

    Definition Classes
      MessageProducer → WriteStream

### Inherited from WriteStream[T]

### Inherited from StreamBase

### Inherited from AnyRef

### Inherited from Any

### Ungrouped