org.granite.client.messaging.channel

Interface MessagingChannel

All Superinterfaces:

Channel, ChannelStatusNotifier, SessionAwareChannel

All Known Implementing Classes:

BaseAMFMessagingChannel

public interface MessagingChannel
extends Channel, SessionAwareChannel

SPI for messaging channels A messaging channel adds some functionality to channel, mostly consumer management

Author:

Franck WOLFF

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MessagingChannel.ChannelResponseListener

Field Summary

Fields inherited from interface org.granite.client.messaging.channel.Channel

BYTEARRAY_BODY_HEADER, DEFAULT_TIME_TO_LIVE, RECONNECT_INTERVAL_MS_KEY, RECONNECT_MAX_ATTEMPTS_KEY

Method Summary

Methods

Modifier and Type	Method and Description
void	addConsumer(Consumer consumer) Register a consumer for this channel
void	addListener(MessagingChannel.ChannelResponseListener listener) Register a listener which will be notified of messages occuring on the channel
ResponseMessageFuture	disconnect(ResponseListener... listeners) Disconnect the channel
boolean	removeConsumer(Consumer consumer) Unregister a consumer for this channel
void	removeListener(MessagingChannel.ChannelResponseListener listener) Unregister a listener which will be notified of messages occuring on the channel
void	setSessionId(java.lang.String sessionId) Set the current session id Necessary to synchronize session ids between remoting and messaging channels, usually the remoting channel acts as the master channel which handles authentication and session management and propagated it to other messaging channels

Methods inherited from interface org.granite.client.messaging.channel.Channel

addListener, bindStatus, getClientId, getCredentials, getDefaultTimeToLive, getId, getTransport, getTransportData, getUri, isAuthenticated, isStarted, logout, logout, onCancelled, onDisconnect, onError, onMessage, removeListener, send, setCredentials, setDefaultTimeToLive, setTransportData, start, stop, unbindStatus

Method Detail

setSessionId

void setSessionId(java.lang.String sessionId)

Set the current session id Necessary to synchronize session ids between remoting and messaging channels, usually the remoting channel acts as the master channel which handles authentication and session management and propagated it to other messaging channels

Specified by:

setSessionId in interface SessionAwareChannel

Parameters:

sessionId - session id

addConsumer

void addConsumer(Consumer consumer)

Register a consumer for this channel

Parameters:

consumer - consumer

See Also:

Consumer

removeConsumer

boolean removeConsumer(Consumer consumer)

Unregister a consumer for this channel

Parameters:

consumer - consumer

Returns:

true if the consumer was registered before the method was called

See Also:

Consumer

disconnect

ResponseMessageFuture disconnect(ResponseListener... listeners)

Disconnect the channel

Parameters:

listeners - array of listener to notify when the channel is disconnected

Returns:

future that will be triggered when the channel is disconnected

addListener

void addListener(MessagingChannel.ChannelResponseListener listener)

Register a listener which will be notified of messages occuring on the channel

Parameters:

listener - listener

removeListener

void removeListener(MessagingChannel.ChannelResponseListener listener)

Unregister a listener which will be notified of messages occuring on the channel

Parameters:

listener - listener