Skip navigation links
A B C D E F G H I J K L M N O P Q R S T U V W 

A

abort() - Method in class com.squareup.okhttp.internal.DiskLruCache.Editor
Aborts this edit.
abort() - Method in interface com.squareup.okhttp.internal.http.CacheRequest
 
abortUnlessCommitted() - Method in class com.squareup.okhttp.internal.DiskLruCache.Editor
 
ACCEPT_MAGIC - Static variable in class com.squareup.okhttp.internal.ws.WebSocketProtocol
Magic value which must be appended to the key in a response header.
AccessHeaders - Class in com.squareup.okhttp.recipes
 
AccessHeaders() - Constructor for class com.squareup.okhttp.recipes.AccessHeaders
 
ackSettings() - Method in interface com.squareup.okhttp.internal.framed.FrameReader.Handler
HTTP/2 only.
ackSettings(Settings) - Method in interface com.squareup.okhttp.internal.framed.FrameWriter
Informs the peer that we've applied its latest settings.
acquire(RealConnection) - Method in class com.squareup.okhttp.internal.http.StreamAllocation
Use this allocation to hold connection.
add(String, String...) - Method in class com.squareup.okhttp.CertificatePinner.Builder
Pins certificates for hostname.
add(String, String) - Method in class com.squareup.okhttp.FormEncodingBuilder
Add new key-value pair.
add(String) - Method in class com.squareup.okhttp.Headers.Builder
Add an header line containing a field name, a literal colon, and a value.
add(String, String) - Method in class com.squareup.okhttp.Headers.Builder
Add a field with the specified value.
addConnectException(IOException) - Method in exception com.squareup.okhttp.internal.http.RouteException
 
addCookies(Request.Builder, Map<String, List<String>>) - Static method in class com.squareup.okhttp.internal.http.OkHeaders
 
addEncoded(String, String) - Method in class com.squareup.okhttp.FormEncodingBuilder
Add new key-value pair.
addEncodedPathSegment(String) - Method in class com.squareup.okhttp.HttpUrl.Builder
 
addEncodedQueryParameter(String, String) - Method in class com.squareup.okhttp.HttpUrl.Builder
Adds the pre-encoded query parameter to this URL's query string.
addFormDataPart(String, String) - Method in class com.squareup.okhttp.MultipartBuilder
Add a form data part to the body.
addFormDataPart(String, String, RequestBody) - Method in class com.squareup.okhttp.MultipartBuilder
Add a form data part to the body.
addHeader(String, String) - Method in class com.squareup.okhttp.Request.Builder
Adds a header with name and value.
addHeader(String, String) - Method in class com.squareup.okhttp.Response.Builder
Adds a header with name and value.
addLenient(Headers.Builder, String) - Method in class com.squareup.okhttp.internal.Internal
 
addLenient(Headers.Builder, String, String) - Method in class com.squareup.okhttp.internal.Internal
 
addPart(RequestBody) - Method in class com.squareup.okhttp.MultipartBuilder
Add a part to the body.
addPart(Headers, RequestBody) - Method in class com.squareup.okhttp.MultipartBuilder
Add a part to the body.
addPathSegment(String) - Method in class com.squareup.okhttp.HttpUrl.Builder
 
addQueryParameter(String, String) - Method in class com.squareup.okhttp.HttpUrl.Builder
Encodes the query parameter using UTF-8 and adds it to this URL's query string.
Address - Class in com.squareup.okhttp
A specification for a connection to an origin server.
Address(String, int, Dns, SocketFactory, SSLSocketFactory, HostnameVerifier, CertificatePinner, Authenticator, Proxy, List<Protocol>, List<ConnectionSpec>, ProxySelector) - Constructor for class com.squareup.okhttp.Address
 
address - Variable in class com.squareup.okhttp.internal.http.StreamAllocation
 
afterHandshake(SSLSocket) - Method in class com.squareup.okhttp.internal.Platform
allEnabledCipherSuites() - Method in class com.squareup.okhttp.ConnectionSpec.Builder
 
allEnabledTlsVersions() - Method in class com.squareup.okhttp.ConnectionSpec.Builder
 
allocationLimit() - Method in class com.squareup.okhttp.internal.io.RealConnection
 
allocations - Variable in class com.squareup.okhttp.internal.io.RealConnection
 
allSubjectAltNames(X509Certificate) - Static method in class com.squareup.okhttp.internal.tls.OkHostnameVerifier
 
alternateService(int, String, ByteString, String, int, long) - Method in interface com.squareup.okhttp.internal.framed.FrameReader.Handler
HTTP/2 only.
ALTERNATIVE - Static variable in class com.squareup.okhttp.MultipartBuilder
The "multipart/alternative" type is syntactically identical to "multipart/mixed", but the semantics are different.
AndroidTrustRootIndex - Class in com.squareup.okhttp.internal.tls
A index of trusted root certificates that exploits knowledge of Android implementation details.
AndroidTrustRootIndex(X509TrustManager, Method) - Constructor for class com.squareup.okhttp.internal.tls.AndroidTrustRootIndex
 
appendingSink(File) - Method in interface com.squareup.okhttp.internal.io.FileSystem
Writes to file, appending if data is already present.
appendingSink(File) - Method in class com.squareup.okhttp.internal.io.InMemoryFileSystem
 
apply(ConnectionSpec, SSLSocket, boolean) - Method in class com.squareup.okhttp.internal.Internal
 
apply(Statement, Description) - Method in class com.squareup.okhttp.internal.io.InMemoryFileSystem
 
AsynchronousGet - Class in com.squareup.okhttp.recipes
 
AsynchronousGet() - Constructor for class com.squareup.okhttp.recipes.AsynchronousGet
 
authenticate(Proxy, Response) - Method in interface com.squareup.okhttp.Authenticator
Returns a request that includes a credential to satisfy an authentication challenge in response.
authenticate(Proxy, Response) - Method in class com.squareup.okhttp.internal.http.AuthenticatorAdapter
 
Authenticate - Class in com.squareup.okhttp.recipes
 
Authenticate() - Constructor for class com.squareup.okhttp.recipes.Authenticate
 
authenticateProxy(Proxy, Response) - Method in interface com.squareup.okhttp.Authenticator
Returns a request that includes a credential to satisfy an authentication challenge made by response.
authenticateProxy(Proxy, Response) - Method in class com.squareup.okhttp.internal.http.AuthenticatorAdapter
 
Authenticator - Interface in com.squareup.okhttp
Responds to authentication challenges from the remote web or proxy server.
AuthenticatorAdapter - Class in com.squareup.okhttp.internal.http
AuthenticatorAdapter() - Constructor for class com.squareup.okhttp.internal.http.AuthenticatorAdapter
 
AutobahnTester - Class in com.squareup.okhttp.ws
Exercises the web socket implementation against the Autobahn Testsuite.
AutobahnTester() - Constructor for class com.squareup.okhttp.ws.AutobahnTester
 

B

basic(String, String) - Static method in class com.squareup.okhttp.Credentials
Returns an auth credential for the Basic scheme.
BINARY - Static variable in interface com.squareup.okhttp.ws.WebSocket
A MediaType indicating binary frames should be used when sending the message.
body() - Method in interface com.squareup.okhttp.internal.http.CacheRequest
 
body() - Method in class com.squareup.okhttp.Request
 
body() - Method in class com.squareup.okhttp.Response
 
body(ResponseBody) - Method in class com.squareup.okhttp.Response.Builder
 
bufferRequestBody - Variable in class com.squareup.okhttp.internal.http.HttpEngine
True if the request body must be completely buffered before transmission; false if it can be streamed.
build() - Method in class com.squareup.okhttp.CacheControl.Builder
 
build() - Method in class com.squareup.okhttp.CertificatePinner.Builder
 
build() - Method in class com.squareup.okhttp.ConnectionSpec.Builder
 
build() - Method in class com.squareup.okhttp.FormEncodingBuilder
 
build() - Method in class com.squareup.okhttp.Headers.Builder
 
build() - Method in class com.squareup.okhttp.HttpUrl.Builder
 
build() - Method in class com.squareup.okhttp.internal.framed.FramedConnection.Builder
 
build() - Method in class com.squareup.okhttp.MultipartBuilder
Assemble the specified parts into a request body.
build() - Method in class com.squareup.okhttp.Request.Builder
 
build() - Method in class com.squareup.okhttp.Response.Builder
 
Builder() - Constructor for class com.squareup.okhttp.CacheControl.Builder
 
Builder() - Constructor for class com.squareup.okhttp.CertificatePinner.Builder
 
Builder(ConnectionSpec) - Constructor for class com.squareup.okhttp.ConnectionSpec.Builder
 
Builder() - Constructor for class com.squareup.okhttp.Headers.Builder
 
Builder() - Constructor for class com.squareup.okhttp.HttpUrl.Builder
 
Builder(boolean) - Constructor for class com.squareup.okhttp.internal.framed.FramedConnection.Builder
 
Builder() - Constructor for class com.squareup.okhttp.Request.Builder
 
Builder() - Constructor for class com.squareup.okhttp.Response.Builder
 
bytes() - Method in class com.squareup.okhttp.ResponseBody
 
byteStream() - Method in class com.squareup.okhttp.ResponseBody
 

C

Cache - Class in com.squareup.okhttp
Caches HTTP and HTTPS responses to the filesystem so they may be reused, saving time and bandwidth.
Cache(File, long) - Constructor for class com.squareup.okhttp.Cache
 
CacheControl - Class in com.squareup.okhttp
A Cache-Control header with cache directives from a server or client.
cacheControl(CacheControl) - Method in class com.squareup.okhttp.Request.Builder
Sets this request's Cache-Control header, replacing any cache control headers already present.
cacheControl() - Method in class com.squareup.okhttp.Request
Returns the cache control directives for this response.
cacheControl() - Method in class com.squareup.okhttp.Response
Returns the cache control directives for this response.
CacheControl.Builder - Class in com.squareup.okhttp
Builds a Cache-Control request header.
CacheRequest - Interface in com.squareup.okhttp.internal.http
 
cacheResponse - Variable in class com.squareup.okhttp.internal.http.CacheStrategy
The cached response to return or validate; or null if this call doesn't use a cache.
CacheResponse - Class in com.squareup.okhttp.recipes
 
CacheResponse(File) - Constructor for class com.squareup.okhttp.recipes.CacheResponse
 
cacheResponse(Response) - Method in class com.squareup.okhttp.Response.Builder
 
cacheResponse() - Method in class com.squareup.okhttp.Response
Returns the raw response received from the cache.
CacheStrategy - Class in com.squareup.okhttp.internal.http
Given a request and cached response, this figures out whether to use the network, the cache, or both.
CacheStrategy.Factory - Class in com.squareup.okhttp.internal.http
 
Call - Class in com.squareup.okhttp
A call is a request that has been prepared for execution.
Call(OkHttpClient, Request) - Constructor for class com.squareup.okhttp.Call
 
Callback - Interface in com.squareup.okhttp
 
callEngineGetStreamAllocation(Call) - Method in class com.squareup.okhttp.internal.Internal
 
callEnqueue(Call, Callback, boolean) - Method in class com.squareup.okhttp.internal.Internal
 
calls - Variable in class com.squareup.okhttp.testing.RecordingHostnameVerifier
 
cancel() - Method in class com.squareup.okhttp.Call
Cancels the request, if possible.
cancel(Object) - Method in class com.squareup.okhttp.Dispatcher
Cancel all calls with the tag tag.
CANCEL - Static variable in interface com.squareup.okhttp.internal.framed.PushObserver
 
cancel() - Method in class com.squareup.okhttp.internal.http.Http1xStream
 
cancel() - Method in class com.squareup.okhttp.internal.http.Http2xStream
 
cancel() - Method in class com.squareup.okhttp.internal.http.HttpEngine
Immediately closes the socket connection if it's currently held by this engine.
cancel() - Method in interface com.squareup.okhttp.internal.http.HttpStream
Cancel this stream.
cancel() - Method in class com.squareup.okhttp.internal.http.StreamAllocation
 
cancel() - Method in class com.squareup.okhttp.internal.io.RealConnection
 
cancel(Object) - Method in class com.squareup.okhttp.OkHttpClient
Cancels all scheduled or in-flight calls tagged with tag.
cancel() - Method in class com.squareup.okhttp.ws.WebSocketCall
Cancels the request, if possible.
CancelCall - Class in com.squareup.okhttp.recipes
 
CancelCall() - Constructor for class com.squareup.okhttp.recipes.CancelCall
 
CertificateChainCleaner - Class in com.squareup.okhttp.internal.tls
Computes the effective certificate chain from the raw array returned by Java's built in TLS APIs.
CertificateChainCleaner(TrustRootIndex) - Constructor for class com.squareup.okhttp.internal.tls.CertificateChainCleaner
 
CertificatePinner - Class in com.squareup.okhttp
Constrains which certificates are trusted.
CertificatePinner.Builder - Class in com.squareup.okhttp
Builds a configured certificate pinner.
CertificatePinning - Class in com.squareup.okhttp.recipes
 
CertificatePinning() - Constructor for class com.squareup.okhttp.recipes.CertificatePinning
 
Challenge - Class in com.squareup.okhttp
An RFC 2617 challenge.
Challenge(String, String) - Constructor for class com.squareup.okhttp.Challenge
 
challenges() - Method in class com.squareup.okhttp.Response
Returns the authorization challenges appropriate for this response's code.
charset() - Method in class com.squareup.okhttp.MediaType
Returns the charset of this media type, or null if this media type doesn't specify a charset.
charset(Charset) - Method in class com.squareup.okhttp.MediaType
Returns the charset of this media type, or defaultValue if this media type doesn't specify a charset.
charStream() - Method in class com.squareup.okhttp.ResponseBody
Returns the response as a character stream decoded with the charset of the Content-Type header.
check(String, List<Certificate>) - Method in class com.squareup.okhttp.CertificatePinner
Confirms that at least one of the certificates pinned for hostname is in peerCertificates.
check(String, Certificate...) - Method in class com.squareup.okhttp.CertificatePinner
Deprecated.
CheckHandshake - Class in com.squareup.okhttp.recipes
 
CheckHandshake() - Constructor for class com.squareup.okhttp.recipes.CheckHandshake
 
checkOffsetAndCount(long, long, long) - Static method in class com.squareup.okhttp.internal.Util
 
CipherSuite - Enum in com.squareup.okhttp
cipherSuite() - Method in class com.squareup.okhttp.Handshake
Returns a cipher suite name like "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA".
cipherSuites(CipherSuite...) - Method in class com.squareup.okhttp.ConnectionSpec.Builder
 
cipherSuites(String...) - Method in class com.squareup.okhttp.ConnectionSpec.Builder
 
