class MessageProducer[T] extends WriteStream[T]
Represents a stream of message that can be written to.
- Alphabetic
- By Inheritance
- MessageProducer
- WriteStream
- StreamBase
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new MessageProducer(_asJava: AnyRef)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T])
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
address(): String
- returns
The address to which the producer produces messages.
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
asJava: AnyRef
- Definition Classes
- MessageProducer → WriteStream → StreamBase
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
close(): Unit
Closes the producer, this method should be called when the message producer is not used anymore.
-
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
-
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
- MessageProducer → WriteStream
-
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
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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
- MessageProducer → WriteStream → StreamBase
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
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
-
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
-
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.
-
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 thanmaxSize
items in the write queue. This is used as an indicator by classes such asPump
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
- MessageProducer → WriteStream
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
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
- MessageProducer → WriteStream
-
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 fullThis 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
- MessageProducer → WriteStream