org.atmosphere.wasync.impl

Class DefaultSocket

java.lang.Object

org.atmosphere.wasync.impl.DefaultSocket

All Implemented Interfaces:

Socket

Direct Known Subclasses:

AtmosphereSocket

public class DefaultSocket
extends Object
implements Socket

Default implementation of the Socket

Author:

Jeanfrancois Arcand

Nested Class Summary

Nested classes/interfaces inherited from interface org.atmosphere.wasync.Socket

Socket.STATUS

Field Summary

Fields

Modifier and Type	Field and Description
protected List<FunctionWrapper>	functions
protected Options	options
protected Request	request
protected SocketRuntime	socketRuntime
protected Transport	transportInUse

Constructor Summary

Constructors

Constructor and Description
DefaultSocket(Options options)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addFunction(long timeout, TimeUnit tu)
void	close() Close this Socket, asynchronously.
protected void	closeRuntime(boolean async)
protected Socket	connect(com.ning.http.client.RequestBuilder r, List<Transport> transports, long timeout, TimeUnit tu)
SocketRuntime	createRuntime(DefaultFuture future, Options options, List<FunctionWrapper> functions)
Future	fire(Object data) Send data to the remote Server.
protected List<Transport>	getTransport(com.ning.http.client.RequestBuilder r, Request request)
protected SocketRuntime	internalSocket()
Socket	on(Event event, Function<?> function) Associate a Function with an Event.
Socket	on(Function<? extends Object> function) Associate a Function with the Socket.
Socket	on(String functionName, Function<? extends Object> function) Associate a Function with the Socket.
Socket	open(Request request) Connect to the remote Server using the Request's information.
Socket	open(Request request, long timeout, TimeUnit tu) Connect to the remote Server using the Request's information, will timeout if the connection failed to open within a certain time.
protected Request	request()
Socket.STATUS	status() Return the Socket.STATUS of this Socket.

Methods inherited from class java.lang.Object

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

Field Detail

request

protected Request request

socketRuntime

protected SocketRuntime socketRuntime

functions

protected final List<FunctionWrapper> functions

transportInUse

protected Transport transportInUse

options

protected final Options options

Constructor Detail

DefaultSocket

public DefaultSocket(Options options)

Method Detail

fire

public Future fire(Object data)
            throws IOException

Send data to the remote Server. The object will first be delivered to the set of Encoder, and then send to the server. The server's response will be delivered to the set of defined Function using the opened Transport, e.g for Request.TRANSPORT.WEBSOCKET, the same connection will be re-used and, for others transports, the suspended connection.

Specified by:

fire in interface Socket

Parameters:

data - object to send

Returns:

a Future

Throws:

IOException

on

public Socket on(Function<? extends Object> function)

Associate a Function with the Socket. When a response is received, the library will try to associated the decoded message (decoded by Decoder) to the defined type of the Function

Specified by:

on in interface Socket

Parameters:

function - a Function

Returns:

this

on

public Socket on(String functionName,
        Function<? extends Object> function)

Associate a Function with the Socket. When a response is received, the library will try to associated the decoded message (decoded by Decoder) to the defined type of the Function. The default messages are defined by Event but handling of custom message can be done using a FunctionResolver

Specified by:

on in interface Socket

function - a Function

Returns:

this

on

public Socket on(Event event,
        Function<?> function)

Description copied from interface: Socket

Associate a Function with an Event. When the event happen the library will try to associated the decoded event (decoded by Decoder) to the defined type of the Function. The default event are defined by Event but handling of custom event can be done using a FunctionResolver

Specified by:

on in interface Socket

function - a Function

Returns:

this

open

public Socket open(Request request)
            throws IOException

Description copied from interface: Socket

Connect to the remote Server using the Request's information.

Specified by:

open in interface Socket

Parameters:

request - a Request

Returns:

this

Throws:

IOException - in case the connect fails or a network failure occurs.

open

public Socket open(Request request,
          long timeout,
          TimeUnit tu)
            throws IOException

Connect to the remote Server using the Request's information, will timeout if the connection failed to open within a certain time.

Specified by:

open in interface Socket

Parameters:

request - a Request

timeout - the maximum time to wait

tu - the time unit of the timeout argument

Returns:

this

Throws:

IOException - in case the connect fails or a network failure occurs.

connect

protected Socket connect(com.ning.http.client.RequestBuilder r,
             List<Transport> transports,
             long timeout,
             TimeUnit tu)
                  throws IOException

Throws:

IOException

addFunction

protected void addFunction(long timeout,
               TimeUnit tu)

close

public void close()

Close this Socket, asynchronously.

Specified by:

close in interface Socket

closeRuntime

protected void closeRuntime(boolean async)

status

public Socket.STATUS status()

Description copied from interface: Socket

Return the Socket.STATUS of this Socket.

Specified by:

status in interface Socket

internalSocket

protected SocketRuntime internalSocket()

getTransport

protected List<Transport> getTransport(com.ning.http.client.RequestBuilder r,
                           Request request)
                                throws IOException

Throws:

IOException

request

protected Request request()

createRuntime

public SocketRuntime createRuntime(DefaultFuture future,
                          Options options,
                          List<FunctionWrapper> functions)