cipherSuites() - Method in class com.squareup.okhttp.ConnectionSpec
Returns the cipher suites to use for a connection.
clean(List<Certificate>) - Method in class com.squareup.okhttp.internal.tls.CertificateChainCleaner
Returns a cleaned chain for chain.
CLEARTEXT - Static variable in class com.squareup.okhttp.ConnectionSpec
Unencrypted, unauthenticated connections for http: URLs.
clone() - Method in class com.squareup.okhttp.OkHttpClient
Returns a shallow copy of this OkHttpClient.
close() - Method in class com.squareup.okhttp.Cache
 
close() - Method in class com.squareup.okhttp.internal.DiskLruCache
Closes this cache.
close() - Method in class com.squareup.okhttp.internal.DiskLruCache.Snapshot
 
close() - Method in class com.squareup.okhttp.internal.framed.FramedConnection
Closes this connection.
close(ErrorCode) - Method in class com.squareup.okhttp.internal.framed.FramedStream
Abnormally terminate this stream.
close() - Method in class com.squareup.okhttp.internal.http.HttpEngine
Release any resources held by this engine.
close() - Method in class com.squareup.okhttp.internal.http.RetryableSink
 
close(int, String) - Method in class com.squareup.okhttp.internal.ws.RealWebSocket
 
close() - Method in class com.squareup.okhttp.internal.ws.RealWebSocket
Perform any tear-down work (close the connection, shutdown executors).
close() - Method in class com.squareup.okhttp.ResponseBody
 
close(int, String) - Method in interface com.squareup.okhttp.ws.WebSocket
Send a close frame to the server.
closeAll(Closeable, Closeable) - Static method in class com.squareup.okhttp.internal.Util
Closes a and b.
closeLater(ErrorCode) - Method in class com.squareup.okhttp.internal.framed.FramedStream
Abnormally terminate this stream.
closeQuietly(Closeable) - Static method in class com.squareup.okhttp.internal.Util
Closes closeable, ignoring any checked exceptions.
closeQuietly(Socket) - Static method in class com.squareup.okhttp.internal.Util
Closes socket, ignoring any checked exceptions.
closeQuietly(ServerSocket) - Static method in class com.squareup.okhttp.internal.Util
Closes serverSocket, ignoring any checked exceptions.
code - Variable in class com.squareup.okhttp.internal.http.StatusLine
 
code(int) - Method in class com.squareup.okhttp.Response.Builder
 
code() - Method in class com.squareup.okhttp.Response
Returns the HTTP status code.
com.squareup.okhttp - package com.squareup.okhttp
 
com.squareup.okhttp.apache - package com.squareup.okhttp.apache
 
com.squareup.okhttp.guide - package com.squareup.okhttp.guide
 
com.squareup.okhttp.internal - package com.squareup.okhttp.internal
 
com.squareup.okhttp.internal.framed - package com.squareup.okhttp.internal.framed
 
com.squareup.okhttp.internal.http - package com.squareup.okhttp.internal.http
 
com.squareup.okhttp.internal.io - package com.squareup.okhttp.internal.io
 
com.squareup.okhttp.internal.tls - package com.squareup.okhttp.internal.tls
 
com.squareup.okhttp.internal.ws - package com.squareup.okhttp.internal.ws
 
com.squareup.okhttp.logging - package com.squareup.okhttp.logging
 
com.squareup.okhttp.recipes - package com.squareup.okhttp.recipes
 
com.squareup.okhttp.sample - package com.squareup.okhttp.sample
 
com.squareup.okhttp.testing - package com.squareup.okhttp.testing
 
com.squareup.okhttp.ws - package com.squareup.okhttp.ws
 
commit() - Method in class com.squareup.okhttp.internal.DiskLruCache.Editor
Commits this edit so it is visible to readers.
COMPATIBLE_TLS - Static variable in class com.squareup.okhttp.ConnectionSpec
A backwards-compatible fallback connection for interop with obsolete servers.
concat(String[], String) - Static method in class com.squareup.okhttp.internal.Util
 
configureSecureSocket(SSLSocket) - Method in class com.squareup.okhttp.internal.ConnectionSpecSelector
Configures the supplied SSLSocket to connect to the specified host using an appropriate ConnectionSpec.
ConfigureTimeouts - Class in com.squareup.okhttp.recipes
 
ConfigureTimeouts() - Constructor for class com.squareup.okhttp.recipes.ConfigureTimeouts
 
configureTlsExtensions(SSLSocket, String, List<Protocol>) - Method in class com.squareup.okhttp.internal.Platform
Configure TLS extensions on sslSocket for route.
connect(int, int, int, List<ConnectionSpec>, boolean) - Method in class com.squareup.okhttp.internal.io.RealConnection
 
connected(Route) - Method in class com.squareup.okhttp.internal.RouteDatabase
Records success connecting to failedRoute.
connectFailed(Route, IOException) - Method in class com.squareup.okhttp.internal.http.RouteSelector
Clients should invoke this method when they encounter a connectivity failure on a connection returned by this route selector.
Connection - Interface in com.squareup.okhttp
The sockets and streams of an HTTP, HTTPS, or HTTPS+SPDY connection.
connection() - Method in interface com.squareup.okhttp.Interceptor.Chain
 
connection() - Method in class com.squareup.okhttp.internal.http.StreamAllocation
 
connectionBecameIdle(ConnectionPool, RealConnection) - Method in class com.squareup.okhttp.internal.Internal
 
connectionFailed(IOException) - Method in class com.squareup.okhttp.internal.ConnectionSpecSelector
Reports a failure to complete a connection.
connectionFailed() - Method in class com.squareup.okhttp.internal.http.StreamAllocation
Finish the current stream and prevent new streams from being created.
ConnectionPool - Class in com.squareup.okhttp
Manages reuse of HTTP and SPDY connections for reduced network latency.
ConnectionPool(int, long) - Constructor for class com.squareup.okhttp.ConnectionPool
 
ConnectionPool(int, long, TimeUnit) - Constructor for class com.squareup.okhttp.ConnectionPool
 
connectionPreface() - Method in interface com.squareup.okhttp.internal.framed.FrameWriter
HTTP/2 only.
ConnectionSpec - Class in com.squareup.okhttp
Specifies configuration for the socket connection that HTTP traffic travels through.
ConnectionSpec.Builder - Class in com.squareup.okhttp
 
ConnectionSpecSelector - Class in com.squareup.okhttp.internal
Handles the connection spec fallback strategy: When a secure socket connection fails due to a handshake / protocol problem the connection may be retried with different protocols.
ConnectionSpecSelector(List<ConnectionSpec>) - Constructor for class com.squareup.okhttp.internal.ConnectionSpecSelector
 
connectSocket(Socket, InetSocketAddress, int) - Method in class com.squareup.okhttp.internal.Platform
 
contains(String[], String) - Static method in class com.squareup.okhttp.internal.Util
 
contentLength(Request) - Static method in class com.squareup.okhttp.internal.http.OkHeaders
 
contentLength(Response) - Static method in class com.squareup.okhttp.internal.http.OkHeaders
 
contentLength(Headers) - Static method in class com.squareup.okhttp.internal.http.OkHeaders
 
contentLength() - Method in class com.squareup.okhttp.internal.http.RealResponseBody
 
contentLength() - Method in class com.squareup.okhttp.internal.http.RetryableSink
 
contentLength() - Method in class com.squareup.okhttp.RequestBody
Returns the number of bytes that will be written to out in a call to RequestBody.writeTo(okio.BufferedSink), or -1 if that count is unknown.
contentLength() - Method in class com.squareup.okhttp.ResponseBody
Returns the number of bytes in that will returned by ResponseBody.bytes(), or ResponseBody.byteStream(), or -1 if unknown.
contentType() - Method in class com.squareup.okhttp.internal.http.RealResponseBody
 
contentType() - Method in class com.squareup.okhttp.RequestBody
Returns the Content-Type header for this body.
contentType() - Method in class com.squareup.okhttp.ResponseBody
 
create(FileSystem, File, int, int, long) - Static method in class com.squareup.okhttp.internal.DiskLruCache
Create a cache which will reside in directory.
create(MediaType, String) - Static method in class com.squareup.okhttp.RequestBody
Returns a new request body that transmits content.
create(MediaType, ByteString) - Static method in class com.squareup.okhttp.RequestBody
Returns a new request body that transmits content.
create(MediaType, byte[]) - Static method in class com.squareup.okhttp.RequestBody
Returns a new request body that transmits content.
create(MediaType, byte[], int, int) - Static method in class com.squareup.okhttp.RequestBody
Returns a new request body that transmits content.
create(MediaType, File) - Static method in class com.squareup.okhttp.RequestBody
Returns a new request body that transmits the content of file.
create(MediaType, String) - Static method in class com.squareup.okhttp.ResponseBody
Returns a new response body that transmits content.
create(MediaType, byte[]) - Static method in class com.squareup.okhttp.ResponseBody
Returns a new response body that transmits content.
create(MediaType, long, BufferedSource) - Static method in class com.squareup.okhttp.ResponseBody
Returns a new response body that transmits content.
create(OkHttpClient, Request) - Static method in class com.squareup.okhttp.ws.WebSocketCall
Prepares the request to create a web socket at some point in the future.
createRequestBody(Request, long) - Method in class com.squareup.okhttp.internal.http.Http1xStream
 
createRequestBody(Request, long) - Method in class com.squareup.okhttp.internal.http.Http2xStream
 
createRequestBody(Request, long) - Method in interface com.squareup.okhttp.internal.http.HttpStream
Returns an output stream where the request body can be streamed.
Credentials - Class in com.squareup.okhttp
Factory for HTTP authorization credentials.
CustomTrust - Class in com.squareup.okhttp.recipes
 
CustomTrust() - Constructor for class com.squareup.okhttp.recipes.CustomTrust
 

D

data(boolean, int, BufferedSource, int) - Method in interface com.squareup.okhttp.internal.framed.FrameReader.Handler
 
data(boolean, int, Buffer, int) - Method in interface com.squareup.okhttp.internal.framed.FrameWriter
source.length may be longer than the max length of the variant's data frame.
DEFAULT - Static variable in class com.squareup.okhttp.CertificatePinner
 
DEFAULT - Static variable in interface com.squareup.okhttp.logging.HttpLoggingInterceptor.Logger
A HttpLoggingInterceptor.Logger defaults output appropriate for the current platform.
defaultPort(String) - Static method in class com.squareup.okhttp.HttpUrl
Returns 80 if scheme.equals("http"), 443 if scheme.equals("https") and -1 otherwise.
delete() - Method in class com.squareup.okhttp.Cache
Closes the cache and deletes all of its stored values.
delete() - Method in class com.squareup.okhttp.internal.DiskLruCache
Closes the cache and deletes all of its stored values.
delete(File) - Method in interface com.squareup.okhttp.internal.io.FileSystem
Deletes file if it exists.
delete(File) - Method in class com.squareup.okhttp.internal.io.InMemoryFileSystem
 
delete(RequestBody) - Method in class com.squareup.okhttp.Request.Builder
 
delete() - Method in class com.squareup.okhttp.Request.Builder
 
deleteContents(File) - Method in interface com.squareup.okhttp.internal.io.FileSystem
Recursively delete the contents of directory.
deleteContents(File) - Method in class com.squareup.okhttp.internal.io.InMemoryFileSystem
 
DIGEST - Static variable in class com.squareup.okhttp.MultipartBuilder
This type is syntactically identical to "multipart/mixed", but the semantics are different.
discard(Source, int, TimeUnit) - Static method in class com.squareup.okhttp.internal.Util
Attempts to exhaust source, returning true if successful.
DISCARD_STREAM_TIMEOUT_MILLIS - Static variable in interface com.squareup.okhttp.internal.http.HttpStream
The timeout to use while discarding a stream of input data.
DiskLruCache - Class in com.squareup.okhttp.internal
A cache that uses a bounded amount of space on a filesystem.
DiskLruCache.Editor - Class in com.squareup.okhttp.internal
Edits the values for an entry.
DiskLruCache.Snapshot - Class in com.squareup.okhttp.internal
A snapshot of the values for an entry.
Dispatcher - Class in com.squareup.okhttp
Policy on when async requests are executed.
Dispatcher(ExecutorService) - Constructor for class com.squareup.okhttp.Dispatcher
 
Dispatcher() - Constructor for class com.squareup.okhttp.Dispatcher
 
Dns - Interface in com.squareup.okhttp
A domain name service that resolves IP addresses for host names.

E

edit(String) - Method in class com.squareup.okhttp.internal.DiskLruCache
Returns an editor for the entry named key, or null if another edit is in progress.
edit() - Method in class com.squareup.okhttp.internal.DiskLruCache.Snapshot
Returns an editor for this snapshot's entry, or null if either the entry has changed since this snapshot was created or if another edit is in progress.
EMPTY_BYTE_ARRAY - Static variable in class com.squareup.okhttp.internal.Util
 
EMPTY_STRING_ARRAY - Static variable in class com.squareup.okhttp.internal.Util
 
encodedFragment(String) - Method in class com.squareup.okhttp.HttpUrl.Builder
 
encodedFragment() - Method in class com.squareup.okhttp.HttpUrl
 
encodedPassword(String) - Method in class com.squareup.okhttp.HttpUrl.Builder
 
encodedPassword() - Method in class com.squareup.okhttp.HttpUrl
Returns the password, or an empty string if none is set.
encodedPath(String) - Method in class com.squareup.okhttp.HttpUrl.Builder
 
encodedPath() - Method in class com.squareup.okhttp.HttpUrl
Returns the entire path of this URL, encoded for use in HTTP resource resolution.
encodedPathSegments() - Method in class com.squareup.okhttp.HttpUrl
 
encodedQuery(String) - Method in class com.squareup.okhttp.HttpUrl.Builder
 
encodedQuery() - Method in class com.squareup.okhttp.HttpUrl
Returns the query of this URL, encoded for use in HTTP resource resolution.
encodedUsername(String) - Method in class com.squareup.okhttp.HttpUrl.Builder
 
encodedUsername() - Method in class com.squareup.okhttp.HttpUrl
Returns the username, or an empty string if none is set.
enqueue(Callback) - Method in class com.squareup.okhttp.Call
Schedules the request to be executed at some point in the future.
enqueue(WebSocketListener) - Method in class com.squareup.okhttp.ws.WebSocketCall
Schedules the request to be executed at some point in the future.
ensureResourcesClosed() - Method in class com.squareup.okhttp.internal.io.InMemoryFileSystem
 
equal(Object, Object) - Static method in class com.squareup.okhttp.internal.Util
Returns true if two possibly-null objects are equal.
equals(Object) - Method in class com.squareup.okhttp.Address
 
equals(Object) - Method in class com.squareup.okhttp.Challenge
 
