com.squareup.okhttp.ws

Class WebSocketCall

java.lang.Object

com.squareup.okhttp.ws.WebSocketCall

public final class WebSocketCall
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Cancels the request, if possible.
static WebSocketCall	create(OkHttpClient client, Request request) Prepares the request to create a web socket at some point in the future.
void	enqueue(WebSocketListener listener) Schedules the request to be executed at some point in the future.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static WebSocketCall create(OkHttpClient client,
                   Request request)

Prepares the request to create a web socket at some point in the future.

enqueue

public void enqueue(WebSocketListener listener)

Schedules the request to be executed at some point in the future.

The dispatcher defines when the request will run: usually immediately unless there are several other requests currently being executed.

This client will later call back responseCallback with either an HTTP response or a failure exception. If you cancel() a request before it completes the callback will not be invoked.

Throws:

IllegalStateException - when the call has already been executed.

cancel

public void cancel()

Cancels the request, if possible. Requests that are already complete cannot be canceled.