MessageDispatchInterceptor (Apache Tomcat 8.0.53 API Documentation)

java.lang.Object
- org.apache.catalina.tribes.group.ChannelInterceptorBase
- - org.apache.catalina.tribes.group.interceptors.MessageDispatchInterceptor

All Implemented Interfaces:

java.lang.Runnable, ChannelInterceptor, Heartbeat, MembershipListener

Direct Known Subclasses:

MessageDispatch15Interceptor
```
public class MessageDispatchInterceptor
extends ChannelInterceptorBase
implements java.lang.Runnable
```
The message dispatcher is a way to enable asynchronous communication through a channel. The dispatcher will look for the Channel.SEND_OPTIONS_ASYNCHRONOUS flag to be set, if it is, it will queue the message for delivery and immediately return to the sender.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.catalina.tribes.ChannelInterceptor
  ChannelInterceptor.InterceptorEvent

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`alwaysSend`
`protected java.util.concurrent.atomic.AtomicLong`	`currentSize`
`protected java.util.concurrent.ExecutorService`	`executor`
`protected long`	`keepAliveTime`
`protected long`	`maxQueueSize`
`protected int`	`maxSpareThreads`
`protected int`	`maxThreads`
`protected java.lang.Thread`	`msgDispatchThread` Deprecated. Unused. Will be removed in Tomcat 8.5.x.
`protected FastQueue`	`queue` Deprecated. Unused. Will be removed in Tomcat 8.5.x.
`protected boolean`	`run`
`protected static StringManager`	`sm`
`protected boolean`	`useDeepClone`

Fields inherited from class org.apache.catalina.tribes.group.ChannelInterceptorBase
optionFlag

Constructor Summary

Constructors
Constructor and Description

MessageDispatchInterceptor()

Constructors
Constructor and Description
`MessageDispatchInterceptor()`

Method Summary

Methods
Modifier and Type	Method and Description
`long`	`addAndGetCurrentSize(long inc)`
`boolean`	`addToQueue(ChannelMessage msg, Member[] destination, InterceptorPayload payload)`
`long`	`getCurrentSize()`
`long`	`getKeepAliveTime()`
`long`	`getMaxQueueSize()`
`int`	`getMaxSpareThreads()`
`int`	`getMaxThreads()`
`boolean`	`getUseDeepClone()`
`boolean`	`isAlwaysSend()`
`LinkObject`	`removeFromQueue()` Deprecated. Not used. The thread pool contains its own queue. This will be removed in Tomcat 8.5.x onwards.
`void`	`run()` Deprecated. Unused. Will be removed in 8.5.x
`protected void`	`sendAsyncData(ChannelMessage msg, Member[] destination, InterceptorPayload payload)`
`protected LinkObject`	`sendAsyncData(LinkObject link)` Deprecated. Unused. Will be removed in 8.5.x
`void`	`sendMessage(Member[] destination, ChannelMessage msg, InterceptorPayload payload)` The `sendMessage` method is called when a message is being sent to one more destinations.
`void`	`setAlwaysSend(boolean alwaysSend)`
`long`	`setAndGetCurrentSize(long value)`
`void`	`setKeepAliveTime(long keepAliveTime)`
`void`	`setMaxQueueSize(long maxQueueSize)`
`void`	`setMaxSpareThreads(int maxSpareThreads)`
`void`	`setMaxThreads(int maxThreads)`
`void`	`setOptionFlag(int flag)` Sets the option flag
`void`	`setUseDeepClone(boolean useDeepClone)`
`void`	`start(int svc)` Starts up the channel.
`void`	`startQueue()`
`void`	`stop(int svc)` Shuts down the channel.
`void`	`stopQueue()`

