OSGi 8.1.0 · org.osgi.util.pushstream.SimplePushEventSource

Method Summary

Modifier and Type	Method and Description
public void	close() Redeclares java.lang.AutoCloseable.close. Close this source.
public Promise<Void>	Returns: A promise representing the connection state of this EventSource connectPromise() This method can be used to delay event generation until an event source has connected.
public void	endOfStream() Close this source for now, but potentially reopen it later.
public void	error(Throwable the error t) Close this source for now, but potentially reopen it later.
public boolean	Returns: true if any consumers are currently connected isConnected() Determine whether there are any `PushEventConsumer`s for this `PushEventSource`.
public void	publish(T t) Asynchronously publish an event to this stream and all connected `PushEventConsumer` instances.

Inherited from org.osgi.util.pushstream.PushEventSource:: open

Method Detail

close back to summary

close	back to summary
public void close() Redeclares java.lang.AutoCloseable.close. Close this source. Calling this method indicates that there will never be any more events published by it. Calling this method sends a close event to all connected consumers. After calling this method any `PushEventConsumer` that tries to `open(PushEventConsumer)` this source will immediately receive a close event, and will not see any remaining buffered events. Annotations @Override

public void close()

Redeclares java.lang.AutoCloseable.close.

Close this source. Calling this method indicates that there will never be any more events published by it. Calling this method sends a close event to all connected consumers. After calling this method any PushEventConsumer that tries to open(PushEventConsumer) this source will immediately receive a close event, and will not see any remaining buffered events.

Annotations

@Override

connectPromise back to summary

connectPromise	back to summary
public Promise<Void> connectPromise() This method can be used to delay event generation until an event source has connected. The returned promise will resolve as soon as one or more `PushEventConsumer` instances have opened the SimplePushEventSource. The returned promise may already be resolved if this `SimplePushEventSource` already has connected consumers. If the `SimplePushEventSource` is closed before the returned Promise resolves then it will be failed with an `IllegalStateException`. Note that the connected consumers are able to asynchronously close their connections to this `SimplePushEventSource`, and therefore it is possible that once the promise resolves this `SimplePushEventSource` may no longer be connected to any consumers. Returns:Promise<Void> A promise representing the connection state of this EventSource

public Promise<Void> connectPromise()

This method can be used to delay event generation until an event source has connected. The returned promise will resolve as soon as one or more PushEventConsumer instances have opened the SimplePushEventSource.

The returned promise may already be resolved if this SimplePushEventSource already has connected consumers. If the SimplePushEventSource is closed before the returned Promise resolves then it will be failed with an IllegalStateException.

Note that the connected consumers are able to asynchronously close their connections to this SimplePushEventSource, and therefore it is possible that once the promise resolves this SimplePushEventSource may no longer be connected to any consumers.

Returns:Promise<Void>: A promise representing the connection state of this EventSource

endOfStream back to summary

endOfStream	back to summary
public void endOfStream() Close this source for now, but potentially reopen it later. Calling this method asynchronously sends a close event to all connected consumers and then disconnects them. Any events previously queued by the `publish(Object)` method will be delivered before this close event. After calling this method any `PushEventConsumer` that wishes may `open(PushEventConsumer)` this source, and will receive subsequent events.

public void endOfStream()

Close this source for now, but potentially reopen it later. Calling this method asynchronously sends a close event to all connected consumers and then disconnects them. Any events previously queued by the publish(Object) method will be delivered before this close event.

After calling this method any PushEventConsumer that wishes may open(PushEventConsumer) this source, and will receive subsequent events.

error back to summary

error	back to summary
public void error(Throwable t) Close this source for now, but potentially reopen it later. Calling this method asynchronously sends an error event to all connected consumers and then disconnects them. Any events previously queued by the `publish(Object)` method will be delivered before this error event. After calling this method any `PushEventConsumer` that wishes may `open(PushEventConsumer)` this source, and will receive subsequent events. Parameters t:Throwable the error

public void error(Throwable t)

Close this source for now, but potentially reopen it later. Calling this method asynchronously sends an error event to all connected consumers and then disconnects them. Any events previously queued by the publish(Object) method will be delivered before this error event.

After calling this method any PushEventConsumer that wishes may open(PushEventConsumer) this source, and will receive subsequent events.

Parameters

t:Throwable: the error

isConnected back to summary

isConnected	back to summary
public boolean isConnected() Determine whether there are any `PushEventConsumer`s for this `PushEventSource`. This can be used to skip expensive event creation logic when there are no listeners. Returns:boolean true if any consumers are currently connected

public boolean isConnected()

Determine whether there are any PushEventConsumers for this PushEventSource. This can be used to skip expensive event creation logic when there are no listeners.

Returns:boolean: true if any consumers are currently connected

publish back to summary

publish	back to summary
public void publish(T t) Asynchronously publish an event to this stream and all connected `PushEventConsumer` instances. When this method returns there is no guarantee that all consumers have been notified. Events published by a single thread will maintain their relative ordering, however they may be interleaved with events from other threads. Exceptions IllegalStateException: if the source is closed

public void publish(T t)

Asynchronously publish an event to this stream and all connected PushEventConsumer instances. When this method returns there is no guarantee that all consumers have been notified. Events published by a single thread will maintain their relative ordering, however they may be interleaved with events from other threads.

Exceptions

IllegalStateException:: if the source is closed

public Interface SimplePushEventSource<T>

Method Summary

Method Detail