org.granite.gravity

Interface Channel

All Known Implementing Classes:

AbstractChannel, AbstractWebSocketChannel, AsyncChannel, ContinuationChannel, ContinuationChannel, GAEChannel, GenericChannel, GlassFishWebSocketChannel, JBossWebChannel, JettyWebSocketChannel, JettyWebSocketChannel, TomcatChannel, TomcatWebSocketChannel, WebLogicChannel, WebSocketChannel

public interface Channel

Author:

Franck WOLFF

Method Summary

Methods

Modifier and Type	Method and Description
Subscription	addSubscription(java.lang.String destination, java.lang.String subTopicId, java.lang.String subscriptionId, boolean noLocal)
void	close()
void	destroy(boolean timeout)
java.lang.String	getClientType()
ChannelFactory<?>	getFactory()
GravityInternal	getGravity()
java.lang.String	getId()
java.util.Collection<Subscription>	getSubscriptions()
java.security.Principal	getUserPrincipal()
boolean	hasPublishedMessage()
boolean	hasReceivedMessage()
boolean	isAuthenticated()
boolean	isConnected()
void	publish(AsyncPublishedMessage message)
void	receive(AsyncMessage message)
Subscription	removeSubscription(java.lang.String subscriptionId)
boolean	runPublish()
boolean	runReceive()
boolean	runReceived(AsyncHttpContext asyncHttpContext)
void	setUserPrincipal(java.security.Principal principal)

Method Detail

getId

java.lang.String getId()

getClientType

java.lang.String getClientType()

isAuthenticated

boolean isAuthenticated()

isConnected

boolean isConnected()

getUserPrincipal

java.security.Principal getUserPrincipal()

setUserPrincipal

void setUserPrincipal(java.security.Principal principal)

getGravity

GravityInternal getGravity()

getFactory

ChannelFactory<?> getFactory()

addSubscription

Subscription addSubscription(java.lang.String destination,
                           java.lang.String subTopicId,
                           java.lang.String subscriptionId,
                           boolean noLocal)

getSubscriptions

java.util.Collection<Subscription> getSubscriptions()

removeSubscription

Subscription removeSubscription(java.lang.String subscriptionId)

publish

void publish(AsyncPublishedMessage message)
             throws MessagePublishingException

Throws:

MessagePublishingException

hasPublishedMessage

boolean hasPublishedMessage()

runPublish

boolean runPublish()

receive

void receive(AsyncMessage message)
             throws MessageReceivingException

Throws:

MessageReceivingException

hasReceivedMessage

boolean hasReceivedMessage()

runReceive

boolean runReceive()

runReceived

boolean runReceived(AsyncHttpContext asyncHttpContext)

close

void close()

destroy

void destroy(boolean timeout)