org.hornetq.core.protocol.core

Interface Channel

All Known Implementing Classes:

ChannelImpl

public interface Channel

A channel is a way of interleaving data meant for different endpoints over the same CoreRemotingConnection.

Any packet sent will have its channel id set to the specific channel sending so it can be routed to its correct channel when received by the CoreRemotingConnection. see Packet.setChannelID(long).

Each Channel should will forward any packets received to its ChannelHandler.

A Channel *does not* support concurrent access by more than one thread!

Author:

Tim Fox

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCommands() clears any commands from the cache that are yet to be confirmed.
void	close() closes this channel.
void	confirm(Packet packet) sends a confirmation of a packet being received.
void	flushConfirmations() flushes any confirmations on to the connection.
int	getConfirmationWindowSize() returns the confirmation window size this channel is using.
CoreRemotingConnection	getConnection() returns the Remoting Connection being used by the channel
long	getID() returns the id of this channel.
int	getLastConfirmedCommandID() returns the last confirmed packet command id
Lock	getLock() returns the channel lock
void	handlePacket(Packet packet) Called by CoreRemotingConnection when a packet is received.
void	lock() locks the channel.
void	replayCommands(int lastConfirmedCommandID) resends any packets that have not received confirmations yet.
void	returnBlocking() forces any sendBlocking(Packet) request to return with an exception.
void	send(Packet packet) sends a packet on this channel.
void	sendAndFlush(Packet packet) sends a packet on this channel and then blocks until it has been written to the connection.
void	sendBatched(Packet packet) sends a packet on this channel using batching algorithm if appropriate
Packet	sendBlocking(Packet packet) sends a packet on this channel and then blocks until a response is received or a timeout occurs.
void	setCommandConfirmationHandler(CommandConfirmationHandler handler) sets the handler to use when a confirmation is received.
void	setHandler(ChannelHandler handler) sets the ChannelHandler that this channel should forward received packets to.
void	setTransferring(boolean transferring) notifies the channel if it is transferring its connection.
boolean	supports(byte packetID) For protocol check
void	transferConnection(CoreRemotingConnection newConnection) transfers the connection used by this channel to the one specified.
void	unlock() unlocks the channel.

Method Detail

getID

long getID()

returns the id of this channel.

Returns:

the id

supports

boolean supports(byte packetID)

For protocol check

send

void send(Packet packet)

sends a packet on this channel.

Parameters:

packet - the packet to send

sendBatched

void sendBatched(Packet packet)

sends a packet on this channel using batching algorithm if appropriate

Parameters:

packet - the packet to send

sendAndFlush

void sendAndFlush(Packet packet)

sends a packet on this channel and then blocks until it has been written to the connection.

Parameters:

packet - the packet to send

sendBlocking

Packet sendBlocking(Packet packet)
                    throws HornetQException

sends a packet on this channel and then blocks until a response is received or a timeout occurs.

Parameters:

packet - the packet to send

Returns:

the response

Throws:

HornetQException - if an error occurs during the send

setHandler

void setHandler(ChannelHandler handler)

sets the ChannelHandler that this channel should forward received packets to.

Parameters:

handler - the handler

close

void close()

closes this channel.

once closed no packets can be sent.

transferConnection

void transferConnection(CoreRemotingConnection newConnection)

transfers the connection used by this channel to the one specified.

All new packets will be sent via this connection.

Parameters:

newConnection - the new connection

replayCommands

void replayCommands(int lastConfirmedCommandID)

resends any packets that have not received confirmations yet.

Typically called after a connection has been transferred.

Parameters:

lastConfirmedCommandID - the last confirmed packet

getLastConfirmedCommandID

int getLastConfirmedCommandID()

returns the last confirmed packet command id

Returns:

the id

lock

void lock()

locks the channel.

While locked no packets can be sent or received

unlock

void unlock()

unlocks the channel.

returnBlocking

void returnBlocking()

forces any sendBlocking(Packet) request to return with an exception.

getLock

Lock getLock()

returns the channel lock

Returns:

the lock

getConnection

CoreRemotingConnection getConnection()

returns the Remoting Connection being used by the channel

confirm

void confirm(Packet packet)

sends a confirmation of a packet being received.

Parameters:

packet - the packet to confirm

setCommandConfirmationHandler

void setCommandConfirmationHandler(CommandConfirmationHandler handler)

sets the handler to use when a confirmation is received.

Parameters:

handler - the handler to call

flushConfirmations

void flushConfirmations()

flushes any confirmations on to the connection.

handlePacket

void handlePacket(Packet packet)

Called by CoreRemotingConnection when a packet is received.

This method should then call its ChannelHandler after appropriate processing of the packet

Parameters:

packet - the packet to process.

clearCommands

void clearCommands()

clears any commands from the cache that are yet to be confirmed.

getConfirmationWindowSize

int getConfirmationWindowSize()

returns the confirmation window size this channel is using.

Returns:

the window size

setTransferring

void setTransferring(boolean transferring)

notifies the channel if it is transferring its connection. When true it is illegal to send messages.

Parameters:

transferring - whether the channel is transferring