equals(Object) - Method in class com.squareup.okhttp.ConnectionSpec
 
equals(Object) - Method in class com.squareup.okhttp.Handshake
 
equals(Object) - Method in class com.squareup.okhttp.HttpUrl
 
equals(Object) - Method in class com.squareup.okhttp.internal.framed.Header
 
equals(Object) - Method in class com.squareup.okhttp.MediaType
 
equals(Object) - Method in class com.squareup.okhttp.Route
 
ErrorCode - Enum in com.squareup.okhttp.internal.framed
 
evictAll() - Method in class com.squareup.okhttp.Cache
Deletes all values stored in the cache.
evictAll() - Method in class com.squareup.okhttp.ConnectionPool
Close and remove all idle connections in the pool.
evictAll() - Method in class com.squareup.okhttp.internal.DiskLruCache
Deletes all stored values from the cache.
execute(HttpUriRequest) - Method in class com.squareup.okhttp.apache.OkApacheClient
 
execute(HttpUriRequest, HttpContext) - Method in class com.squareup.okhttp.apache.OkApacheClient
 
execute(HttpHost, HttpRequest) - Method in class com.squareup.okhttp.apache.OkApacheClient
 
execute(HttpHost, HttpRequest, HttpContext) - Method in class com.squareup.okhttp.apache.OkApacheClient
 
execute(HttpUriRequest, ResponseHandler<? extends T>) - Method in class com.squareup.okhttp.apache.OkApacheClient
 
execute(HttpUriRequest, ResponseHandler<? extends T>, HttpContext) - Method in class com.squareup.okhttp.apache.OkApacheClient
 
execute(HttpHost, HttpRequest, ResponseHandler<? extends T>) - Method in class com.squareup.okhttp.apache.OkApacheClient
 
execute(HttpHost, HttpRequest, ResponseHandler<? extends T>, HttpContext) - Method in class com.squareup.okhttp.apache.OkApacheClient
 
execute() - Method in class com.squareup.okhttp.Call
Invokes the request immediately, and blocks until the response can be processed or is in error.
execute() - Method in class com.squareup.okhttp.internal.NamedRunnable
 
exists(File) - Method in interface com.squareup.okhttp.internal.io.FileSystem
Returns true if file exists on the file system.
exists(File) - Method in class com.squareup.okhttp.internal.io.InMemoryFileSystem
 

F

Factory(long, Request, Response) - Constructor for class com.squareup.okhttp.internal.http.CacheStrategy.Factory
 
failed(Route) - Method in class com.squareup.okhttp.internal.RouteDatabase
Records a failure connecting to failedRoute.
failedRoutesCount() - Method in class com.squareup.okhttp.internal.RouteDatabase
 
failIfHeadersAbsent() - Method in enum com.squareup.okhttp.internal.framed.HeadersMode
Returns true if it is an error these headers to be the initial headers of a response.
failIfHeadersPresent() - Method in enum com.squareup.okhttp.internal.framed.HeadersMode
Returns true if it is an error these headers to be update existing headers of a response.
failIfStreamAbsent() - Method in enum com.squareup.okhttp.internal.framed.HeadersMode
Returns true if it is an error these headers to create a new stream.
failIfStreamPresent() - Method in enum com.squareup.okhttp.internal.framed.HeadersMode
Returns true if it is an error these headers to update an existing stream.
FileSystem - Interface in com.squareup.okhttp.internal.io
Access to read and write files on a hierarchical data store.
findByIssuerAndSignature(X509Certificate) - Method in class com.squareup.okhttp.internal.tls.AndroidTrustRootIndex
 
findByIssuerAndSignature(X509Certificate) - Method in class com.squareup.okhttp.internal.tls.RealTrustRootIndex
 
findByIssuerAndSignature(X509Certificate) - Method in interface com.squareup.okhttp.internal.tls.TrustRootIndex
Returns the trusted CA certificate that signed cert.
finishRequest() - Method in class com.squareup.okhttp.internal.http.Http1xStream
 
finishRequest() - Method in class com.squareup.okhttp.internal.http.Http2xStream
 
finishRequest() - Method in interface com.squareup.okhttp.internal.http.HttpStream
Flush the request to the underlying socket.
flush() - Method in class com.squareup.okhttp.Cache
 
flush() - Method in class com.squareup.okhttp.internal.DiskLruCache
Force buffered operations to the filesystem.
flush() - Method in class com.squareup.okhttp.internal.framed.FramedConnection
 
flush() - Method in interface com.squareup.okhttp.internal.framed.FrameWriter
SPDY/3 only.
flush() - Method in class com.squareup.okhttp.internal.http.RetryableSink
 
followUpRequest() - Method in class com.squareup.okhttp.internal.http.HttpEngine
Figures out the HTTP request to make in response to receiving this engine's response.
FORCE_CACHE - Static variable in class com.squareup.okhttp.CacheControl
Cache control request directives that uses the cache only, even if the cached response is stale.
FORCE_NETWORK - Static variable in class com.squareup.okhttp.CacheControl
Cache control request directives that require network validation of responses.
forJavaName(String) - Static method in enum com.squareup.okhttp.CipherSuite
 
forJavaName(String) - Static method in enum com.squareup.okhttp.TlsVersion
 
FORM - Static variable in class com.squareup.okhttp.MultipartBuilder
The media-type multipart/form-data follows the rules of all multipart MIME data streams as outlined in RFC 2046.
format(Date) - Static method in class com.squareup.okhttp.internal.http.HttpDate
Returns the string for value.
FormEncodingBuilder - Class in com.squareup.okhttp
Fluent API to build HTML 2.0-compliant form data.
FormEncodingBuilder() - Constructor for class com.squareup.okhttp.FormEncodingBuilder
 
fragment(String) - Method in class com.squareup.okhttp.HttpUrl.Builder
 
fragment() - Method in class com.squareup.okhttp.HttpUrl
 
FramedConnection - Class in com.squareup.okhttp.internal.framed
A socket connection to a remote peer.
framedConnection - Variable in class com.squareup.okhttp.internal.io.RealConnection
 
FramedConnection.Builder - Class in com.squareup.okhttp.internal.framed
 
FramedConnection.Listener - Class in com.squareup.okhttp.internal.framed
Listener of streams and settings initiated by the peer.
FramedStream - Class in com.squareup.okhttp.internal.framed
A logical bidirectional stream.
FrameReader - Interface in com.squareup.okhttp.internal.framed
Reads transport frames for SPDY/3 or HTTP/2.
FrameReader.Handler - Interface in com.squareup.okhttp.internal.framed
 
FrameWriter - Interface in com.squareup.okhttp.internal.framed
Writes transport frames for SPDY/3 or HTTP/2.
fromHttp2(int) - Static method in enum com.squareup.okhttp.internal.framed.ErrorCode
 
fromSpdy3Rst(int) - Static method in enum com.squareup.okhttp.internal.framed.ErrorCode
 
fromSpdyGoAway(int) - Static method in enum com.squareup.okhttp.internal.framed.ErrorCode
 

G

get(SSLSession) - Static method in class com.squareup.okhttp.Handshake
 
get(String, List<Certificate>, List<Certificate>) - Static method in class com.squareup.okhttp.Handshake
 
get(String) - Method in class com.squareup.okhttp.Headers.Builder
Equivalent to build().get(name), but potentially faster.
get(String) - Method in class com.squareup.okhttp.Headers
Returns the last value corresponding to the specified field, or null.
get(URL) - Static method in class com.squareup.okhttp.HttpUrl
Returns an HttpUrl for url if its protocol is http or https, or null if it has any other protocol.
get(URI) - Static method in class com.squareup.okhttp.HttpUrl
 
get(String) - Method in class com.squareup.okhttp.internal.DiskLruCache
Returns a snapshot of the entry named key, or null if it doesn't exist is not currently readable.
get() - Method in class com.squareup.okhttp.internal.http.CacheStrategy.Factory
Returns a strategy to satisfy request using the a cached response response.
get(Response) - Static method in class com.squareup.okhttp.internal.http.StatusLine
 
get(ConnectionPool, Address, StreamAllocation) - Method in class com.squareup.okhttp.internal.Internal
 
get(Request) - Method in interface com.squareup.okhttp.internal.InternalCache
 
get() - Static method in class com.squareup.okhttp.internal.Platform
 
get(X509TrustManager) - Static method in class com.squareup.okhttp.internal.tls.AndroidTrustRootIndex
 
get(String) - Static method in enum com.squareup.okhttp.Protocol
Returns the protocol identified by protocol.
get() - Method in class com.squareup.okhttp.Request.Builder
 
getAddress() - Method in class com.squareup.okhttp.Route
 
getAuthenticator() - Method in class com.squareup.okhttp.Address
Returns the client's authenticator.
getAuthenticator() - Method in class com.squareup.okhttp.OkHttpClient
 
getBufferedRequestBody() - Method in class com.squareup.okhttp.internal.http.HttpEngine
 
getCache() - Method in class com.squareup.okhttp.OkHttpClient
 
getCause() - Method in exception com.squareup.okhttp.internal.http.RequestException
 
getCertificatePinner() - Method in class com.squareup.okhttp.Address
Returns this address's certificate pinner, or null if this is not an HTTPS address.
getCertificatePinner() - Method in class com.squareup.okhttp.OkHttpClient
 
getConnection() - Method in class com.squareup.okhttp.internal.framed.FramedStream
 
getConnection() - Method in class com.squareup.okhttp.internal.http.HttpEngine
 
getConnectionCount() - Method in class com.squareup.okhttp.ConnectionPool
Returns total number of connections in the pool.
getConnectionManager() - Method in class com.squareup.okhttp.apache.OkApacheClient
 
getConnectionPool() - Method in class com.squareup.okhttp.OkHttpClient
 
getConnectionSpecs() - Method in class com.squareup.okhttp.Address
 
getConnectionSpecs() - Method in class com.squareup.okhttp.OkHttpClient
 
getConnectTimeout() - Method in class com.squareup.okhttp.OkHttpClient
Default connect timeout (in milliseconds).
getCookieHandler() - Method in class com.squareup.okhttp.OkHttpClient
 
getDate(String) - Method in class com.squareup.okhttp.Headers
Returns the last value corresponding to the specified field parsed as an HTTP date, or null if either the field is absent or cannot be parsed as a date.
getDefault() - Static method in class com.squareup.okhttp.ConnectionPool
 
getDirectory() - Method in class com.squareup.okhttp.Cache
 
getDirectory() - Method in class com.squareup.okhttp.internal.DiskLruCache
Returns the directory where this cache stores its data.
getDispatcher() - Method in class com.squareup.okhttp.OkHttpClient
 
getDns() - Method in class com.squareup.okhttp.Address
Returns the service that will be used to resolve IP addresses for hostnames.
getDns() - Method in class com.squareup.okhttp.OkHttpClient
 
getErrorCode() - Method in class com.squareup.okhttp.internal.framed.FramedStream
Returns the reason why this stream was closed, or null if it closed normally or has not yet been closed.
GetExample - Class in com.squareup.okhttp.guide
 
GetExample() - Constructor for class com.squareup.okhttp.guide.GetExample
 
getExecutorService() - Method in class com.squareup.okhttp.Dispatcher
 
getFollowRedirects() - Method in class com.squareup.okhttp.OkHttpClient
 
getFollowSslRedirects() - Method in class com.squareup.okhttp.OkHttpClient
 
getHandshake() - Method in interface com.squareup.okhttp.Connection
 
getHandshake() - Method in class com.squareup.okhttp.internal.io.RealConnection
 
getHitCount() - Method in class com.squareup.okhttp.Cache
 
getHostnameVerifier() - Method in class com.squareup.okhttp.Address
Returns the hostname verifier, or null if this is not an HTTPS address.
getHostnameVerifier() - Method in class com.squareup.okhttp.OkHttpClient
 
getHttpConnectionCount() - Method in class com.squareup.okhttp.ConnectionPool
Returns total number of http connections in the pool.
getHttpUrlChecked(String) - Method in class com.squareup.okhttp.internal.Internal
 
getId() - Method in class com.squareup.okhttp.internal.framed.FramedStream
 
getIdleConnectionCount() - Method in class com.squareup.okhttp.ConnectionPool
Returns the number of idle connections in the pool.
getIdleStartTimeNs() - Method in class com.squareup.okhttp.internal.framed.FramedConnection
Returns the time in ns when this connection became idle or Long.MAX_VALUE if connection is not idle.
getLastConnectException() - Method in exception com.squareup.okhttp.internal.http.RouteException
 
getLength(int) - Method in class com.squareup.okhttp.internal.DiskLruCache.Snapshot
Returns the byte length of the value for index.
getLevel() - Method in class com.squareup.okhttp.logging.HttpLoggingInterceptor
 
getMaxRequests() - Method in class com.squareup.okhttp.Dispatcher
 
getMaxRequestsPerHost() - Method in class com.squareup.okhttp.Dispatcher
 
getMaxSize() - Method in class com.squareup.okhttp.Cache
 
getMaxSize() - Method in class com.squareup.okhttp.internal.DiskLruCache
Returns the maximum number of bytes that this cache should use to store its data.
getMultiplexedConnectionCount() - Method in class com.squareup.okhttp.ConnectionPool
Returns total number of multiplexed connections in the pool.
getNetworkCount() - Method in class com.squareup.okhttp.Cache
 
getParams() - Method in class com.squareup.okhttp.apache.OkApacheClient
 
getPrefix() - Method in class com.squareup.okhttp.internal.Platform
Prefix used on custom headers.
getProtocol() - Method in interface com.squareup.okhttp.Connection
Returns the protocol negotiated by this connection, or Protocol.HTTP_1_1 if no protocol has been negotiated.
getProtocol() - Method in class com.squareup.okhttp.internal.framed.FramedConnection
The protocol as selected using ALPN.
getProtocol() - Method in class com.squareup.okhttp.internal.framed.Http2
 
getProtocol() - Method in class com.squareup.okhttp.internal.framed.Spdy3
 
getProtocol() - Method in interface com.squareup.okhttp.internal.framed.Variant
The protocol as selected using ALPN.
getProtocol() - Method in class com.squareup.okhttp.internal.io.RealConnection
 
getProtocols() - Method in class com.squareup.okhttp.Address
Returns the protocols the client supports.
getProtocols() - Method in class com.squareup.okhttp.OkHttpClient
 
getProxy() - Method in class com.squareup.okhttp.Address
Returns this address's explicitly-specified HTTP proxy, or null to delegate to the proxy selector.
getProxy() - Method in class com.squareup.okhttp.OkHttpClient
 
getProxy() - Method in class com.squareup.okhttp.Route
Returns the Proxy of this route.
getProxySelector() - Method in class com.squareup.okhttp.Address
Returns this address's proxy selector.
getProxySelector() - Method in class com.squareup.okhttp.OkHttpClient
 
