SpdyConnection (Apache Tomcat 8.0.15 API Documentation)

java.lang.Object
- org.apache.tomcat.spdy.SpdyConnection

```
public abstract class SpdyConnection
extends Object
```
Main class implementing SPDY protocol. Works with both blocking and non-blocking sockets. To simplify integration in various endpoints there is no 'socket' layer/abstraction, but read/write abstract methods. Because SPDY is multiplexing, a blocking socket needs a second thread to handle writes ( the read thread may be blocked while a servlet is writing ). The intended use of SPDY with blocking sockets is for frontend(load-balancer) to tomcat, where each tomcat will have a few spdy connections.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CLOSE`
`protected boolean`	`inClosed`
`static int`	`LONG`
`protected SpdyContext`	`spdyContext`
`static int`	`TYPE_GOAWAY`
`static int`	`TYPE_HEADERS`
`static int`	`TYPE_PING`
`static int`	`TYPE_RST_STREAM`
`static int`	`TYPE_SETTINGS`
`static int`	`TYPE_SYN_REPLY`
`static int`	`TYPE_SYN_STREAM`
`static int`	`TYPE_WINDOW`
`static String[]`	`TYPES`

Constructor Summary

Constructors
Constructor and Description

SpdyConnection(SpdyContext spdyContext)

Constructors
Constructor and Description
`SpdyConnection(SpdyContext spdyContext)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`abort(String msg)`
`void`	`abort(String msg, int last)`
`abstract void`	`close()`
`void`	`drain()`
`void`	`dump(PrintWriter out)`
`SpdyStream`	`get(String host, String url)`
`SpdyFrame`	`getDataFrame()`
`SpdyFrame`	`getFrame(int type)`
`SpdyContext`	`getSpdyContext()`
`protected int`	`handleFrame()` Process a SPDY connection.
`SpdyFrame`	`inFrame()`
`void`	`nonBlockingSend(SpdyFrame oframe, SpdyStream proc)` Send as much as possible without blocking.
`int`	`onBlockingSocket()` Process a SPDY connection using a blocking socket.
`void`	`onClose()`
`int`	`processInput()` Non-blocking method, read as much as possible and return.
`abstract int`	`read(byte[] data, int off, int len)` Like read, but may return 0 if no data is available and the channel supports polling.
`void`	`send(SpdyFrame oframe, SpdyStream proc)` Add the frame to the queue and send until the queue is empty.
`void`	`setCompressSupport(org.apache.tomcat.spdy.SpdyConnection.CompressSupport cs)`
`String`	`toString()`
`abstract int`	`write(byte[] data, int off, int len)` Write.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_SYN_STREAM
```
public static final int TYPE_SYN_STREAM
```
See Also:
Constant Field Values

TYPE_SYN_REPLY
```
public static final int TYPE_SYN_REPLY
```
See Also:
Constant Field Values

TYPE_RST_STREAM
```
public static final int TYPE_RST_STREAM
```
See Also:
Constant Field Values

TYPE_SETTINGS
```
public static final int TYPE_SETTINGS
```
See Also:
Constant Field Values

TYPE_PING
```
public static final int TYPE_PING
```
See Also:
Constant Field Values

TYPE_GOAWAY
```
public static final int TYPE_GOAWAY
```
See Also:
Constant Field Values

TYPE_HEADERS
```
public static final int TYPE_HEADERS
```
See Also:
Constant Field Values

TYPE_WINDOW
```
public static final int TYPE_WINDOW
```
See Also:
Constant Field Values

TYPES
```
public static String[] TYPES
```

spdyContext

protected final SpdyContext spdyContext

inClosed
```
protected boolean inClosed
```

LONG
```
public static final int LONG
```
See Also:
Constant Field Values

CLOSE
```
public static final int CLOSE
```
See Also:
Constant Field Values

Constructor Detail

SpdyConnection

public SpdyConnection(SpdyContext spdyContext)

Method Detail

toString
```
public String toString()
```
Overrides:

toString in class Object

dump
```
public void dump(PrintWriter out)
```

write

public abstract int write(byte[] data,
        int off,
        int len)
                   throws IOException

Write.

Throws:: IOException

read

public abstract int read(byte[] data,
       int off,
       int len)
                  throws IOException

Like read, but may return 0 if no data is available and the channel supports polling.

Throws:: IOException

close

public abstract void close()
                    throws IOException

Throws:: IOException

setCompressSupport

public void setCompressSupport(org.apache.tomcat.spdy.SpdyConnection.CompressSupport cs)

getFrame
```
public SpdyFrame getFrame(int type)
```

getDataFrame
```
public SpdyFrame getDataFrame()
```

drain
```
public void drain()
```

nonBlockingSend
```
public void nonBlockingSend(SpdyFrame oframe,
                   SpdyStream proc)
```
Send as much as possible without blocking. With a nb transport it should call drain directly.

send

public void send(SpdyFrame oframe,
        SpdyStream proc)

Add the frame to the queue and send until the queue is empty.

onClose
```
public void onClose()
```

inFrame
```
public SpdyFrame inFrame()
```

onBlockingSocket
```
public int onBlockingSocket()
```
Process a SPDY connection using a blocking socket.

processInput
```
public int processInput()
                 throws IOException
```
Non-blocking method, read as much as possible and return.

Throws:

IOException

abort
```
public void abort(String msg)
```

abort

public void abort(String msg,
         int last)

handleFrame
```
protected int handleFrame()
                   throws IOException
```
Process a SPDY connection. Called in the input thread, should not block.

Throws:

IOException

getSpdyContext
```
public SpdyContext getSpdyContext()
```

get

public SpdyStream get(String host,
             String url)

Class SpdyConnection

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_SYN_STREAM

TYPE_SYN_REPLY

TYPE_RST_STREAM

TYPE_SETTINGS

TYPE_PING

TYPE_GOAWAY

TYPE_HEADERS

TYPE_WINDOW

TYPES

spdyContext

inClosed

LONG

CLOSE

Constructor Detail

SpdyConnection

Method Detail

toString

dump

write

read

close

setCompressSupport

getFrame

getDataFrame

drain

nonBlockingSend

send

onClose

inFrame

onBlockingSocket

processInput

abort

abort

handleFrame

getSpdyContext

get