ChannelReceiver (Apache Tomcat 8.0.15 API Documentation)

Apache Tomcat 8.0.15

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

Heartbeat

All Known Implementing Classes:

BioReceiver, NioReceiver, ReceiverBase
```
public interface ChannelReceiver
extends Heartbeat
```
ChannelReceiver Interface
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 Summary

Fields
Modifier and Type Field and Description

static int MAX_UDP_SIZE

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getHost()` String representation of the IPv4 or IPv6 address that this host is listening to.
`MessageListener`	`getMessageListener()` Returns the message listener that is associated with this receiver
`int`	`getPort()` Returns the listening port
`int`	`getSecurePort()` Returns the secure listening port
`int`	`getUdpPort()` Returns the UDP port
`void`	`setMessageListener(MessageListener listener)` Sets the message listener to receive notification of incoming
`void`	`start()` Start listening for incoming messages on the host/port
`void`	`stop()` Stop listening for messages

Methods inherited from interface org.apache.catalina.tribes.Heartbeat
heartbeat

- Field Detail
  - MAX_UDP_SIZE
```
static final int MAX_UDP_SIZE
```
    See Also:
    Constant Field Values
- Method Detail
  - start
```
void start()
           throws IOException
```
    Start listening for incoming messages on the host/port
    
    Throws:
    
    IOException
  - stop
```
void stop()
```
    Stop listening for messages
  - getHost
```
String getHost()
```
    String representation of the IPv4 or IPv6 address that this host is listening to.
    
    Returns:
    the host that this receiver is listening to
  - getPort
```
int getPort()
```
    Returns the listening port
    
    Returns:
    port
  - getSecurePort
```
int getSecurePort()
```
    Returns the secure listening port
    
    Returns:
    port, -1 if a secure port is not activated
  - getUdpPort
```
int getUdpPort()
```
    Returns the UDP port
    
    Returns:
    port, -1 if the UDP port is not activated.
  - setMessageListener
```
void setMessageListener(MessageListener listener)
```
    Sets the message listener to receive notification of incoming
    
    Parameters:
    listener - MessageListener
    See Also:
    MessageListener
  - getMessageListener
```
MessageListener getMessageListener()
```
    Returns the message listener that is associated with this receiver
    
    Returns:
    MessageListener
    See Also:
    MessageListener

Apache Tomcat 8.0.15

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.