Methods inherited from class org.apache.catalina.tribes.group.ChannelInterceptorBase
fireInterceptorEvent, getChannel, getLocalMember, getMember, getMembers, getNext, getOptionFlag, getPrevious, hasMembers, heartbeat, memberAdded, memberDisappeared, messageReceived, okToProcess, setChannel, setNext, setPrevious

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - sm
```
protected static final StringManager sm
```
  - maxQueueSize
```
protected long maxQueueSize
```
  - queue
```
@Deprecated
protected final FastQueue queue
```
    Deprecated. Unused. Will be removed in Tomcat 8.5.x.
  - run
```
protected volatile boolean run
```
  - msgDispatchThread
```
@Deprecated
protected java.lang.Thread msgDispatchThread
```
    Deprecated. Unused. Will be removed in Tomcat 8.5.x.
  - useDeepClone
```
protected boolean useDeepClone
```
  - alwaysSend
```
protected boolean alwaysSend
```
  - currentSize
```
protected final java.util.concurrent.atomic.AtomicLong currentSize
```
  - executor
```
protected java.util.concurrent.ExecutorService executor
```
  - maxThreads
```
protected int maxThreads
```
  - maxSpareThreads
```
protected int maxSpareThreads
```
  - keepAliveTime
```
protected long keepAliveTime
```
- Constructor Detail
  - MessageDispatchInterceptor
```
public MessageDispatchInterceptor()
```
- Method Detail
  - sendMessage
```
public void sendMessage(Member[] destination,
               ChannelMessage msg,
               InterceptorPayload payload)
                 throws ChannelException
```
    Description copied from interface: ChannelInterceptor
    
    The sendMessage method is called when a message is being sent to one more destinations. The interceptor can modify any of the parameters and then pass on the message down the stack by invoking getNext().sendMessage(destination,msg,payload)
    Alternatively the interceptor can stop the message from being sent by not invoking getNext().sendMessage(destination,msg,payload)
    If the message is to be sent asynchronous the application can be notified of completion and errors by passing in an error handler attached to a payload object.
    The ChannelMessage.getAddress contains Channel.getLocalMember, and can be overwritten to simulate a message sent from another node.
    
    Specified by:
    
    sendMessage in interface ChannelInterceptor
    
    Overrides:
    
    sendMessage in class ChannelInterceptorBase
    
    Parameters:
    destination - Member[] - the destination for this message
    msg - ChannelMessage - the message to be sent
    payload - InterceptorPayload - the payload, carrying an error handler and future useful data, can be null
    
    Throws:
    
    ChannelException
    See Also:
    ErrorHandler, InterceptorPayload
  - addToQueue
```
public boolean addToQueue(ChannelMessage msg,
                 Member[] destination,
                 InterceptorPayload payload)
```
  - removeFromQueue
```
@Deprecated
public LinkObject removeFromQueue()
```
    Deprecated. Not used. The thread pool contains its own queue. This will be removed in Tomcat 8.5.x onwards.
    
    Returns:
    Always null
  - startQueue
```
public void startQueue()
```
  - stopQueue
```
public void stopQueue()
```
  - setOptionFlag
```
public void setOptionFlag(int flag)
```
    Description copied from interface: ChannelInterceptor
    
    Sets the option flag
    
    Specified by:
    
    setOptionFlag in interface ChannelInterceptor
    
    Overrides:
    
    setOptionFlag in class ChannelInterceptorBase
    
    Parameters:
    flag - int
    See Also:
    ChannelInterceptor.getOptionFlag()
  - setMaxQueueSize
```
public void setMaxQueueSize(long maxQueueSize)
```
  - setUseDeepClone
```
public void setUseDeepClone(boolean useDeepClone)
```
  - getMaxQueueSize
```
public long getMaxQueueSize()
```
  - getUseDeepClone
```
public boolean getUseDeepClone()
```
  - getCurrentSize
```
public long getCurrentSize()
```
  - addAndGetCurrentSize
```
public long addAndGetCurrentSize(long inc)
```
  - setAndGetCurrentSize
