okhttp3.mockwebserver

Class Dispatcher

java.lang.Object

okhttp3.mockwebserver.Dispatcher

Direct Known Subclasses:

OAuthSessionFactory, QueueDispatcher, SampleServer

public abstract class Dispatcher
extends Object

Handler for mock server requests.

Constructor Summary

Constructors

Constructor and Description
Dispatcher()

Method Summary

Modifier and Type	Method and Description
abstract MockResponse	dispatch(RecordedRequest request) Returns a response to satisfy request.
MockResponse	peek() Returns an early guess of the next response, used for policy on how an incoming request should be received.
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

Constructor Detail

Dispatcher

public Dispatcher()

Method Detail

dispatch

public abstract MockResponse dispatch(RecordedRequest request)
                               throws InterruptedException

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

Throws:

InterruptedException

peek

public MockResponse peek()

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.

shutdown

public void shutdown()

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.