org.atmosphere.websocket
Interface WebSocket

All Superinterfaces:

AsyncIOWriter

All Known Implementing Classes:

GrizzlyWebSocket, Jetty8WebSocket, JettyWebSocket, WebSocketAdapter

public interface WebSocket
extends AsyncIOWriter

Represent a portable WebSocket implementation which can be used to write message.

Author:

Jeanfrancois Arcand

Field Summary

static String	WEBSOCKET_INITIATED
static String	WEBSOCKET_RESUME
static String	WEBSOCKET_SUSPEND

Method Summary

void	close() Close the underlying WebSocket connection
AtmosphereResource<?,?>	resource() Return the current AtmosphereResource representing the underlying connection and the original HttpServletRequest

Methods inherited from interface org.atmosphere.cpr.AsyncIOWriter

redirect, write, write, write, writeError

Field Detail

WEBSOCKET_INITIATED

static final String WEBSOCKET_INITIATED

WEBSOCKET_SUSPEND

static final String WEBSOCKET_SUSPEND

WEBSOCKET_RESUME

static final String WEBSOCKET_RESUME

Method Detail

close

void close()
           throws IOException

Close the underlying WebSocket connection

Throws:

IOException

resource

AtmosphereResource<?,?> resource()

Return the current AtmosphereResource representing the underlying connection and the original HttpServletRequest

Returns:

the current AtmosphereResource