getQueuedCallCount() - Method in class com.squareup.okhttp.Dispatcher
 
getReadTimeout() - Method in class com.squareup.okhttp.OkHttpClient
Default read timeout (in milliseconds).
getRealm() - Method in class com.squareup.okhttp.Challenge
Returns the protection space.
getRequest() - Method in class com.squareup.okhttp.internal.http.HttpEngine
 
getRequestBody() - Method in class com.squareup.okhttp.internal.http.HttpEngine
Returns the request body or null if this request doesn't have a body.
getRequestCount() - Method in class com.squareup.okhttp.Cache
 
getRequestHeaders() - Method in class com.squareup.okhttp.internal.framed.FramedStream
 
getResponse() - Method in class com.squareup.okhttp.internal.http.HttpEngine
Returns the engine's response.
getResponseHeaders() - Method in class com.squareup.okhttp.internal.framed.FramedStream
Returns the stream's response headers, blocking if necessary if they have not been received yet.
getRetryOnConnectionFailure() - Method in class com.squareup.okhttp.OkHttpClient
 
getRoute() - Method in interface com.squareup.okhttp.Connection
Returns the route used by this connection.
getRoute() - Method in class com.squareup.okhttp.internal.io.RealConnection
 
getRunningCallCount() - Method in class com.squareup.okhttp.Dispatcher
 
getScheme() - Method in class com.squareup.okhttp.Challenge
Returns the authentication scheme, like Basic.
getSelectedProtocol(SSLSocket) - Method in class com.squareup.okhttp.internal.Platform
Returns the negotiated protocol, or null if no protocol was negotiated.
getSink() - Method in class com.squareup.okhttp.internal.framed.FramedStream
Returns a sink that can be used to write data to the peer.
getSize() - Method in class com.squareup.okhttp.Cache
 
getSocket() - Method in interface com.squareup.okhttp.Connection
Returns the socket that this connection uses, or null if the connection is not currently connected.
getSocket() - Method in class com.squareup.okhttp.internal.io.RealConnection
 
getSocketAddress() - Method in class com.squareup.okhttp.Route
 
getSocketFactory() - Method in class com.squareup.okhttp.Address
Returns the socket factory for new connections.
getSocketFactory() - Method in class com.squareup.okhttp.OkHttpClient
 
getSource(int) - Method in class com.squareup.okhttp.internal.DiskLruCache.Snapshot
Returns the unbuffered stream with the value for index.
getSource() - Method in class com.squareup.okhttp.internal.framed.FramedStream
Returns a source that reads data from the peer.
getSpdyConnectionCount() - Method in class com.squareup.okhttp.ConnectionPool
getSslSocketFactory() - Method in class com.squareup.okhttp.Address
Returns the SSL socket factory, or null if this is not an HTTPS address.
getSslSocketFactory() - Method in class com.squareup.okhttp.OkHttpClient
 
getUriHost() - Method in class com.squareup.okhttp.Address
Deprecated.
prefer address.url().host().
getUriPort() - Method in class com.squareup.okhttp.Address
Deprecated.
prefer address.url().port().
getWriteAbortCount() - Method in class com.squareup.okhttp.Cache
 
getWriteSuccessCount() - Method in class com.squareup.okhttp.Cache
 
getWriteTimeout() - Method in class com.squareup.okhttp.OkHttpClient
Default write timeout (in milliseconds).
goAway(int, ErrorCode, ByteString) - Method in interface com.squareup.okhttp.internal.framed.FrameReader.Handler
The peer tells us to stop creating streams.
goAway(int, ErrorCode, byte[]) - Method in interface com.squareup.okhttp.internal.framed.FrameWriter
Tell the peer to stop creating streams and that we last processed lastGoodStreamId, or zero if no streams were processed.
GOOGLE_API_KEY - Static variable in class com.squareup.okhttp.recipes.RequestBodyCompression
The Google API KEY for OkHttp recipes.

H

Handshake - Class in com.squareup.okhttp
A record of a TLS handshake.
handshake(Handshake) - Method in class com.squareup.okhttp.Response.Builder
 
handshake() - Method in class com.squareup.okhttp.Response
Returns the TLS handshake of the connection that carried this response, or null if the response was received without TLS.
hasBody(Response) - Static method in class com.squareup.okhttp.internal.http.HttpEngine
Returns true if the response must have a (possibly 0-length) body.
hashCode() - Method in class com.squareup.okhttp.Address
 
hashCode() - Method in class com.squareup.okhttp.Challenge
 
hashCode() - Method in class com.squareup.okhttp.ConnectionSpec
 
hashCode() - Method in class com.squareup.okhttp.Handshake
 
hashCode() - Method in class com.squareup.okhttp.HttpUrl
 
hashCode() - Method in class com.squareup.okhttp.internal.framed.Header
 
hashCode() - Method in class com.squareup.okhttp.MediaType
 
hashCode() - Method in class com.squareup.okhttp.Route
 
hasNext() - Method in class com.squareup.okhttp.internal.http.RouteSelector
Returns true if there's another route to attempt.
hasResponse() - Method in class com.squareup.okhttp.internal.http.HttpEngine
 
hasVaryAll(Response) - Static method in class com.squareup.okhttp.internal.http.OkHeaders
Returns true if a Vary header contains an asterisk.
hasVaryAll(Headers) - Static method in class com.squareup.okhttp.internal.http.OkHeaders
Returns true if a Vary header contains an asterisk.
head() - Method in class com.squareup.okhttp.Request.Builder
 
Header - Class in com.squareup.okhttp.internal.framed
HTTP header: the name is an ASCII string, but the value can be UTF-8.
Header(String, String) - Constructor for class com.squareup.okhttp.internal.framed.Header
 
Header(ByteString, String) - Constructor for class com.squareup.okhttp.internal.framed.Header
 
Header(ByteString, ByteString) - Constructor for class com.squareup.okhttp.internal.framed.Header
 
header(String, String) - Method in class com.squareup.okhttp.Request.Builder
Sets the header named name to value.
header(String) - Method in class com.squareup.okhttp.Request
 
header(String, String) - Method in class com.squareup.okhttp.Response.Builder
Sets the header named name to value.
header(String) - Method in class com.squareup.okhttp.Response
 
header(String, String) - Method in class com.squareup.okhttp.Response
 
HeaderParser - Class in com.squareup.okhttp.internal.http
 
Headers - Class in com.squareup.okhttp
The header fields of a single HTTP message.
headers(boolean, boolean, int, int, List<Header>, HeadersMode) - Method in interface com.squareup.okhttp.internal.framed.FrameReader.Handler
Create or update incoming headers, creating the corresponding streams if necessary.
headers(int, List<Header>) - Method in interface com.squareup.okhttp.internal.framed.FrameWriter
 
headers(Headers) - Method in class com.squareup.okhttp.Request.Builder
Removes all headers on this builder and adds headers.
headers() - Method in class com.squareup.okhttp.Request
 
headers(String) - Method in class com.squareup.okhttp.Request
 
headers(Headers) - Method in class com.squareup.okhttp.Response.Builder
Removes all headers on this builder and adds headers.
headers(String) - Method in class com.squareup.okhttp.Response
 
headers() - Method in class com.squareup.okhttp.Response
 
Headers.Builder - Class in com.squareup.okhttp
 
HeadersMode - Enum in com.squareup.okhttp.internal.framed
 
host(String) - Method in class com.squareup.okhttp.HttpUrl.Builder
 
host() - Method in class com.squareup.okhttp.HttpUrl
Returns the host address suitable for use with InetAddress.getAllByName(String).
hostHeader(HttpUrl) - Static method in class com.squareup.okhttp.internal.Util
 
Http1xStream - Class in com.squareup.okhttp.internal.http
A socket connection that can be used to send HTTP/1.1 messages.
Http1xStream(StreamAllocation, BufferedSource, BufferedSink) - Constructor for class com.squareup.okhttp.internal.http.Http1xStream
 
Http2 - Class in com.squareup.okhttp.internal.framed
Read and write HTTP/2 frames.
Http2() - Constructor for class com.squareup.okhttp.internal.framed.Http2
 
http2HeadersList(Request) - Static method in class com.squareup.okhttp.internal.http.Http2xStream
 
Http2xStream - Class in com.squareup.okhttp.internal.http
An HTTP stream for HTTP/2 and SPDY.
Http2xStream(StreamAllocation, FramedConnection) - Constructor for class com.squareup.okhttp.internal.http.Http2xStream
 
HTTP_CONTINUE - Static variable in class com.squareup.okhttp.internal.http.StatusLine
 
HTTP_PERM_REDIRECT - Static variable in class com.squareup.okhttp.internal.http.StatusLine
 
HTTP_TEMP_REDIRECT - Static variable in class com.squareup.okhttp.internal.http.StatusLine
Numeric status code, 307: Temporary Redirect.
httpCode - Variable in enum com.squareup.okhttp.internal.framed.ErrorCode
 
HttpDate - Class in com.squareup.okhttp.internal.http
Best-effort parser for HTTP dates.
HttpEngine - Class in com.squareup.okhttp.internal.http
Handles a single HTTP request/response pair.
HttpEngine(OkHttpClient, Request, boolean, boolean, boolean, StreamAllocation, RetryableSink, Response) - Constructor for class com.squareup.okhttp.internal.http.HttpEngine
 
HttpLoggingInterceptor - Class in com.squareup.okhttp.logging
An OkHttp interceptor which logs request and response information.
HttpLoggingInterceptor() - Constructor for class com.squareup.okhttp.logging.HttpLoggingInterceptor
 
HttpLoggingInterceptor(HttpLoggingInterceptor.Logger) - Constructor for class com.squareup.okhttp.logging.HttpLoggingInterceptor
 
HttpLoggingInterceptor.Level - Enum in com.squareup.okhttp.logging
 
HttpLoggingInterceptor.Logger - Interface in com.squareup.okhttp.logging
 
HttpMethod - Class in com.squareup.okhttp.internal.http
 
HttpStream - Interface in com.squareup.okhttp.internal.http
 
HttpUrl - Class in com.squareup.okhttp
A uniform resource locator (URL) with a scheme of either http or https.
httpUrl() - Method in class com.squareup.okhttp.Request
 
HttpUrl.Builder - Class in com.squareup.okhttp
 

I

idleAtNanos - Variable in class com.squareup.okhttp.internal.io.RealConnection
 
immutableList(List<T>) - Static method in class com.squareup.okhttp.internal.Util
Returns an immutable copy of list.
immutableList(T...) - Static method in class com.squareup.okhttp.internal.Util
Returns an immutable list containing elements.
immutableMap(Map<K, V>) - Static method in class com.squareup.okhttp.internal.Util
Returns an immutable copy of map.
initialize() - Method in class com.squareup.okhttp.Cache
Initialize the cache.
initialize() - Method in class com.squareup.okhttp.internal.DiskLruCache
 
initializeInstanceForTests() - Static method in class com.squareup.okhttp.internal.Internal
 
InMemoryFileSystem - Class in com.squareup.okhttp.internal.io
A simple file system where all files are held in memory.
InMemoryFileSystem() - Constructor for class com.squareup.okhttp.internal.io.InMemoryFileSystem
 
InstallUncaughtExceptionHandlerListener - Class in com.squareup.okhttp.testing
A RunListener used to install an aggressive default Thread.UncaughtExceptionHandler similar to the one found on Android.
InstallUncaughtExceptionHandlerListener() - Constructor for class com.squareup.okhttp.testing.InstallUncaughtExceptionHandlerListener
 
INSTANCE - Static variable in class com.squareup.okhttp.internal.http.AuthenticatorAdapter
Uses the global authenticator to get the password.
instance - Static variable in class com.squareup.okhttp.internal.Internal
 
INSTANCE - Static variable in class com.squareup.okhttp.internal.tls.OkHostnameVerifier
 
intercept(Interceptor.Chain) - Method in interface com.squareup.okhttp.Interceptor
 
intercept(Interceptor.Chain) - Method in class com.squareup.okhttp.logging.HttpLoggingInterceptor
 
Interceptor - Interface in com.squareup.okhttp
Observes, modifies, and potentially short-circuits requests going out and the corresponding requests coming back in.
Interceptor.Chain - Interface in com.squareup.okhttp
 
interceptors() - Method in class com.squareup.okhttp.OkHttpClient
Returns a modifiable list of interceptors that observe the full span of each call: from before the connection is established (if any) until after the response source is selected (either the origin server, cache, or both).
Internal - Class in com.squareup.okhttp.internal
Escalate internal APIs in com.squareup.okhttp so they can be used from OkHttp's implementation packages.
Internal() - Constructor for class com.squareup.okhttp.internal.Internal
 
internalCache(OkHttpClient) - Method in class com.squareup.okhttp.internal.Internal
 
InternalCache - Interface in com.squareup.okhttp.internal
OkHttp's internal cache interface.
intersect(Class<T>, T[], T[]) - Static method in class com.squareup.okhttp.internal.Util
Returns an array containing containing only elements found in first and also in second.
invalidatesCache(String) - Static method in class com.squareup.okhttp.internal.http.HttpMethod
 
isAndroidGetsocknameError(AssertionError) - Static method in class com.squareup.okhttp.internal.Util
Returns true if e is due to a firmware bug fixed after Android 4.2.2.
isCacheable(Response, Request) - Static method in class com.squareup.okhttp.internal.http.CacheStrategy
Returns true if response can be stored to later serve another request.
isCanceled() - Method in class com.squareup.okhttp.Call
 
isClosed() - Method in class com.squareup.okhttp.Cache
 
isClosed() - Method in class com.squareup.okhttp.internal.DiskLruCache
Returns true if this cache has been closed.
isClosed() - Method in class com.squareup.okhttp.internal.http.Http1xStream
Returns true if this connection is closed.
isCompatible(SSLSocket) - Method in class com.squareup.okhttp.ConnectionSpec
Returns true if the socket, as currently configured, supports this connection spec.
isExecuted() - Method in class com.squareup.okhttp.Call
Returns true if this call has been either executed or enqueued.
isHealthy(boolean) - Method in class com.squareup.okhttp.internal.io.RealConnection
Returns true if this connection is ready to host new streams.
isHttps() - Method in class com.squareup.okhttp.HttpUrl
 
isHttps() - Method in class com.squareup.okhttp.Request
 
isIdle() - Method in class com.squareup.okhttp.internal.framed.FramedConnection
Returns true if this connection is idle.
isLocallyInitiated() - Method in class com.squareup.okhttp.internal.framed.FramedStream
Returns true if this stream was created by this peer.
isMultiplexed() - Method in class com.squareup.okhttp.internal.io.RealConnection
Returns true if this is a SPDY connection.
isOpen() - Method in class com.squareup.okhttp.internal.framed.FramedStream
Returns true if this stream is open.
isPrivate() - Method in class com.squareup.okhttp.CacheControl
 