```
public long setAndGetCurrentSize(long value)
```
  - getKeepAliveTime
```
public long getKeepAliveTime()
```
  - getMaxSpareThreads
```
public int getMaxSpareThreads()
```
  - getMaxThreads
```
public int getMaxThreads()
```
  - setKeepAliveTime
```
public void setKeepAliveTime(long keepAliveTime)
```
  - setMaxSpareThreads
```
public void setMaxSpareThreads(int maxSpareThreads)
```
  - setMaxThreads
```
public void setMaxThreads(int maxThreads)
```
  - isAlwaysSend
```
public boolean isAlwaysSend()
```
  - setAlwaysSend
```
public void setAlwaysSend(boolean alwaysSend)
```
  - start
```
public void start(int svc)
           throws ChannelException
```
    Description copied from class: ChannelInterceptorBase
    
    Starts up the channel. This can be called multiple times for individual services to start The svc parameter can be the logical or value of any constants
    
    Specified by:
    
    start in interface ChannelInterceptor
    
    Overrides:
    
    start in class ChannelInterceptorBase
    
    Parameters:
    svc - int value of
    DEFAULT - will start all services
    MBR_RX_SEQ - starts the membership receiver
    MBR_TX_SEQ - starts the membership broadcaster
    SND_TX_SEQ - starts the replication transmitter
    SND_RX_SEQ - starts the replication receiver
    
    Throws:
    
    ChannelException - if a startup error occurs or the service is already started.
    See Also:
    Channel
  - stop
```
public void stop(int svc)
          throws ChannelException
```
    Description copied from class: ChannelInterceptorBase
    
    Shuts down the channel. This can be called multiple times for individual services to shutdown The svc parameter can be the logical or value of any constants
    
    Specified by:
    
    stop in interface ChannelInterceptor
    
    Overrides:
    
    stop in class ChannelInterceptorBase
    
    Parameters:
    svc - int value of
    DEFAULT - will shutdown all services
    MBR_RX_SEQ - stops the membership receiver
    MBR_TX_SEQ - stops the membership broadcaster
    SND_TX_SEQ - stops the replication transmitter
    SND_RX_SEQ - stops the replication receiver
    
    Throws:
    
    ChannelException - if a startup error occurs or the service is already started.
    See Also:
    Channel
  - run
```
@Deprecated
public void run()
```
    Deprecated. Unused. Will be removed in 8.5.x
    
    Specified by:
    
    run in interface java.lang.Runnable
  - sendAsyncData
```
@Deprecated
protected LinkObject sendAsyncData(LinkObject link)
```
    Deprecated. Unused. Will be removed in 8.5.x
  - sendAsyncData
```
protected void sendAsyncData(ChannelMessage msg,
                 Member[] destination,
                 InterceptorPayload payload)
```

Class MessageDispatchInterceptor

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.catalina.tribes.ChannelInterceptor

Field Summary

Fields inherited from class org.apache.catalina.tribes.group.ChannelInterceptorBase

Constructor Summary

Method Summary

Methods inherited from class org.apache.catalina.tribes.group.ChannelInterceptorBase

Methods inherited from class java.lang.Object

Field Detail

sm

maxQueueSize

queue

run

msgDispatchThread

useDeepClone

alwaysSend

currentSize

executor

maxThreads

maxSpareThreads

keepAliveTime

Constructor Detail

MessageDispatchInterceptor

Method Detail

sendMessage

addToQueue

removeFromQueue

startQueue

stopQueue

setOptionFlag

setMaxQueueSize

setUseDeepClone

getMaxQueueSize

getUseDeepClone

getCurrentSize

addAndGetCurrentSize

setAndGetCurrentSize

getKeepAliveTime

getMaxSpareThreads

getMaxThreads

setKeepAliveTime

setMaxSpareThreads

setMaxThreads

isAlwaysSend

setAlwaysSend

start

stop

run

sendAsyncData

sendAsyncData