Represents a stream of message that can be written to.

no subtypes hierarchy

Initializer
MessageProducer(MessageProducer<out Object> unknown)
Inherited Attributes
Attributes inherited from: Object
hash, string
Methods
addressshared default String address()
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.

Parameters:
  • 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 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.

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)

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

Parameters:
  • message

    the message to send

sendshared default MessageProducer<T> send<R>(T message, Anything(Throwable|Message<R?>) replyHandler)

Like send but specifying a replyHandler that will be called if the recipient subsequently replies to the message.

Parameters:
  • message

    the message to send

  • replyHandler

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

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 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…

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
equals
Methods inherited from: StreamBase
Methods inherited from: WriteStream<T>