The handler method that will be automatically attached to
the parent stream.
The handler method that will be automatically attached to
the parent stream. Generally, the body of this method will
include a call to fire or stop in response to the event.
The handler should return false if and only if it should be
detached from the parent stream. Once it is detached, it
will never be re-attached unless done explicitly.
An event sent from the parent stream.
true to remain attached to the parent; false to detach.
The stream that feeds events into this Pipe.
The stream that feeds events into this Pipe. The handle
method will automatically be attached to the parent, unless
the parent is stopped, in which case this stream will
automatically be stopped.
Returns a Future that will complete when this stream stops.
Returns a Future that will complete when this stream stops. The
resulting value will be a rough estimate (System.currentTimeMillis)
of when the stream ended. If the stream never ends, the resulting
Future will never complete.
A Future containing a time stamp describing when this stream stopped.
Attach an event handler for data fired by this stream.
Attach an event handler for data fired by this stream.
A function that takes in an event data and performs side effects.
Returns a Future that will complete with the value of the last
event fired by this stream.
Returns a Future that will complete with the value of the last
event fired by this stream. If the stream is stopped or becomes stopped
before firing an event, the Future will fail with a NoSuchElementException.
A Future containing the last event fired by this stream.
Returns a Future that will complete with the value of the next
event fired by this stream.
Returns a Future that will complete with the value of the next
event fired by this stream. If the stream is stopped, or if it
stops before firing an event, the Future will fail with a
NoSuchElementException.
A Future containing the next event fired by this stream.
Assign a block of code that will run when this stream stops.
Assign a block of code that will run when this stream stops. If this stream
is already stopped, the block of code will run immediately.
A block of code that will run when this stream sends a Stop event.
Assign a handler for the next event fired by this stream.
Assign a handler for the next event fired by this stream.
A function that takes in an event data and performs side effects.
It can be assumed that f will be run at most once.
Produce a new item.
Produce a new item. All handler functions will be called with item as
the argument. There is no guarantee of the order in which the handler
functions will be called.
The item to be sent to all handlers (sinks).
A number indicating the minimum number of cleared references that must be encountered before purging all cleared references from the list.
A number indicating the minimum number of cleared references that must be encountered before purging all cleared references from the list. This method may be overridden - the default value is 5.
Add a handler function that acts as a sink for items produced by this
Source.
Add a handler function that acts as a sink for items produced by this
Source. The handler is expected to return true as long as it remains
active. Once the handler function returns false in response to some
produced item, it will be deactivated and will no longer receive new items.
There is no guarantee of the order that handlers will be called.
The handler function to receive items produced by this Source.
Once the handler returns false in response to some produced item, it will
be deactivated and will no longer receive new items.
An implicit Observer which is required in order to properly
manage references between this Source and any handlers, avoiding
reference loops.
Marks whether or not this stream is stopped.
Marks whether or not this stream is stopped. A stopped stream will not produce any more events.
true if this stream is stopped, false otherwise.
(eventPipe: StringAdd).self
(eventPipe: StringFormat).self
(eventPipe: ArrowAssoc[EventPipe[A, B]]).x
(Since version 2.10.0) Use leftOfArrow instead
(eventPipe: Ensuring[EventPipe[A, B]]).x
(Since version 2.10.0) Use resultOfEnsuring instead
An EventPipe is a transformer that takes in events of type
Afrom a single parent EventStream and produces any number of new events of typeBin response.To create an EventPipe, implement the two required methods:
Generally,
handlewill callfireand/orstop. **Note** to see the method signatures in this documentation, make sure to select "Visibility: All".