org.eclipse.jetty.spdy.client

Class SPDYClient

java.lang.Object

org.eclipse.jetty.spdy.client.SPDYClient

public class SPDYClient
extends Object

A SPDYClient allows applications to connect to one or more SPDY servers, obtaining Session objects that can be used to send/receive SPDY frames.

SPDYClient instances are created through a SPDYClient.Factory:

 SPDYClient.Factory factory = new SPDYClient.Factory();
 SPDYClient client = factory.newSPDYClient(SPDY.V3);
 

and then used to connect to the server:

 FuturePromise<Session> promise = new FuturePromise<>();
 client.connect("server.com", null, promise);
 Session session = promise.get();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SPDYClient.Factory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SPDYClient(short version, SPDYClient.Factory factory)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configure(SocketChannel channel)
Session	connect(SocketAddress address, SessionFrameListener listener) Equivalent to:
void	connect(SocketAddress address, SessionFrameListener listener, Promise<Session> promise) Equivalent to:
void	connect(SocketAddress address, SessionFrameListener listener, Promise<Session> promise, Map<String,Object> context) Connects to the given address, binding the given listener to session events, and notified the given promise of the connect result.
SocketAddress	getBindAddress()
ClientConnectionFactory	getClientConnectionFactory()
SPDYClient.Factory	getFactory()
long	getIdleTimeout()
int	getInitialWindowSize()
short	getVersion()
boolean	isDispatchIO()
protected FlowControlStrategy	newFlowControlStrategy()
void	setBindAddress(SocketAddress bindAddress)
void	setClientConnectionFactory(ClientConnectionFactory connectionFactory)
void	setDispatchIO(boolean dispatchIO)
void	setIdleTimeout(long idleTimeout)
void	setInitialWindowSize(int initialWindowSize)

Methods inherited from class java.lang.Object

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

Constructor Detail

SPDYClient

protected SPDYClient(short version,
          SPDYClient.Factory factory)

Method Detail

getVersion

public short getVersion()

getFactory

public SPDYClient.Factory getFactory()

connect

public Session connect(SocketAddress address,
              SessionFrameListener listener)
                throws ExecutionException,
                       InterruptedException

Equivalent to:

 Future<Session> promise = new FuturePromise<>();
 connect(address, listener, promise);
 

Parameters:

address - the address to connect to

listener - the session listener that will be notified of session events

Returns:

a Session when connected

Throws:

ExecutionException

InterruptedException

connect

public void connect(SocketAddress address,
           SessionFrameListener listener,
           Promise<Session> promise)

Equivalent to:

 connect(address, listener, promise, null);
 

Parameters:

address - the address to connect to

listener - the session listener that will be notified of session events

promise - the promise notified of connection success/failure

connect

public void connect(SocketAddress address,
           SessionFrameListener listener,
           Promise<Session> promise,
           Map<String,Object> context)

Connects to the given address, binding the given listener to session events, and notified the given promise of the connect result.

If the connect operation is successful, the promise will be invoked with the Session object that applications can use to perform SPDY requests.

Parameters:

address - the address to connect to

listener - the session listener that will be notified of session events

promise - the promise notified of connection success/failure

context - a context object passed to the ConnectionFactory for the creation of the connection

configure

protected void configure(SocketChannel channel)
                  throws IOException

Throws:

IOException

getBindAddress

public SocketAddress getBindAddress()

Returns:

the address to bind the socket channel to

See Also:

setBindAddress(SocketAddress)

setBindAddress

public void setBindAddress(SocketAddress bindAddress)

Parameters:

bindAddress - the address to bind the socket channel to

See Also:

getBindAddress()

getIdleTimeout

public long getIdleTimeout()

setIdleTimeout

public void setIdleTimeout(long idleTimeout)

getInitialWindowSize

public int getInitialWindowSize()

setInitialWindowSize

public void setInitialWindowSize(int initialWindowSize)

isDispatchIO

public boolean isDispatchIO()

setDispatchIO

public void setDispatchIO(boolean dispatchIO)

getClientConnectionFactory

public ClientConnectionFactory getClientConnectionFactory()

setClientConnectionFactory

public void setClientConnectionFactory(ClientConnectionFactory connectionFactory)

newFlowControlStrategy

protected FlowControlStrategy newFlowControlStrategy()