Class MessageProducer

moduleio.vertx.ceylon.core3.5.0 (jvm)

Index
Search
Filter

Represents a stream of message that can be written to.

Anything
- Object
  - Basic ...and other supertypes
    MessageProducer ...and other supertypes

MessageProducer
- Basic
  - Identifiable
  - Object
    Anything
- WriteStream
  - StreamBase

no subtypes hierarchy

Initializer
`MessageProducer(MessageProducer<out Object> unknown)`

Inherited Attributes
Attributes inherited from: `Object` `hash`, `string`

Methods
`address`	`shared default String address()`
`close`	`shared default void close()` Closes the producer, this method should be called when the message producer is not used anymore.
`deliveryOptions`	`shared default MessageProducer<T> deliveryOptions(DeliveryOptions options)` Update the delivery options of this producer. Parameters: `options` the new options
`drainHandler`	`shared actual default MessageProducer<T> drainHandler(Anything()? handler)` 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 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`. Refines `WriteStream.drainHandler`
`end`	`shared actual default void end()` Closes the producer, calls close Refines `WriteStream.end`
`end`	`shared actual default void end(T t)` Same as end but writes some data to the stream before ending. Refines `WriteStream.end`
`exceptionHandler`	`shared actual default MessageProducer<T> exceptionHandler(Anything(Throwable)? handler)` Set an exception handler. Refines `StreamBase.exceptionHandler`
`send`	`shared default MessageProducer<T> send(T message)` Synonym for write. Parameters: `message` the message to send
`send`	`shared default MessageProducer<T> send<R>(T message, Anything(Throwable\|Message<R?>) replyHandler)`
`setWriteQueueMaxSize`	`shared actual default MessageProducer<T> setWriteQueueMaxSize(Integer 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 NetSocket, the number of Message for a MessageProducer, etc… Refines `WriteStream.setWriteQueueMaxSize`
`write`	`shared actual default MessageProducer<T> write(T data)` 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 writeQueueFull method before writing. This is done automatically if using a Pump. Refines `WriteStream.write`
`writeQueueFull`	`shared actual default Boolean writeQueueFull()` This will return `true` if there are more bytes in the write queue than the value set using setWriteQueueMaxSize Refines `WriteStream.writeQueueFull`

Inherited Methods
Methods inherited from: `Object` `equals`
Methods inherited from: `StreamBase` `exceptionHandler()`
Methods inherited from: `WriteStream<T>` `drainHandler()`, `end()`, `exceptionHandler()`, `setWriteQueueMaxSize()`, `write()`, `writeQueueFull()`