org.granite.gravity.websocket

Class AbstractWebSocketChannel

java.lang.Object

org.granite.gravity.AbstractChannel

org.granite.gravity.websocket.AbstractWebSocketChannel

All Implemented Interfaces:

Channel

Direct Known Subclasses:

GlassFishWebSocketChannel, JettyWebSocketChannel, JettyWebSocketChannel, TomcatWebSocketChannel, WebSocketChannel

public abstract class AbstractWebSocketChannel
extends AbstractChannel

Author:

Franck WOLFF

Field Summary

Fields inherited from class org.granite.gravity.AbstractChannel

clientType, factory, gravity, id, publishedQueue, publishedQueueLock, publisher, receivedQueue, receivedQueueLock, receiver, sessionId, subscriptions, udpReceiver, userPrincipal

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractWebSocketChannel(GravityInternal gravity, java.lang.String id, ChannelFactory<? extends Channel> factory, java.lang.String clientType)

Method Summary

Methods

Modifier and Type	Method and Description
protected AsyncHttpContext	acquireAsyncHttpContext()
protected static void	cleanupRequest()
protected void	connect()
protected Message[]	deserialize(GravityInternal gravity, byte[] data, int offset, int length)
void	destroy(boolean timeout)
ContentType	getContentType()
int	getMaxBinaryMessageBufferSize()
protected boolean	hasAsyncHttpContext()
protected GravityInternal	initializeRequest()
abstract boolean	isConnected()
protected void	receiveBytes(byte[] data, int offset, int length)
protected void	releaseAsyncHttpContext(AsyncHttpContext context)
boolean	runReceived(AsyncHttpContext asyncHttpContext)
protected abstract void	sendBytes(byte[] msg)
protected byte[]	serialize(GravityInternal gravity, Message[] messages)
void	setConnectAckMessage(Message ackMessage)
void	setContentType(ContentType contentType)
protected void	setMaxBinaryMessageBufferSize(int maxBinaryMessageBufferSize)
void	setSession(javax.servlet.http.HttpSession session)

Methods inherited from class org.granite.gravity.AbstractChannel

addSubscription, createUdpReceiver, destroy, equals, getClientType, getFactory, getGravity, getId, getSubscriptions, getUserPrincipal, hashCode, hasPublishedMessage, hasReceivedMessage, isAuthenticated, publish, queueReceiver, receive, removeSubscription, runPublish, runReceive, setUserPrincipal, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.granite.gravity.Channel

close

Constructor Detail

AbstractWebSocketChannel

protected AbstractWebSocketChannel(GravityInternal gravity,
                        java.lang.String id,
                        ChannelFactory<? extends Channel> factory,
                        java.lang.String clientType)

Method Detail

setMaxBinaryMessageBufferSize

protected void setMaxBinaryMessageBufferSize(int maxBinaryMessageBufferSize)

getMaxBinaryMessageBufferSize

public int getMaxBinaryMessageBufferSize()

setSession

public void setSession(javax.servlet.http.HttpSession session)

setConnectAckMessage

public void setConnectAckMessage(Message ackMessage)

connect

protected void connect()

getContentType

public ContentType getContentType()

setContentType

public void setContentType(ContentType contentType)

initializeRequest

protected GravityInternal initializeRequest()

deserialize

protected Message[] deserialize(GravityInternal gravity,
                    byte[] data,
                    int offset,
                    int length)
                         throws java.lang.ClassNotFoundException,
                                java.io.IOException

Throws:

java.lang.ClassNotFoundException

java.io.IOException

serialize

protected byte[] serialize(GravityInternal gravity,
               Message[] messages)
                    throws java.io.IOException

Throws:

java.io.IOException

cleanupRequest

protected static void cleanupRequest()

isConnected

public abstract boolean isConnected()

Specified by:

isConnected in interface Channel

Overrides:

isConnected in class AbstractChannel

sendBytes

protected abstract void sendBytes(byte[] msg)
                           throws java.io.IOException

Throws:

java.io.IOException

receiveBytes

protected void receiveBytes(byte[] data,
                int offset,
                int length)

runReceived

public boolean runReceived(AsyncHttpContext asyncHttpContext)

Specified by:

runReceived in interface Channel

Overrides:

runReceived in class AbstractChannel

destroy

public void destroy(boolean timeout)

Specified by:

destroy in interface Channel

Overrides:

destroy in class AbstractChannel

hasAsyncHttpContext

protected boolean hasAsyncHttpContext()

Specified by:

hasAsyncHttpContext in class AbstractChannel

releaseAsyncHttpContext

protected void releaseAsyncHttpContext(AsyncHttpContext context)

Specified by:

releaseAsyncHttpContext in class AbstractChannel

acquireAsyncHttpContext

protected AsyncHttpContext acquireAsyncHttpContext()

Specified by:

acquireAsyncHttpContext in class AbstractChannel