isPublic() - Method in class com.squareup.okhttp.CacheControl
 
isRedirect() - Method in class com.squareup.okhttp.Response
Returns true if this response redirects to another resource.
isSuccessful() - Method in class com.squareup.okhttp.Response
Returns true if the code is in [200..300), which means the request was successfully received, understood, and accepted.
isTls() - Method in class com.squareup.okhttp.ConnectionSpec
 

J

javaName() - Method in enum com.squareup.okhttp.TlsVersion
 
JSON - Static variable in class com.squareup.okhttp.guide.PostExample
 

K

key() - Method in class com.squareup.okhttp.internal.DiskLruCache.Snapshot
 

L

listener(FramedConnection.Listener) - Method in class com.squareup.okhttp.internal.framed.FramedConnection.Builder
 
Listener() - Constructor for class com.squareup.okhttp.internal.framed.FramedConnection.Listener
 
localCertificates() - Method in class com.squareup.okhttp.Handshake
Returns a possibly-empty list of certificates that identify this peer.
localPrincipal() - Method in class com.squareup.okhttp.Handshake
Returns the local principle, or null if this peer is anonymous.
log(String) - Method in class com.squareup.okhttp.internal.Platform
 
log(String) - Method in interface com.squareup.okhttp.logging.HttpLoggingInterceptor.Logger
 
logger - Static variable in class com.squareup.okhttp.internal.Internal
 
LoggingInterceptors - Class in com.squareup.okhttp.recipes
 
LoggingInterceptors() - Constructor for class com.squareup.okhttp.recipes.LoggingInterceptors
 
logW(String) - Method in class com.squareup.okhttp.internal.Platform
 
lookup(String) - Method in interface com.squareup.okhttp.Dns
Returns the IP addresses of hostname, in the order they will be attempted by OkHttp.

M

main(String[]) - Static method in class com.squareup.okhttp.guide.GetExample
 
main(String[]) - Static method in class com.squareup.okhttp.guide.PostExample
 
main(String...) - Static method in class com.squareup.okhttp.recipes.AccessHeaders
 
main(String...) - Static method in class com.squareup.okhttp.recipes.AsynchronousGet
 
main(String...) - Static method in class com.squareup.okhttp.recipes.Authenticate
 
main(String...) - Static method in class com.squareup.okhttp.recipes.CacheResponse
 
main(String...) - Static method in class com.squareup.okhttp.recipes.CancelCall
 
main(String...) - Static method in class com.squareup.okhttp.recipes.CertificatePinning
 
main(String...) - Static method in class com.squareup.okhttp.recipes.CheckHandshake
 
main(String...) - Static method in class com.squareup.okhttp.recipes.ConfigureTimeouts
 
main(String...) - Static method in class com.squareup.okhttp.recipes.CustomTrust
 
main(String...) - Static method in class com.squareup.okhttp.recipes.LoggingInterceptors
 
main(String...) - Static method in class com.squareup.okhttp.recipes.ParseResponseWithGson
 
main(String...) - Static method in class com.squareup.okhttp.recipes.PerCallSettings
 
main(String...) - Static method in class com.squareup.okhttp.recipes.PostFile
 
main(String...) - Static method in class com.squareup.okhttp.recipes.PostForm
 
main(String...) - Static method in class com.squareup.okhttp.recipes.PostMultipart
 
main(String...) - Static method in class com.squareup.okhttp.recipes.PostStreaming
 
main(String...) - Static method in class com.squareup.okhttp.recipes.PostString
 
main(String...) - Static method in class com.squareup.okhttp.recipes.Progress
 
main(String...) - Static method in class com.squareup.okhttp.recipes.RequestBodyCompression
 
main(String...) - Static method in class com.squareup.okhttp.recipes.RewriteResponseCacheControl
 
main(String...) - Static method in class com.squareup.okhttp.recipes.SynchronousGet
 
main(String...) - Static method in class com.squareup.okhttp.recipes.WebSocketEcho
 
main(String...) - Static method in class com.squareup.okhttp.sample.OkHttpContributors
 
main(String...) - Static method in class com.squareup.okhttp.ws.AutobahnTester
 
MAX_FOLLOW_UPS - Static variable in class com.squareup.okhttp.internal.http.HttpEngine
How many redirects and auth challenges should we attempt? Chrome follows 21 redirects; Firefox, curl, and wget follow 20; Safari follows 16; and HTTP/1.0 recommends 5.
maxAge(int, TimeUnit) - Method in class com.squareup.okhttp.CacheControl.Builder
Sets the maximum age of a cached response.
maxAgeSeconds() - Method in class com.squareup.okhttp.CacheControl
The duration past the response's served date that it can be served without validation.
maxConcurrentStreams() - Method in class com.squareup.okhttp.internal.framed.FramedConnection
 
maxDataLength() - Method in interface com.squareup.okhttp.internal.framed.FrameWriter
The maximum size of bytes that may be sent in a single call to FrameWriter.data(boolean, int, okio.Buffer, int).
maxStale(int, TimeUnit) - Method in class com.squareup.okhttp.CacheControl.Builder
Accept cached responses that have exceeded their freshness lifetime by up to maxStale.
maxStaleSeconds() - Method in class com.squareup.okhttp.CacheControl
 
md5Hex(String) - Static method in class com.squareup.okhttp.internal.Util
Returns a 32 character string containing an MD5 hash of s.
MEDIA_TYPE_JSON - Static variable in class com.squareup.okhttp.recipes.RequestBodyCompression
 
MEDIA_TYPE_MARKDOWN - Static variable in class com.squareup.okhttp.recipes.PostFile
 
MEDIA_TYPE_MARKDOWN - Static variable in class com.squareup.okhttp.recipes.PostStreaming
 
MEDIA_TYPE_MARKDOWN - Static variable in class com.squareup.okhttp.recipes.PostString
 
MediaType - Class in com.squareup.okhttp
An RFC 2045 Media Type, appropriate to describe the content type of an HTTP request or response body.
message - Variable in class com.squareup.okhttp.internal.http.StatusLine
 
message(String) - Method in class com.squareup.okhttp.Response.Builder
 
message() - Method in class com.squareup.okhttp.Response
Returns the HTTP status message or null if it is unknown.
method(String, RequestBody) - Method in class com.squareup.okhttp.Request.Builder
 
method() - Method in class com.squareup.okhttp.Request
 
minFresh(int, TimeUnit) - Method in class com.squareup.okhttp.CacheControl.Builder
Sets the minimum number of seconds that a response will continue to be fresh for.
minFreshSeconds() - Method in class com.squareup.okhttp.CacheControl
 
MIXED - Static variable in class com.squareup.okhttp.MultipartBuilder
The "mixed" subtype of "multipart" is intended for use when the body parts are independent and need to be bundled in a particular order.
MODERN_TLS - Static variable in class com.squareup.okhttp.ConnectionSpec
A modern TLS connection with extensions like SNI and ALPN available.
MultipartBuilder - Class in com.squareup.okhttp
Fluent API to build RFC 2387-compliant request bodies.
MultipartBuilder() - Constructor for class com.squareup.okhttp.MultipartBuilder
Creates a new multipart builder that uses a random boundary token.
MultipartBuilder(String) - Constructor for class com.squareup.okhttp.MultipartBuilder
Creates a new multipart builder that uses boundary to separate parts.
mustRevalidate() - Method in class com.squareup.okhttp.CacheControl
 

N

name(int) - Method in class com.squareup.okhttp.Headers
Returns the field at position or null if that is out of range.
name - Variable in class com.squareup.okhttp.internal.framed.Header
Name in case-insensitive ASCII encoding.
name - Variable in class com.squareup.okhttp.internal.NamedRunnable
 
NamedRunnable - Class in com.squareup.okhttp.internal
Runnable implementation which always sets its thread name.
NamedRunnable(String, Object...) - Constructor for class com.squareup.okhttp.internal.NamedRunnable
 
names() - Method in class com.squareup.okhttp.Headers
Returns an immutable case-insensitive set of header names.
networkInterceptors() - Method in class com.squareup.okhttp.OkHttpClient
Returns a modifiable list of interceptors that observe a single network request and response.
networkRequest - Variable in class com.squareup.okhttp.internal.http.CacheStrategy
The request to send on the network, or null if this call doesn't use the network.
networkResponse(Response) - Method in class com.squareup.okhttp.Response.Builder
 
networkResponse() - Method in class com.squareup.okhttp.Response
Returns the raw response received from the network.
newBuilder() - Method in class com.squareup.okhttp.Headers
 
newBuilder() - Method in class com.squareup.okhttp.HttpUrl
 
newBuilder() - Method in class com.squareup.okhttp.Request
 
newBuilder() - Method in class com.squareup.okhttp.Response
 
newCall(Request) - Method in class com.squareup.okhttp.OkHttpClient
Prepares the request to be executed at some point in the future.
newChunkedSink() - Method in class com.squareup.okhttp.internal.http.Http1xStream
 
newChunkedSource(HttpEngine) - Method in class com.squareup.okhttp.internal.http.Http1xStream
 
newFixedLengthSink(long) - Method in class com.squareup.okhttp.internal.http.Http1xStream
 
newFixedLengthSource(long) - Method in class com.squareup.okhttp.internal.http.Http1xStream
 
newMessageSink(int) - Method in class com.squareup.okhttp.internal.ws.WebSocketWriter
Stream a message payload as a series of frames.
newReader(BufferedSource, boolean) - Method in class com.squareup.okhttp.internal.framed.Http2
Creates a frame reader with max header table size of 4096 and data frame compression disabled.
newReader(BufferedSource, boolean) - Method in class com.squareup.okhttp.internal.framed.Spdy3
 
newReader(BufferedSource, boolean) - Method in interface com.squareup.okhttp.internal.framed.Variant
 
newSink(int) - Method in class com.squareup.okhttp.internal.DiskLruCache.Editor
Returns a new unbuffered output stream to write the value at index.
newSource(int) - Method in class com.squareup.okhttp.internal.DiskLruCache.Editor
Returns an unbuffered input stream to read the last committed value, or null if no value has been committed.
newStream(List<Header>, boolean, boolean) - Method in class com.squareup.okhttp.internal.framed.FramedConnection
Returns a new locally-initiated stream.
newStream(int, int, int, boolean, boolean) - Method in class com.squareup.okhttp.internal.http.StreamAllocation
 
newUnknownLengthSource() - Method in class com.squareup.okhttp.internal.http.Http1xStream
 
newWriter(BufferedSink, boolean) - Method in class com.squareup.okhttp.internal.framed.Http2
 
newWriter(BufferedSink, boolean) - Method in class com.squareup.okhttp.internal.framed.Spdy3
 
newWriter(BufferedSink, boolean) - Method in interface com.squareup.okhttp.internal.framed.Variant
 
next() - Method in class com.squareup.okhttp.internal.http.RouteSelector
 
nextFrame(FrameReader.Handler) - Method in interface com.squareup.okhttp.internal.framed.FrameReader
 
noCache() - Method in class com.squareup.okhttp.CacheControl.Builder
Don't accept an unvalidated cached response.
noCache() - Method in class com.squareup.okhttp.CacheControl
In a response, this field's name "no-cache" is misleading.
noNewStreams() - Method in class com.squareup.okhttp.internal.http.StreamAllocation
Forbid new streams from being created on the connection that hosts this allocation.
noNewStreams - Variable in class com.squareup.okhttp.internal.io.RealConnection
 
noStore() - Method in class com.squareup.okhttp.CacheControl.Builder
Don't store the server's response in any cache.
noStore() - Method in class com.squareup.okhttp.CacheControl
If true, this response should not be cached.
noTransform() - Method in class com.squareup.okhttp.CacheControl.Builder
Don't accept a transformed response.
noTransform() - Method in class com.squareup.okhttp.CacheControl
 

O

of(String...) - Static method in class com.squareup.okhttp.Headers
Returns headers for the alternating header names and values.
of(Map<String, String>) - Static method in class com.squareup.okhttp.Headers
Returns headers for the header names and values in the Map.
OkApacheClient - Class in com.squareup.okhttp.apache
Implements Apache's HttpClient API using OkHttpClient.
OkApacheClient() - Constructor for class com.squareup.okhttp.apache.OkApacheClient
 
OkApacheClient(OkHttpClient) - Constructor for class com.squareup.okhttp.apache.OkApacheClient
 
OkHeaders - Class in com.squareup.okhttp.internal.http
Headers and utilities for internal use by OkHttp.
OkHostnameVerifier - Class in com.squareup.okhttp.internal.tls
A HostnameVerifier consistent with RFC 2818.
OkHttpClient - Class in com.squareup.okhttp
Configures and creates HTTP connections.
OkHttpClient() - Constructor for class com.squareup.okhttp.OkHttpClient
 
OkHttpContributors - Class in com.squareup.okhttp.sample
 
onClose(int, String) - Method in interface com.squareup.okhttp.internal.ws.WebSocketReader.FrameCallback
 
onClose(int, String) - Method in class com.squareup.okhttp.recipes.WebSocketEcho
 
onClose(int, String) - Method in interface com.squareup.okhttp.ws.WebSocketListener
Called when the server sends a close message.
onData(int, BufferedSource, int, boolean) - Method in interface com.squareup.okhttp.internal.framed.PushObserver
A chunk of response data corresponding to a pushed request.
onFailure(Request, IOException) - Method in interface com.squareup.okhttp.Callback
Called when the request could not be executed due to cancellation, a connectivity problem or timeout.
onFailure(IOException, Response) - Method in class com.squareup.okhttp.recipes.WebSocketEcho
 
onFailure(IOException, Response) - Method in interface com.squareup.okhttp.ws.WebSocketListener
Called when the transport or protocol layer of this web socket errors during communication.
onHeaders(int, List<Header>, boolean) - Method in interface com.squareup.okhttp.internal.framed.PushObserver
The response headers corresponding to a pushed request.
onlyIfCached() - Method in class com.squareup.okhttp.CacheControl.Builder
Only accept the response if it is in the cache.
onlyIfCached() - Method in class com.squareup.okhttp.CacheControl
This field's name "only-if-cached" is misleading.
onMessage(ResponseBody) - Method in interface com.squareup.okhttp.internal.ws.WebSocketReader.FrameCallback
 
onMessage(ResponseBody) - Method in class com.squareup.okhttp.recipes.WebSocketEcho
 
onMessage(ResponseBody) - Method in interface com.squareup.okhttp.ws.WebSocketListener
Called when a server message is received.
onOpen(WebSocket, Response) - Method in class com.squareup.okhttp.recipes.WebSocketEcho
 
