org.apache.ratis.util

Class SlidingWindow.Client<REQUEST extends SlidingWindow.ClientSideRequest<REPLY>,REPLY>

java.lang.Object

org.apache.ratis.util.SlidingWindow.Client<REQUEST,REPLY>

Enclosing interface:

SlidingWindow

public static class SlidingWindow.Client<REQUEST extends SlidingWindow.ClientSideRequest<REPLY>,REPLY>
extends Object

Client side sliding window. A client may (1) allocate seqNum for new requests; (2) send requests/retries to the server; (3) receive replies/exceptions from the server; (4) return the replies/exceptions to client. Depend on the replies/exceptions, the client may retry the requests to the same or a different server.

Constructor Summary

Constructors

Constructor and Description
Client(Object name)

Method Summary

Modifier and Type	Method and Description
void	fail(long startingSeqNum, Throwable e) Fail all requests starting from the given seqNum.
boolean	isFirst(long seqNum)
void	receiveReply(long seqNum, REPLY reply, Consumer<REQUEST> sendMethod) Receive a reply with the given seqNum (may out-of-order).
void	resetFirstSeqNum() Reset the firstSeqNum The stream has an error.
void	retry(REQUEST request, Consumer<REQUEST> sendMethod) Receive a retry from an existing request (may out-of-order).
REQUEST	submitNewRequest(LongFunction<REQUEST> requestConstructor, Consumer<REQUEST> sendMethod) A new request arrives, create it with nextSeqNum and then try sending it to the server.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Client

public Client(Object name)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

submitNewRequest

public REQUEST submitNewRequest(LongFunction<REQUEST> requestConstructor,
                                Consumer<REQUEST> sendMethod)

A new request arrives, create it with nextSeqNum and then try sending it to the server.

Parameters:

requestConstructor - use seqNum to create a new request.

Returns:

the new request.

retry

public void retry(REQUEST request,
                  Consumer<REQUEST> sendMethod)

Receive a retry from an existing request (may out-of-order).

receiveReply

public void receiveReply(long seqNum,
                         REPLY reply,
                         Consumer<REQUEST> sendMethod)

Receive a reply with the given seqNum (may out-of-order). It may trigger the client to send delayed requests.

resetFirstSeqNum

public void resetFirstSeqNum()

Reset the firstSeqNum The stream has an error.

fail

public void fail(long startingSeqNum,
                 Throwable e)

Fail all requests starting from the given seqNum.

isFirst

public boolean isFirst(long seqNum)