Class BlockingPullSubscriberImpl (1.15.0)

public class BlockingPullSubscriberImpl implements BlockingPullSubscriber

Inheritance

java.lang.Object > BlockingPullSubscriberImpl

Implements

BlockingPullSubscriber

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

BlockingPullSubscriberImpl(SubscriberFactory factory, FlowControlSettings settings)

public BlockingPullSubscriberImpl(SubscriberFactory factory, FlowControlSettings settings)

Parameters
Name	Description
`factory`	`SubscriberFactory`
`settings`	`FlowControlSettings`

Methods

close()

public void close()

messageIfAvailable()

public synchronized Optional<SequencedMessage> messageIfAvailable()

Pull messages if there is any ready to deliver. Any message will only be delivered to one call if there are multiple concurrent calls.

Returns
Type	Description
`Optional<SequencedMessage>`

Exceptions
Type	Description
`CheckedApiException`

onData()

public synchronized ApiFuture<Void> onData()

Returns a ApiFuture that will be completed when there are messages available. Unfinished existing ApiFuture returned by onData() will be abandoned and superseded by new onData() call.

CheckedApiException will be set to the Future if there is underlying permanent error.

Returns
Type	Description
`ApiFuture<Void>`