onOpen(WebSocket, Response) - Method in interface com.squareup.okhttp.ws.WebSocketListener
Called when the request has successfully been upgraded to a web socket.
onPing(Buffer) - Method in interface com.squareup.okhttp.internal.ws.WebSocketReader.FrameCallback
 
onPong(Buffer) - Method in interface com.squareup.okhttp.internal.ws.WebSocketReader.FrameCallback
 
onPong(Buffer) - Method in class com.squareup.okhttp.recipes.WebSocketEcho
 
onPong(Buffer) - Method in interface com.squareup.okhttp.ws.WebSocketListener
Called when a server pong is received.
onRequest(int, List<Header>) - Method in interface com.squareup.okhttp.internal.framed.PushObserver
Describes the request that the server intends to push a response for.
onReset(int, ErrorCode) - Method in interface com.squareup.okhttp.internal.framed.PushObserver
Indicates the reason why this stream was canceled.
onResponse(Response) - Method in interface com.squareup.okhttp.Callback
Called when the HTTP response was successfully returned by the remote server.
onSettings(FramedConnection) - Method in class com.squareup.okhttp.internal.framed.FramedConnection.Listener
Notification that the connection's peer's settings may have changed.
onStream(FramedStream) - Method in class com.squareup.okhttp.internal.framed.FramedConnection.Listener
Handle a new stream from this connection's peer.
openResponseBody(Response) - Method in class com.squareup.okhttp.internal.http.Http1xStream
 
openResponseBody(Response) - Method in class com.squareup.okhttp.internal.http.Http2xStream
 
openResponseBody(Response) - Method in interface com.squareup.okhttp.internal.http.HttpStream
Returns a stream that reads the response body.
openStreamCount() - Method in class com.squareup.okhttp.internal.framed.FramedConnection
Returns the number of open streams on this connection.

P

PARALLEL - Static variable in class com.squareup.okhttp.MultipartBuilder
This type is syntactically identical to "multipart/mixed", but the semantics are different.
parse(Headers) - Static method in class com.squareup.okhttp.CacheControl
Returns the cache directives of headers.
parse(String) - Static method in class com.squareup.okhttp.HttpUrl
Returns a new HttpUrl representing url if it is a well-formed HTTP or HTTPS URL, or null if it isn't.
parse(String) - Static method in class com.squareup.okhttp.internal.http.HttpDate
Returns the date for value.
parse(String) - Static method in class com.squareup.okhttp.internal.http.StatusLine
 
parse(String) - Static method in class com.squareup.okhttp.MediaType
Returns a media type for string, or null if string is not a well-formed media type.
parseChallenges(Headers, String) - Static method in class com.squareup.okhttp.internal.http.OkHeaders
Parse RFC 2617 challenges.
ParseResponseWithGson - Class in com.squareup.okhttp.recipes
 
ParseResponseWithGson() - Constructor for class com.squareup.okhttp.recipes.ParseResponseWithGson
 
parseSeconds(String, int) - Static method in class com.squareup.okhttp.internal.http.HeaderParser
Returns value as a positive integer, or 0 if it is negative, or defaultValue if it cannot be parsed.
password(String) - Method in class com.squareup.okhttp.HttpUrl.Builder
 
password() - Method in class com.squareup.okhttp.HttpUrl
Returns the decoded password, or an empty string if none is present.
patch(RequestBody) - Method in class com.squareup.okhttp.Request.Builder
 
pathSegments() - Method in class com.squareup.okhttp.HttpUrl
 
pathSize() - Method in class com.squareup.okhttp.HttpUrl
 
peerCertificates() - Method in class com.squareup.okhttp.Handshake
Returns a possibly-empty list of certificates that identify the remote peer.
peerPrincipal() - Method in class com.squareup.okhttp.Handshake
Returns the remote peer's principle, or null if that peer is anonymous.
PerCallSettings - Class in com.squareup.okhttp.recipes
 
PerCallSettings() - Constructor for class com.squareup.okhttp.recipes.PerCallSettings
 
permitsRequestBody(String) - Static method in class com.squareup.okhttp.internal.http.HttpMethod
 
pin(Certificate) - Static method in class com.squareup.okhttp.CertificatePinner
Returns the SHA-1 of certificate's public key.
ping() - Method in class com.squareup.okhttp.internal.framed.FramedConnection
Sends a ping frame to the peer.
ping(boolean, int, int) - Method in interface com.squareup.okhttp.internal.framed.FrameReader.Handler
Read a connection-level ping from the peer.
ping(boolean, int, int) - Method in interface com.squareup.okhttp.internal.framed.FrameWriter
Send a connection-level ping to the peer.
Ping - Class in com.squareup.okhttp.internal.framed
A locally-originated ping.
Platform - Class in com.squareup.okhttp.internal
Access to platform-specific features.
Platform() - Constructor for class com.squareup.okhttp.internal.Platform
 
port(int) - Method in class com.squareup.okhttp.HttpUrl.Builder
 
port() - Method in class com.squareup.okhttp.HttpUrl
Returns the explicitly-specified port if one was provided, or the default port for this URL's scheme.
post(RequestBody) - Method in class com.squareup.okhttp.Request.Builder
 
PostExample - Class in com.squareup.okhttp.guide
 
PostExample() - Constructor for class com.squareup.okhttp.guide.PostExample
 
PostFile - Class in com.squareup.okhttp.recipes
 
PostFile() - Constructor for class com.squareup.okhttp.recipes.PostFile
 
PostForm - Class in com.squareup.okhttp.recipes
 
PostForm() - Constructor for class com.squareup.okhttp.recipes.PostForm
 
PostMultipart - Class in com.squareup.okhttp.recipes
 
PostMultipart() - Constructor for class com.squareup.okhttp.recipes.PostMultipart
 
PostStreaming - Class in com.squareup.okhttp.recipes
 
PostStreaming() - Constructor for class com.squareup.okhttp.recipes.PostStreaming
 
PostString - Class in com.squareup.okhttp.recipes
 
PostString() - Constructor for class com.squareup.okhttp.recipes.PostString
 
priority(int, int, int, boolean) - Method in interface com.squareup.okhttp.internal.framed.FrameReader.Handler
Called when reading a headers or priority frame.
priorResponse(Response) - Method in class com.squareup.okhttp.Response.Builder
 
priorResponse() - Method in class com.squareup.okhttp.Response
Returns the response for the HTTP redirect or authorization challenge that triggered this response, or null if this response wasn't triggered by an automatic retry.
proceed(Request) - Method in interface com.squareup.okhttp.Interceptor.Chain
 
processAuthHeader(Authenticator, Response, Proxy) - Static method in class com.squareup.okhttp.internal.http.OkHeaders
React to a failed authorization response by looking up new credentials.
processNextFrame() - Method in class com.squareup.okhttp.internal.ws.WebSocketReader
Process the next protocol frame.
Progress - Class in com.squareup.okhttp.recipes
 
Progress() - Constructor for class com.squareup.okhttp.recipes.Progress
 
protocol(Protocol) - Method in class com.squareup.okhttp.internal.framed.FramedConnection.Builder
 
protocol - Variable in class com.squareup.okhttp.internal.http.StatusLine
 
Protocol - Enum in com.squareup.okhttp
Protocols that OkHttp implements for ALPN selection.
protocol(Protocol) - Method in class com.squareup.okhttp.Response.Builder
 
protocol() - Method in class com.squareup.okhttp.Response
Returns the HTTP protocol, such as Protocol.HTTP_1_1 or Protocol.HTTP_1_0.
pushObserver(PushObserver) - Method in class com.squareup.okhttp.internal.framed.FramedConnection.Builder
 
PushObserver - Interface in com.squareup.okhttp.internal.framed
HTTP/2 only.
pushPromise(int, int, List<Header>) - Method in interface com.squareup.okhttp.internal.framed.FrameReader.Handler
HTTP/2 only.
pushPromise(int, int, List<Header>) - Method in interface com.squareup.okhttp.internal.framed.FrameWriter
HTTP/2 only.
pushStream(int, List<Header>, boolean) - Method in class com.squareup.okhttp.internal.framed.FramedConnection
Returns a new server-initiated stream.
put(ConnectionPool, RealConnection) - Method in class com.squareup.okhttp.internal.Internal
 
put(Response) - Method in interface com.squareup.okhttp.internal.InternalCache
 
put(RequestBody) - Method in class com.squareup.okhttp.Request.Builder
 

Q

query(String) - Method in class com.squareup.okhttp.HttpUrl.Builder
 
query() - Method in class com.squareup.okhttp.HttpUrl
 
queryParameter(String) - Method in class com.squareup.okhttp.HttpUrl
Returns the first query parameter named name decoded using UTF-8, or null if there is no such query parameter.
queryParameterName(int) - Method in class com.squareup.okhttp.HttpUrl
 
queryParameterNames() - Method in class com.squareup.okhttp.HttpUrl
 
queryParameterValue(int) - Method in class com.squareup.okhttp.HttpUrl
 
queryParameterValues(String) - Method in class com.squareup.okhttp.HttpUrl
 
querySize() - Method in class com.squareup.okhttp.HttpUrl
 

R

readConnectionPreface() - Method in interface com.squareup.okhttp.internal.framed.FrameReader
 
readHeaders() - Method in class com.squareup.okhttp.internal.http.Http1xStream
Reads headers or trailers.
readHttp2HeadersList(List<Header>) - Static method in class com.squareup.okhttp.internal.http.Http2xStream
Returns headers for a name value block containing an HTTP/2 response.
readMessage() - Method in class com.squareup.okhttp.internal.ws.RealWebSocket
Read a single message from the web socket and deliver it to the listener.
readResponse() - Method in class com.squareup.okhttp.internal.http.Http1xStream
Parses bytes of a response header from an HTTP transport.
readResponse() - Method in class com.squareup.okhttp.internal.http.HttpEngine
Flushes the remaining request header and body, parses the HTTP response headers and starts reading the HTTP response body if it exists.
readResponseHeaders() - Method in class com.squareup.okhttp.internal.http.Http1xStream
 
readResponseHeaders() - Method in class com.squareup.okhttp.internal.http.Http2xStream
 
readResponseHeaders() - Method in interface com.squareup.okhttp.internal.http.HttpStream
Read and return response headers.
readSpdy3HeadersList(List<Header>) - Static method in class com.squareup.okhttp.internal.http.Http2xStream
Returns headers for a name value block containing a SPDY response.
readTimeout() - Method in class com.squareup.okhttp.internal.framed.FramedStream
 
RealConnection - Class in com.squareup.okhttp.internal.io
 
RealConnection(Route) - Constructor for class com.squareup.okhttp.internal.io.RealConnection
 
RealResponseBody - Class in com.squareup.okhttp.internal.http
 
RealResponseBody(Headers, BufferedSource) - Constructor for class com.squareup.okhttp.internal.http.RealResponseBody
 
RealTrustRootIndex - Class in com.squareup.okhttp.internal.tls
 
RealTrustRootIndex(X509Certificate...) - Constructor for class com.squareup.okhttp.internal.tls.RealTrustRootIndex
 
RealWebSocket - Class in com.squareup.okhttp.internal.ws
 
RealWebSocket(boolean, BufferedSource, BufferedSink, Random, Executor, WebSocketListener, String) - Constructor for class com.squareup.okhttp.internal.ws.RealWebSocket
 
RECEIVED_MILLIS - Static variable in class com.squareup.okhttp.internal.http.OkHeaders
Synthetic response header: the local time when the response was received.
receiveHeaders(Headers) - Method in class com.squareup.okhttp.internal.http.HttpEngine
 
RecordingHostnameVerifier - Class in com.squareup.okhttp.testing
 
RecordingHostnameVerifier() - Constructor for class com.squareup.okhttp.testing.RecordingHostnameVerifier
 
recover(RouteException) - Method in class com.squareup.okhttp.internal.http.HttpEngine
Attempt to recover from failure to connect via a route.
recover(IOException, Sink) - Method in class com.squareup.okhttp.internal.http.HttpEngine
Report and attempt to recover from a failure to communicate with a server.
recover(IOException) - Method in class com.squareup.okhttp.internal.http.HttpEngine
 
recover(RouteException) - Method in class com.squareup.okhttp.internal.http.StreamAllocation
 
recover(IOException, Sink) - Method in class com.squareup.okhttp.internal.http.StreamAllocation
 
redirectsToGet(String) - Static method in class com.squareup.okhttp.internal.http.HttpMethod
 
REFUSE_INCOMING_STREAMS - Static variable in class com.squareup.okhttp.internal.framed.FramedConnection.Listener
 
release() - Method in class com.squareup.okhttp.internal.http.StreamAllocation
 
releaseStreamAllocation() - Method in class com.squareup.okhttp.internal.http.HttpEngine
Configure the socket connection to be either pooled or closed when it is either exhausted or closed.
remove(String) - Method in class com.squareup.okhttp.internal.DiskLruCache
Drops the entry for key if it exists and can be removed.
remove(Request) - Method in interface com.squareup.okhttp.internal.InternalCache
Remove any cache entries for the supplied request.
removeAll(String) - Method in class com.squareup.okhttp.Headers.Builder
 
removeAllEncodedQueryParameters(String) - Method in class com.squareup.okhttp.HttpUrl.Builder
 
removeAllQueryParameters(String) - Method in class com.squareup.okhttp.HttpUrl.Builder
 
removeHeader(String) - Method in class com.squareup.okhttp.Request.Builder
 
removeHeader(String) - Method in class com.squareup.okhttp.Response.Builder
 
removePathSegment(int) - Method in class com.squareup.okhttp.HttpUrl.Builder
 
rename(File, File) - Method in interface com.squareup.okhttp.internal.io.FileSystem
Renames from to to.
rename(File, File) - Method in class com.squareup.okhttp.internal.io.InMemoryFileSystem
 
reply(List<Header>, boolean) - Method in class com.squareup.okhttp.internal.framed.FramedStream
Sends a reply to an incoming stream.
request() - Method in interface com.squareup.okhttp.Interceptor.Chain
 
Request - Class in com.squareup.okhttp
An HTTP request.
request(Request) - Method in class com.squareup.okhttp.Response.Builder
 
request() - Method in class com.squareup.okhttp.Response
The wire-level request that initiated this HTTP response.
Request.Builder - Class in com.squareup.okhttp
 
RequestBody - Class in com.squareup.okhttp
 
RequestBody() - Constructor for class com.squareup.okhttp.RequestBody
 
RequestBodyCompression - Class in com.squareup.okhttp.recipes
 
RequestBodyCompression() - Constructor for class com.squareup.okhttp.recipes.RequestBodyCompression
 
