Package net.sf.eBus.client

Interface CancelRequestCallback

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface CancelRequestCallback

A class implementing EReplier is not required to override EReplier.cancelRequest(EReplyFeed.ERequest, boolean). Instead, a Java lambda expression for CancelRequestCallback may be passed to EReplyFeed.Builder.cancelRequestCallback(CancelRequestCallback) and the lambda expression code will be executed when a request is canceled.

Author:

Charles W. Rapp

See Also:

EReplyFeed.Builder.cancelRequestCallback(CancelRequestCallback)

Method Summary

Modifier and Type	Method	Description
void	call(EReplyFeed.ERequest request, boolean mayRespond)	With eBus release 5.6.0 a second, parameter is added: mayRespond.

Method Detail

call

void call(EReplyFeed.ERequest request,
          boolean mayRespond)

With eBus release 5.6.0 a second, parameter is added: mayRespond. If true the replier accepts the cancel request, the replier should respond with an appropriate reply message (note that a new EReplyMessage.ReplyStatus has been added: CANCELED). If the replier rejects this cancel request then it may respond with a EReplyMessage with a status of CANCEL_REJECT and a reason for the reject. does nothing and continues to work the request.

if mayRespond is false then this is a unilateral request cancellation. The request is shut down and no further replies will be accepted. However, in-flight replies posted prior to cancellation may still be delivered.

request matches the replier's open and advertised feed. The associated EReplyFeed may be retrieved by calling EReplyFeed.ERequest.replier().

Parameters:

request - cancel this request.

mayRespond - set to true if replier is allowed to respond to the cancel request. This allows the replier to accept or reject the request cancellation.