org.apache.catalina.tribes

Interface ChannelSender

public interface ChannelSender extends Heartbeat

ChannelReceiver Interface
The ChannelSender interface is the data sender component at the bottom layer, the IO layer (for layers see the javadoc for the Channel interface).
The channel sender must support "silent" members, ie, be able to send a message to a member that is not in the membership, but is part of the destination parameter

Version: $Revision: 467222 $, $Date: 2006-10-24 05:17:11 +0200 (Tue, 24 Oct 2006) $

Author: Filip Hanik

Method Summary
voidadd(Member member)
Notify the sender of a member being added to the group.
Optional.
voidheartbeat()
A channel heartbeat, use this method to clean up resources
voidremove(Member member)
Notification that a member has been removed or crashed.
voidsendMessage(ChannelMessage message, Member[] destination)
Send a message to one or more recipients.
voidstart()
Start the channel sender
voidstop()
Stop the channel sender

Method Detail

add

public void add(Member member)
Notify the sender of a member being added to the group.
Optional. This can be an empty implementation, that does nothing

Parameters: member Member

heartbeat

public void heartbeat()
A channel heartbeat, use this method to clean up resources

remove

public void remove(Member member)
Notification that a member has been removed or crashed. Can be used to clean up open connections etc

Parameters: member Member

sendMessage

public void sendMessage(ChannelMessage message, Member[] destination)
Send a message to one or more recipients.

Parameters: message ChannelMessage - the message to be sent destination Member[] - the destinations

Throws: ChannelException - if an error happens, the ChannelSender MUST report individual send failures on a per member basis, using ChannelException.addFaultyMember

See Also: ChannelException

start

public void start()
Start the channel sender

Throws: IOException if preprocessing takes place and an error happens

stop

public void stop()
Stop the channel sender
Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.