com.solace.messaging.publisher

Interface PublisherHealthCheck.PublisherReadinessListener

Enclosing interface:

PublisherHealthCheck

public static interface PublisherHealthCheck.PublisherReadinessListener

An interface that is abstraction for the handling of a publisher instance's ability to take new messages and send them over the wire to a remote broker. The state of a publisher instance can change as a result of multiple factors, such as a full buffer, short-time I/O interruptions, and so on. Multiple conditions are checked before the notification is issued on the state of READY.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
void	ready() Executes when the publisher transitions from a state where it can't publish to a state where it eventually can publish as a result of congestion release.

Method Detail

ready

void ready()

Executes when the publisher transitions from a state where it can't publish to a state where it eventually can publish as a result of congestion release.

This method is executes on a thread different to the publisher thread. Additional synchronization may be required to ensure the processing of this method in order with a publishing thread.

When used in combination with PublisherHealthCheck.notifyWhenReady(), no additional synchronization is required to receive the READY notification after that.

In a concurrent, high throughput environment notifications may or may not accurately represent a current state of the publisher without proper synchronization.

Note: It is strongly recommended that client code inside of this callback method:

• is non-blocking manner
• executes as quickly as possible
• does not publish or receive message inside this method

If you use method to perform long running or blocking operations, it can have significant, unexpected side-effects for the client application in terms of stability and performance.

This method is not executed from the api when it is in a terminating state.

Since:

1.0