RequestException - Exception in com.squareup.okhttp.internal.http
Indicates a problem with interpreting a request.
RequestException(IOException) - Constructor for exception com.squareup.okhttp.internal.http.RequestException
 
RequestLine - Class in com.squareup.okhttp.internal.http
 
requestPath(HttpUrl) - Static method in class com.squareup.okhttp.internal.http.RequestLine
Returns the path to request, like the '/' in 'GET / HTTP/1.1'.
requiresRequestBody(String) - Static method in class com.squareup.okhttp.internal.http.HttpMethod
 
requiresTunnel() - Method in class com.squareup.okhttp.Route
Returns true if this route tunnels HTTPS through an HTTP proxy.
resolve(String) - Method in class com.squareup.okhttp.HttpUrl
Returns the URL that would be retrieved by following link from this URL.
Response - Class in com.squareup.okhttp
An HTTP response.
Response.Builder - Class in com.squareup.okhttp
 
RESPONSE_SOURCE - Static variable in class com.squareup.okhttp.internal.http.OkHeaders
Synthetic response header: the location from which the response was loaded.
RESPONSE_STATUS - Static variable in class com.squareup.okhttp.internal.framed.Header
 
ResponseBody - Class in com.squareup.okhttp
 
ResponseBody() - Constructor for class com.squareup.okhttp.ResponseBody
 
RetryableSink - Class in com.squareup.okhttp.internal.http
An HTTP request body that's completely buffered in memory.
RetryableSink(int) - Constructor for class com.squareup.okhttp.internal.http.RetryableSink
 
RetryableSink() - Constructor for class com.squareup.okhttp.internal.http.RetryableSink
 
RewriteResponseCacheControl - Class in com.squareup.okhttp.recipes
 
RewriteResponseCacheControl(File) - Constructor for class com.squareup.okhttp.recipes.RewriteResponseCacheControl
 
roundTripTime() - Method in class com.squareup.okhttp.internal.framed.Ping
Returns the round trip time for this ping in nanoseconds, waiting for the response to arrive if necessary.
roundTripTime(long, TimeUnit) - Method in class com.squareup.okhttp.internal.framed.Ping
Returns the round trip time for this ping in nanoseconds, or -1 if the response was canceled, or -2 if the timeout elapsed before the round trip completed.
Route - Class in com.squareup.okhttp
The concrete route used by a connection to reach an abstract origin server.
Route(Address, Proxy, InetSocketAddress) - Constructor for class com.squareup.okhttp.Route
 
routeDatabase(ConnectionPool) - Method in class com.squareup.okhttp.internal.Internal
 
RouteDatabase - Class in com.squareup.okhttp.internal
A blacklist of failed routes to avoid when creating a new connection to a target address.
RouteDatabase() - Constructor for class com.squareup.okhttp.internal.RouteDatabase
 
RouteException - Exception in com.squareup.okhttp.internal.http
An exception thrown to indicate a problem connecting via a single Route.
RouteException(IOException) - Constructor for exception com.squareup.okhttp.internal.http.RouteException
 
RouteSelector - Class in com.squareup.okhttp.internal.http
Selects routes to connect to an origin server.
RouteSelector(Address, RouteDatabase) - Constructor for class com.squareup.okhttp.internal.http.RouteSelector
 
rstStream(int, ErrorCode) - Method in interface com.squareup.okhttp.internal.framed.FrameReader.Handler
 
rstStream(int, ErrorCode) - Method in interface com.squareup.okhttp.internal.framed.FrameWriter
 
run() - Method in class com.squareup.okhttp.internal.NamedRunnable
 
run() - Method in class com.squareup.okhttp.recipes.AccessHeaders
 
run() - Method in class com.squareup.okhttp.recipes.AsynchronousGet
 
run() - Method in class com.squareup.okhttp.recipes.Authenticate
 
run() - Method in class com.squareup.okhttp.recipes.CacheResponse
 
run() - Method in class com.squareup.okhttp.recipes.CancelCall
 
run() - Method in class com.squareup.okhttp.recipes.CertificatePinning
 
run() - Method in class com.squareup.okhttp.recipes.CheckHandshake
 
run() - Method in class com.squareup.okhttp.recipes.ConfigureTimeouts
 
run() - Method in class com.squareup.okhttp.recipes.CustomTrust
 
run() - Method in class com.squareup.okhttp.recipes.LoggingInterceptors
 
run() - Method in class com.squareup.okhttp.recipes.ParseResponseWithGson
 
run() - Method in class com.squareup.okhttp.recipes.PerCallSettings
 
run() - Method in class com.squareup.okhttp.recipes.PostFile
 
run() - Method in class com.squareup.okhttp.recipes.PostForm
 
run() - Method in class com.squareup.okhttp.recipes.PostMultipart
 
run() - Method in class com.squareup.okhttp.recipes.PostStreaming
 
run() - Method in class com.squareup.okhttp.recipes.PostString
 
run() - Method in class com.squareup.okhttp.recipes.Progress
 
run() - Method in class com.squareup.okhttp.recipes.RequestBodyCompression
 
run() - Method in class com.squareup.okhttp.recipes.RewriteResponseCacheControl
 
run() - Method in class com.squareup.okhttp.recipes.SynchronousGet
 
run() - Method in class com.squareup.okhttp.ws.AutobahnTester
 

S

sameConnection(HttpUrl) - Method in class com.squareup.okhttp.internal.http.HttpEngine
Returns true if an HTTP request for followUp can reuse the connection used by this engine.
scheme(String) - Method in class com.squareup.okhttp.HttpUrl.Builder
 
scheme() - Method in class com.squareup.okhttp.HttpUrl
Returns either "http" or "https".
SELECTED_PROTOCOL - Static variable in class com.squareup.okhttp.internal.http.OkHeaders
Synthetic response header: the selected protocol ("spdy/3.1", "http/1.1", etc).
sendConnectionPreface() - Method in class com.squareup.okhttp.internal.framed.FramedConnection
Sends a connection header if the current variant requires it.
sendMessage(RequestBody) - Method in class com.squareup.okhttp.internal.ws.RealWebSocket
 
sendMessage(RequestBody) - Method in interface com.squareup.okhttp.ws.WebSocket
Send a message payload to the server.
sendPing(Buffer) - Method in class com.squareup.okhttp.internal.ws.RealWebSocket
 
sendPing(Buffer) - Method in interface com.squareup.okhttp.ws.WebSocket
Send a ping to the server with optional payload.
sendPong(Buffer) - Method in class com.squareup.okhttp.internal.ws.RealWebSocket
Send an unsolicited pong with the specified payload.
sendRequest() - Method in class com.squareup.okhttp.internal.http.HttpEngine
Figures out what the response source will be, and opens a socket to that source if necessary.
SENT_MILLIS - Static variable in class com.squareup.okhttp.internal.http.OkHeaders
Synthetic response header: the local time when the request was sent.
set(String, String) - Method in class com.squareup.okhttp.Headers.Builder
Set a field with the specified value.
setAuthenticator(Authenticator) - Method in class com.squareup.okhttp.OkHttpClient
Sets the authenticator used to respond to challenges from the remote web server or proxy server.
setCache(OkHttpClient, InternalCache) - Method in class com.squareup.okhttp.internal.Internal
 
setCache(Cache) - Method in class com.squareup.okhttp.OkHttpClient
 
setCertificatePinner(CertificatePinner) - Method in class com.squareup.okhttp.OkHttpClient
Sets the certificate pinner that constrains which certificates are trusted.
setConnectionPool(ConnectionPool) - Method in class com.squareup.okhttp.OkHttpClient
Sets the connection pool used to recycle HTTP and HTTPS connections.
setConnectionSpecs(List<ConnectionSpec>) - Method in class com.squareup.okhttp.OkHttpClient
 
setConnectTimeout(long, TimeUnit) - Method in class com.squareup.okhttp.OkHttpClient
Sets the default connect timeout for new connections.
setCookieHandler(CookieHandler) - Method in class com.squareup.okhttp.OkHttpClient
Sets the cookie handler to be used to read outgoing cookies and write incoming cookies.
setDispatcher(Dispatcher) - Method in class com.squareup.okhttp.OkHttpClient
Sets the dispatcher used to set policy and execute asynchronous requests.
setDns(Dns) - Method in class com.squareup.okhttp.OkHttpClient
Sets the DNS service used to lookup IP addresses for hostnames.
setEncodedPathSegment(int, String) - Method in class com.squareup.okhttp.HttpUrl.Builder
 
setEncodedQueryParameter(String, String) - Method in class com.squareup.okhttp.HttpUrl.Builder
 
setFollowRedirects(boolean) - Method in class com.squareup.okhttp.OkHttpClient
Configure this client to follow redirects.
setFollowSslRedirects(boolean) - Method in class com.squareup.okhttp.OkHttpClient
Configure this client to follow redirects from HTTPS to HTTP and from HTTP to HTTPS.
setHostnameVerifier(HostnameVerifier) - Method in class com.squareup.okhttp.OkHttpClient
Sets the verifier used to confirm that response certificates apply to requested hostnames for HTTPS connections.
setHttpEngine(HttpEngine) - Method in class com.squareup.okhttp.internal.http.Http1xStream
 
setHttpEngine(HttpEngine) - Method in class com.squareup.okhttp.internal.http.Http2xStream
 
setHttpEngine(HttpEngine) - Method in interface com.squareup.okhttp.internal.http.HttpStream
 
setLevel(HttpLoggingInterceptor.Level) - Method in class com.squareup.okhttp.logging.HttpLoggingInterceptor
Change the level at which this interceptor logs.
setMaxRequests(int) - Method in class com.squareup.okhttp.Dispatcher
Set the maximum number of requests to execute concurrently.
setMaxRequestsPerHost(int) - Method in class com.squareup.okhttp.Dispatcher
Set the maximum number of requests for each host to execute concurrently.
setMaxSize(long) - Method in class com.squareup.okhttp.internal.DiskLruCache
Changes the maximum number of bytes the cache can store and queues a job to trim the existing store, if necessary.
setPathSegment(int, String) - Method in class com.squareup.okhttp.HttpUrl.Builder
 
setProtocols(List<Protocol>) - Method in class com.squareup.okhttp.OkHttpClient
Configure the protocols used by this client to communicate with remote servers.
setProxy(Proxy) - Method in class com.squareup.okhttp.OkHttpClient
Sets the HTTP proxy that will be used by connections created by this client.
setProxySelector(ProxySelector) - Method in class com.squareup.okhttp.OkHttpClient
Sets the proxy selection policy to be used if no proxy is specified explicitly.
setQueryParameter(String, String) - Method in class com.squareup.okhttp.HttpUrl.Builder
 
setReadTimeout(long, TimeUnit) - Method in class com.squareup.okhttp.OkHttpClient
Sets the default read timeout for new connections.
setRetryOnConnectionFailure(boolean) - Method in class com.squareup.okhttp.OkHttpClient
Configure this client to retry or not when a connectivity problem is encountered.
setSettings(Settings) - Method in class com.squareup.okhttp.internal.framed.FramedConnection
Merges settings into this peer's settings and sends them to the remote peer.
setSocketFactory(SocketFactory) - Method in class com.squareup.okhttp.OkHttpClient
Sets the socket factory used to create connections.
setSslSocketFactory(SSLSocketFactory) - Method in class com.squareup.okhttp.OkHttpClient
Sets the socket factory used to secure HTTPS connections.
settings(boolean, Settings) - Method in interface com.squareup.okhttp.internal.framed.FrameReader.Handler
 
settings(Settings) - Method in interface com.squareup.okhttp.internal.framed.FrameWriter
Write okhttp's settings to the peer.
Settings - Class in com.squareup.okhttp.internal.framed
Settings describe characteristics of the sending peer, which are used by the receiving peer.
Settings() - Constructor for class com.squareup.okhttp.internal.framed.Settings
 
setWriteTimeout(long, TimeUnit) - Method in class com.squareup.okhttp.OkHttpClient
Sets the default write timeout for new connections.
sha1(ByteString) - Static method in class com.squareup.okhttp.internal.Util
Returns a SHA-1 hash of s.
shaBase64(String) - Static method in class com.squareup.okhttp.internal.Util
Returns a Base 64-encoded string containing a SHA-1 hash of s.
shouldPostpone(Route) - Method in class com.squareup.okhttp.internal.RouteDatabase
Returns true if route has failed recently and should be avoided.
shutdown(ErrorCode) - Method in class com.squareup.okhttp.internal.framed.FramedConnection
Degrades this connection such that new streams can neither be created locally, nor accepted from the remote peer.
sink(File) - Method in interface com.squareup.okhttp.internal.io.FileSystem
Writes to file, discarding any data already present.
sink(File) - Method in class com.squareup.okhttp.internal.io.InMemoryFileSystem
 
sink - Variable in class com.squareup.okhttp.internal.io.RealConnection
 
size() - Method in class com.squareup.okhttp.Headers
Returns the number of field values.
size() - Method in class com.squareup.okhttp.internal.DiskLruCache
Returns the number of bytes currently being used to store the values in this cache.
size(File) - Method in interface com.squareup.okhttp.internal.io.FileSystem
Returns the number of bytes stored in file, or 0 if it does not exist.
size(File) - Method in class com.squareup.okhttp.internal.io.InMemoryFileSystem
 
skipAll(Source, int, TimeUnit) - Static method in class com.squareup.okhttp.internal.Util
Reads until in is exhausted or the deadline has been reached.
skipUntil(String, int, String) - Static method in class com.squareup.okhttp.internal.http.HeaderParser
Returns the next index in input at or after pos that contains a character from characters.
skipWhitespace(String, int) - Static method in class com.squareup.okhttp.internal.http.HeaderParser
Returns the next non-whitespace character in input that is white space.
sMaxAgeSeconds() - Method in class com.squareup.okhttp.CacheControl
The "s-maxage" directive is the max age for shared caches.
snapshots() - Method in class com.squareup.okhttp.internal.DiskLruCache
Returns an iterator over the cache's current entries.
socket(Socket) - Method in class com.squareup.okhttp.internal.framed.FramedConnection.Builder
 
socket(Socket, String, BufferedSource, BufferedSink) - Method in class com.squareup.okhttp.internal.framed.FramedConnection.Builder
 
socket - Variable in class com.squareup.okhttp.internal.io.RealConnection
The application layer socket.
source() - Method in class com.squareup.okhttp.internal.http.RealResponseBody
 
source(File) - Method in interface com.squareup.okhttp.internal.io.FileSystem
Reads from file.
source(File) - Method in class com.squareup.okhttp.internal.io.InMemoryFileSystem
 
source - Variable in class com.squareup.okhttp.internal.io.RealConnection
 
source() - Method in class com.squareup.okhttp.ResponseBody
 
