Represents a stream of message that can be written to.

no subtypes hierarchy

MessageProducer(MessageProducer<out Object> unknown)
Inherited Attributes
Attributes inherited from: Object
hash, string
addressshared default String address()

@return The address to which the producer produces messages.

closeshared default void close()

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

deliveryOptionsshared default MessageProducer<T> deliveryOptions(DeliveryOptions options)

Update the delivery options of this producer.

  • options

    the new options

drainHandlershared 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 has been reduced to maxSize / 2. See Pump for an example of this being used.

endshared actual default void end()

Closes the producer, calls close

endshared actual default void end(T? t)

Same as end but writes some data to the stream before ending.

exceptionHandlershared actual default MessageProducer<T> exceptionHandler(Anything(Throwable)? handler)

Set an exception handler.

sendshared default MessageProducer<T> send(T? message)

Synonym for write.

  • message

    the message to send

sendshared default MessageProducer<T> send<R>(T? message, Anything(Throwable|Message<R>) replyHandler)
setWriteQueueMaxSizeshared 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 bytes in the write queue. This is used as an indicator by classes such as Pump to provide flow control.

writeshared 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.

writeQueueFullshared actual default Boolean writeQueueFull()

This will return true if there are more bytes in the write queue than the value set using setWriteQueueMaxSize

Inherited Methods
Methods inherited from: Object
Methods inherited from: StreamBase
Methods inherited from: WriteStream<T>