Package com.squareup.okhttp.internal.framed

Class FramedConnection

java.lang.Object

com.squareup.okhttp.internal.framed.FramedConnection

All Implemented Interfaces:

Closeable, AutoCloseable

public final class FramedConnection
extends Object
implements Closeable

A socket connection to a remote peer. A connection hosts streams which can send and receive data.

Many methods in this API are synchronous: the call is completed before the method returns. This is typical for Java but atypical for SPDY. This is motivated by exception transparency: an IOException that was triggered by a certain caller can be caught and handled by that caller.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FramedConnection.Builder

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this connection.
void	flush()
long	getIdleStartTimeNs()	Returns the time in ns when this connection became idle or Long.MAX_VALUE if connection is not idle.
Protocol	getProtocol()	The protocol as selected using ALPN.
boolean	isIdle()	Returns true if this connection is idle.
FramedStream	newStream(List<Header> requestHeaders, boolean out, boolean in)	Returns a new locally-initiated stream.
int	openStreamCount()	Returns the number of open streams on this connection.
Ping	ping()	Sends a ping frame to the peer.
FramedStream	pushStream(int associatedStreamId, List<Header> requestHeaders, boolean out)	Returns a new server-initiated stream.
void	sendConnectionPreface()	Sends a connection header if the current variant requires it.
void	shutdown(ErrorCode statusCode)	Degrades this connection such that new streams can neither be created locally, nor accepted from the remote peer.
void	writeData(int streamId, boolean outFinished, Buffer buffer, long byteCount)	Callers of this method are not thread safe, and sometimes on application threads.

Methods inherited from class java.lang.Object

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

Method Detail

getProtocol

public Protocol getProtocol()

The protocol as selected using ALPN.

openStreamCount

public int openStreamCount()

Returns the number of open streams on this connection.

isIdle

public boolean isIdle()

Returns true if this connection is idle.

getIdleStartTimeNs

public long getIdleStartTimeNs()

Returns the time in ns when this connection became idle or Long.MAX_VALUE if connection is not idle.

pushStream

public FramedStream pushStream(int associatedStreamId,
                               List<Header> requestHeaders,
                               boolean out)
                        throws IOException

Returns a new server-initiated stream.

Parameters:

associatedStreamId - the stream that triggered the sender to create this stream.

out - true to create an output stream that we can use to send data to the remote peer. Corresponds to FLAG_FIN.

Throws:

IOException

newStream

public FramedStream newStream(List<Header> requestHeaders,
                              boolean out,
                              boolean in)
                       throws IOException

Returns a new locally-initiated stream.

Parameters:

out - true to create an output stream that we can use to send data to the remote peer. Corresponds to FLAG_FIN.

in - true to create an input stream that the remote peer can use to send data to us. Corresponds to FLAG_UNIDIRECTIONAL.

Throws:

IOException

writeData

public void writeData(int streamId,
                      boolean outFinished,
                      Buffer buffer,
                      long byteCount)
               throws IOException

Callers of this method are not thread safe, and sometimes on application threads. Most often, this method will be called to send a buffer worth of data to the peer.

Writes are subject to the write window of the stream and the connection. Until there is a window sufficient to send byteCount, the caller will block. For example, a user of HttpURLConnection who flushes more bytes to the output stream than the connection's write window will block.

Zero byteCount writes are not subject to flow control and will not block. The only use case for zero byteCount is closing a flushed output stream.

Throws:

IOException

ping

public Ping ping()
          throws IOException

Sends a ping frame to the peer. Use the returned object to await the ping's response and observe its round trip time.

Throws:

IOException

flush

public void flush()
           throws IOException

Throws:

IOException

shutdown

public void shutdown(ErrorCode statusCode)
              throws IOException

Degrades this connection such that new streams can neither be created locally, nor accepted from the remote peer. Existing streams are not impacted. This is intended to permit an endpoint to gracefully stop accepting new requests without harming previously established streams.

Throws:

IOException

close

public void close()
           throws IOException

Closes this connection. This cancels all open streams and unanswered pings. It closes the underlying input and output streams and shuts down internal executor services.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

sendConnectionPreface

public void sendConnectionPreface()
                           throws IOException

Sends a connection header if the current variant requires it. This should be called after FramedConnection.Builder.build() for all new connections.

Throws:

IOException