Spdy3 - Class in com.squareup.okhttp.internal.framed
Read and write spdy/3.1 frames.
Spdy3() - Constructor for class com.squareup.okhttp.internal.framed.Spdy3
 
spdy3HeadersList(Request) - Static method in class com.squareup.okhttp.internal.http.Http2xStream
Returns a list of alternating names and values containing a SPDY request.
spdyGoAwayCode - Variable in enum com.squareup.okhttp.internal.framed.ErrorCode
 
spdyRstCode - Variable in enum com.squareup.okhttp.internal.framed.ErrorCode
 
sslContextForTrustedCertificates(InputStream) - Method in class com.squareup.okhttp.recipes.CustomTrust
Returns a SSL context that trusts certificates and none other.
StatusLine - Class in com.squareup.okhttp.internal.http
An HTTP response status line like "HTTP/1.1 200 OK".
StatusLine(Protocol, int, String) - Constructor for class com.squareup.okhttp.internal.http.StatusLine
 
stream() - Method in class com.squareup.okhttp.internal.http.StreamAllocation
 
streamAllocation - Variable in class com.squareup.okhttp.internal.http.HttpEngine
 
StreamAllocation - Class in com.squareup.okhttp.internal.http
This class coordinates the relationship between three entities: Connections: physical socket connections to remote servers.
StreamAllocation(ConnectionPool, Address) - Constructor for class com.squareup.okhttp.internal.http.StreamAllocation
 
streamCount - Variable in class com.squareup.okhttp.internal.io.RealConnection
 
streamFinished(HttpStream) - Method in class com.squareup.okhttp.internal.http.StreamAllocation
 
string() - Method in class com.squareup.okhttp.ResponseBody
Returns the response as a string decoded with the charset of the Content-Type header.
subtype() - Method in class com.squareup.okhttp.MediaType
Returns a specific media subtype, such as "plain" or "png", "mpeg", "mp4" or "xml".
supportsTlsExtensions(boolean) - Method in class com.squareup.okhttp.ConnectionSpec.Builder
 
supportsTlsExtensions() - Method in class com.squareup.okhttp.ConnectionSpec
 
SynchronousGet - Class in com.squareup.okhttp.recipes
 
SynchronousGet() - Constructor for class com.squareup.okhttp.recipes.SynchronousGet
 
synReply(boolean, int, List<Header>) - Method in interface com.squareup.okhttp.internal.framed.FrameWriter
 
synStream(boolean, boolean, int, int, List<Header>) - Method in interface com.squareup.okhttp.internal.framed.FrameWriter
 
SYSTEM - Static variable in interface com.squareup.okhttp.Dns
A DNS that uses InetAddress.getAllByName(java.lang.String) to ask the underlying operating system to lookup IP addresses.
SYSTEM - Static variable in interface com.squareup.okhttp.internal.io.FileSystem
The host machine's local file system.

T

tag(Object) - Method in class com.squareup.okhttp.Request.Builder
Attaches tag to the request.
tag() - Method in class com.squareup.okhttp.Request
 
tagSocket(Socket) - Method in class com.squareup.okhttp.internal.Platform
 
TARGET_AUTHORITY - Static variable in class com.squareup.okhttp.internal.framed.Header
 
TARGET_HOST - Static variable in class com.squareup.okhttp.internal.framed.Header
 
TARGET_METHOD - Static variable in class com.squareup.okhttp.internal.framed.Header
 
TARGET_PATH - Static variable in class com.squareup.okhttp.internal.framed.Header
 
TARGET_SCHEME - Static variable in class com.squareup.okhttp.internal.framed.Header
 
testRunFinished(Result) - Method in class com.squareup.okhttp.testing.InstallUncaughtExceptionHandlerListener
 
testRunStarted(Description) - Method in class com.squareup.okhttp.testing.InstallUncaughtExceptionHandlerListener
 
testStarted(Description) - Method in class com.squareup.okhttp.testing.InstallUncaughtExceptionHandlerListener
 
TEXT - Static variable in interface com.squareup.okhttp.ws.WebSocket
A MediaType indicating UTF-8 text frames should be used when sending the message.
threadFactory(String, boolean) - Static method in class com.squareup.okhttp.internal.Util
 
timeout() - Method in class com.squareup.okhttp.internal.http.RetryableSink
 
TlsVersion - Enum in com.squareup.okhttp
Versions of TLS that can be offered when negotiating a secure socket.
tlsVersions(TlsVersion...) - Method in class com.squareup.okhttp.ConnectionSpec.Builder
 
tlsVersions(String...) - Method in class com.squareup.okhttp.ConnectionSpec.Builder
 
tlsVersions() - Method in class com.squareup.okhttp.ConnectionSpec
Returns the TLS versions to use when negotiating a connection.
toHumanReadableAscii(String) - Static method in class com.squareup.okhttp.internal.Util
Returns s with control characters and non-ASCII characters replaced with '?'.
toMultimap() - Method in class com.squareup.okhttp.Headers
 
toMultimap(Headers, String) - Static method in class com.squareup.okhttp.internal.http.OkHeaders
Returns an immutable map containing each field to its list of values.
toString() - Method in class com.squareup.okhttp.CacheControl
 
toString() - Method in class com.squareup.okhttp.Challenge
 
toString() - Method in class com.squareup.okhttp.ConnectionSpec
 
toString() - Method in class com.squareup.okhttp.Headers
 
toString() - Method in class com.squareup.okhttp.HttpUrl.Builder
 
toString() - Method in class com.squareup.okhttp.HttpUrl
 
toString() - Method in class com.squareup.okhttp.internal.framed.Header
 
toString() - Method in class com.squareup.okhttp.internal.http.StatusLine
 
toString() - Method in class com.squareup.okhttp.internal.http.StreamAllocation
 
toString() - Method in class com.squareup.okhttp.internal.io.RealConnection
 
toString() - Method in class com.squareup.okhttp.MediaType
Returns the encoded media type, like "text/plain; charset=utf-8", appropriate for use in a Content-Type header.
toString() - Method in enum com.squareup.okhttp.Protocol
Returns the string used to identify this protocol for ALPN, like "http/1.1", "spdy/3.1" or "h2".
toString() - Method in class com.squareup.okhttp.Request
 
toString() - Method in class com.squareup.okhttp.Response
 
trackConditionalCacheHit() - Method in interface com.squareup.okhttp.internal.InternalCache
Track an conditional GET that was satisfied by this cache.
trackResponse(CacheStrategy) - Method in interface com.squareup.okhttp.internal.InternalCache
Track an HTTP response being satisfied with cacheStrategy.
trustManager(SSLSocketFactory) - Method in class com.squareup.okhttp.internal.Platform
 
trustRootIndex(X509TrustManager) - Method in class com.squareup.okhttp.internal.Platform
 
TrustRootIndex - Interface in com.squareup.okhttp.internal.tls
 
type() - Method in class com.squareup.okhttp.MediaType
Returns the high-level media type, such as "text", "image", "audio", "video", or "application".
type(MediaType) - Method in class com.squareup.okhttp.MultipartBuilder
Set the MIME type.

U

untagSocket(Socket) - Method in class com.squareup.okhttp.internal.Platform
 
update(Response, Response) - Method in interface com.squareup.okhttp.internal.InternalCache
Handles a conditional request hit by updating the stored cache response with the headers from network.
uri() - Method in class com.squareup.okhttp.HttpUrl
Returns this URL as a java.net.URI.
uri() - Method in class com.squareup.okhttp.Request
 
url() - Method in class com.squareup.okhttp.Address
Returns a URL with the hostname and port of the origin server.
url() - Method in class com.squareup.okhttp.HttpUrl
Returns this URL as a java.net.URL.
url(HttpUrl) - Method in class com.squareup.okhttp.Request.Builder
 
url(String) - Method in class com.squareup.okhttp.Request.Builder
Sets the URL target of this request.
url(URL) - Method in class com.squareup.okhttp.Request.Builder
Sets the URL target of this request.
url() - Method in class com.squareup.okhttp.Request
 
urls() - Method in class com.squareup.okhttp.Cache
Returns an iterator over the URLs in this cache.
urlString() - Method in class com.squareup.okhttp.Request
 
userAgent() - Static method in class com.squareup.okhttp.internal.Version
 
username(String) - Method in class com.squareup.okhttp.HttpUrl.Builder
 
username() - Method in class com.squareup.okhttp.HttpUrl
 
UTF_8 - Static variable in class com.squareup.okhttp.internal.Util
A cheap and type-safe constant for the UTF-8 Charset.
Util - Class in com.squareup.okhttp.internal
Junk drawer of utility methods.

V

value(int) - Method in class com.squareup.okhttp.Headers
Returns the value at index or null if that is out of range.
value - Variable in class com.squareup.okhttp.internal.framed.Header
Value in UTF-8 encoding.
valueOf(String) - Static method in enum com.squareup.okhttp.CipherSuite
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.squareup.okhttp.internal.framed.ErrorCode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.squareup.okhttp.internal.framed.HeadersMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.squareup.okhttp.logging.HttpLoggingInterceptor.Level
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.squareup.okhttp.Protocol
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.squareup.okhttp.TlsVersion
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.squareup.okhttp.CipherSuite
Returns an array containing the constants of this enum type, in the order they are declared.
values(String) - Method in class com.squareup.okhttp.Headers
Returns an immutable list of the header values for name.
values() - Static method in enum com.squareup.okhttp.internal.framed.ErrorCode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.squareup.okhttp.internal.framed.HeadersMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.squareup.okhttp.logging.HttpLoggingInterceptor.Level
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.squareup.okhttp.Protocol
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.squareup.okhttp.TlsVersion
Returns an array containing the constants of this enum type, in the order they are declared.
Variant - Interface in com.squareup.okhttp.internal.framed
A version and dialect of the framed socket protocol.
varyFields(Headers) - Static method in class com.squareup.okhttp.internal.http.OkHeaders
Returns the names of the request headers that need to be checked for equality when caching.
varyHeaders(Response) - Static method in class com.squareup.okhttp.internal.http.OkHeaders
Returns the subset of the headers in response's request that impact the content of response's body.
varyHeaders(Headers, Headers) - Static method in class com.squareup.okhttp.internal.http.OkHeaders
Returns the subset of the headers in requestHeaders that impact the content of response's body.
varyMatches(Response, Headers, Request) - Static method in class com.squareup.okhttp.internal.http.OkHeaders
Returns true if none of the Vary headers have changed between cachedRequest and newRequest.
verify(String, SSLSession) - Method in class com.squareup.okhttp.internal.tls.OkHostnameVerifier
 
verify(String, X509Certificate) - Method in class com.squareup.okhttp.internal.tls.OkHostnameVerifier
 
verify(String, SSLSession) - Method in class com.squareup.okhttp.testing.RecordingHostnameVerifier
 
VERSION - Static variable in class com.squareup.okhttp.internal.framed.Header
 
Version - Class in com.squareup.okhttp.internal
 

W

WebSocket - Interface in com.squareup.okhttp.ws
Blocking interface to connect and write to a web socket.
WebSocketCall - Class in com.squareup.okhttp.ws
 
WebSocketEcho - Class in com.squareup.okhttp.recipes
 
WebSocketEcho() - Constructor for class com.squareup.okhttp.recipes.WebSocketEcho
 
WebSocketListener - Interface in com.squareup.okhttp.ws
Listener for server-initiated messages on a connected WebSocket.
WebSocketProtocol - Class in com.squareup.okhttp.internal.ws
 
WebSocketReader - Class in com.squareup.okhttp.internal.ws
An RFC 6455-compatible WebSocket frame reader.
WebSocketReader(boolean, BufferedSource, WebSocketReader.FrameCallback) - Constructor for class com.squareup.okhttp.internal.ws.WebSocketReader
 
WebSocketReader.FrameCallback - Interface in com.squareup.okhttp.internal.ws
 
WebSocketWriter - Class in com.squareup.okhttp.internal.ws
An RFC 6455-compatible WebSocket frame writer.
WebSocketWriter(boolean, BufferedSink, Random) - Constructor for class com.squareup.okhttp.internal.ws.WebSocketWriter
 
windowUpdate(int, long) - Method in interface com.squareup.okhttp.internal.framed.FrameReader.Handler
Notifies that an additional windowSizeIncrement bytes can be sent on streamId, or the connection if streamId is zero.
windowUpdate(int, long) - Method in interface com.squareup.okhttp.internal.framed.FrameWriter
Inform peer that an additional windowSizeIncrement bytes can be sent on streamId, or the connection if streamId is zero.
write(Buffer, long) - Method in class com.squareup.okhttp.internal.http.RetryableSink
 
writeClose(int, String) - Method in class com.squareup.okhttp.internal.ws.WebSocketWriter
Send a close frame with optional code and reason.
writeData(int, boolean, Buffer, long) - Method in class com.squareup.okhttp.internal.framed.FramedConnection
Callers of this method are not thread safe, and sometimes on application threads.
writePing(Buffer) - Method in class com.squareup.okhttp.internal.ws.WebSocketWriter
Send a ping with the supplied payload.
writePong(Buffer) - Method in class com.squareup.okhttp.internal.ws.WebSocketWriter
Send a pong with the supplied payload.
writeRequest(Headers, String) - Method in class com.squareup.okhttp.internal.http.Http1xStream
Returns bytes of a request header for sending on an HTTP transport.
writeRequestBody(RetryableSink) - Method in class com.squareup.okhttp.internal.http.Http1xStream
 
writeRequestBody(RetryableSink) - Method in class com.squareup.okhttp.internal.http.Http2xStream
 
writeRequestBody(RetryableSink) - Method in interface com.squareup.okhttp.internal.http.HttpStream
Sends the request body returned by HttpStream.createRequestBody(com.squareup.okhttp.Request, long) to the remote peer.
writeRequestHeaders(Request) - Method in class com.squareup.okhttp.internal.http.Http1xStream
Prepares the HTTP headers and sends them to the server.
writeRequestHeaders(Request) - Method in class com.squareup.okhttp.internal.http.Http2xStream
 
writeRequestHeaders(Request) - Method in interface com.squareup.okhttp.internal.http.HttpStream
This should update the HTTP engine's sentRequestMillis field.
writeTimeout() - Method in class com.squareup.okhttp.internal.framed.FramedStream
 
writeTo(BufferedSink) - Method in class com.squareup.okhttp.RequestBody
Writes the content of this request to out.
writeToSocket(Sink) - Method in class com.squareup.okhttp.internal.http.RetryableSink
 
writingRequestHeaders() - Method in class com.squareup.okhttp.internal.http.HttpEngine
Called immediately before the transport transmits HTTP request headers.
A B C D E F G H I J K L M N O P Q R S T U V W 
Skip navigation links

Copyright © 2017. All Rights Reserved.