Package org.apache.catalina.tribes
Interface ChannelReceiver
- All Superinterfaces:
- Heartbeat
- All Known Implementing Classes:
- NioReceiver,- ReceiverBase
ChannelReceiver Interface
The
The
ChannelReceiver interface is the data receiver component
 at the bottom layer, the IO layer (for layers see the javadoc for the Channel interface).
 This class may optionally implement a thread pool for parallel processing of incoming messages.- 
Field SummaryFields
- 
Method SummaryModifier and TypeMethodDescriptionReturn the channel that is related to this ChannelReceivergetHost()String representation of the IPv4 or IPv6 address that this host is listening to.Returns the message listener that is associated with this receiverintgetPort()Returns the listening portintReturns the secure listening portintReturns the UDP portvoidsetChannel(Channel channel) Set the channel that is related to this ChannelReceivervoidsetMessageListener(MessageListener listener) Sets the message listener to receive notification of incomingvoidstart()Start listening for incoming messages on the host/portvoidstop()Stop listening for messages
- 
Field Details- 
MAX_UDP_SIZEstatic final int MAX_UDP_SIZE- See Also:
 
 
- 
- 
Method Details- 
startStart listening for incoming messages on the host/port- Throws:
- IOException- Listen failed
 
- 
stopvoid stop()Stop listening for messages
- 
getHostString getHost()String representation of the IPv4 or IPv6 address that this host is listening to.- Returns:
- the host that this receiver is listening to
 
- 
getPortint getPort()Returns the listening port- Returns:
- port
 
- 
getSecurePortint getSecurePort()Returns the secure listening port- Returns:
- port, -1 if a secure port is not activated
 
- 
getUdpPortint getUdpPort()Returns the UDP port- Returns:
- port, -1 if the UDP port is not activated.
 
- 
setMessageListenerSets the message listener to receive notification of incoming- Parameters:
- listener- MessageListener
- See Also:
 
- 
getMessageListenerMessageListener getMessageListener()Returns the message listener that is associated with this receiver- Returns:
- MessageListener
- See Also:
 
- 
getChannelChannel getChannel()Return the channel that is related to this ChannelReceiver- Returns:
- Channel
 
- 
setChannelSet the channel that is related to this ChannelReceiver- Parameters:
- channel- The channel
 
 
-