Package okhttp3.mockwebserver

Class QueueDispatcher

java.lang.Object

okhttp3.mockwebserver.Dispatcher

okhttp3.mockwebserver.QueueDispatcher

public class QueueDispatcher
extends Dispatcher

Default dispatcher that processes a script of responses. Populate the script by calling enqueueResponse(MockResponse).

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.concurrent.BlockingQueue<MockResponse>	responseQueue

Constructor Summary

Constructors

Constructor	Description
QueueDispatcher()

Method Summary

Modifier and Type	Method	Description
MockResponse	dispatch(RecordedRequest request)	Returns a response to satisfy request.
void	enqueueResponse(MockResponse response)
MockResponse	peek()	Returns an early guess of the next response, used for policy on how an incoming request should be received.
void	setFailFast(boolean failFast)
void	setFailFast(MockResponse failFastResponse)
void	shutdown()	Release any resources held by this dispatcher.

Methods inherited from class java.lang.Object

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

Field Detail

responseQueue

protected final java.util.concurrent.BlockingQueue<MockResponse> responseQueue

Constructor Detail

QueueDispatcher

public QueueDispatcher()

Method Detail

dispatch

public MockResponse dispatch(RecordedRequest request)
                      throws java.lang.InterruptedException

Description copied from class: Dispatcher

Returns a response to satisfy request. This method may block (for instance, to wait on a CountdownLatch).

Specified by:

dispatch in class Dispatcher

Throws:

java.lang.InterruptedException

peek

public MockResponse peek()

Description copied from class: Dispatcher

Returns an early guess of the next response, used for policy on how an incoming request should be received. The default implementation returns an empty response. Mischievous implementations can return other values to test HTTP edge cases, such as unhappy socket policies or throttled request bodies.

Overrides:

peek in class Dispatcher

enqueueResponse

public void enqueueResponse(MockResponse response)

shutdown

public void shutdown()

Description copied from class: Dispatcher

Release any resources held by this dispatcher. Any requests that are currently being dispatched should return immediately. Responses returned after shutdown will not be transmitted: their socket connections have already been closed.

Overrides:

shutdown in class Dispatcher

setFailFast

public void setFailFast(boolean failFast)

setFailFast

public void setFailFast(MockResponse failFastResponse)