SCOPE

java.lang.Object
- com.fr.third.jgroups.stack.Protocol
- - com.fr.third.jgroups.protocols.SCOPE

已过时。
Use the async invocation API instead: http://www.jgroups.org/manual-3.x/html/user-building-blocks.html#AsyncInvocation
```
@Deprecated
public class SCOPE
extends Protocol
```
Implements https://jira.jboss.org/jira/browse/JGRP-822, which allows for concurrent delivery of messages from the same sender based on scopes. Similar to using OOB messages, but messages within the same scope are ordered.

从以下版本开始:

2.10

作者:

Bela Ban

嵌套类概要

嵌套类
限定符和类型	类和说明
`protected class`	`SCOPE.ExpiryTask` 已过时。
`protected static class`	`SCOPE.MessageQueue` 已过时。
`protected class`	`SCOPE.QueueThread` 已过时。
`static class`	`SCOPE.ScopeHeader` 已过时。

字段概要

字段
限定符和类型	字段和说明
`protected java.lang.String`	`cluster_name` 已过时。
`protected long`	`expiration_interval` 已过时。
`protected long`	`expiration_time` 已过时。
`protected java.util.concurrent.Future<?>`	`expiry_task` 已过时。
`protected Address`	`local_addr` 已过时。
`protected java.util.concurrent.ConcurrentMap<Address,java.util.concurrent.ConcurrentMap<java.lang.Short,SCOPE.MessageQueue>>`	`queues` 已过时。 Used to find the correct AckReceiverWindow on message reception and deliver it in the right order
`protected ThreadFactory`	`thread_factory` 已过时。
`protected java.lang.String`	`thread_naming_pattern` 已过时。
`protected java.util.concurrent.Executor`	`thread_pool` 已过时。
`protected long`	`thread_pool_keep_alive_time` 已过时。
`protected int`	`thread_pool_max_threads` 已过时。
`protected int`	`thread_pool_min_threads` 已过时。
`protected TimeScheduler`	`timer` 已过时。

从类继承的字段 com.fr.third.jgroups.stack.Protocol
down_prot, ergonomics, id, log, name, stack, stats, up_prot

构造器概要

构造器
构造器和说明

SCOPE()
已过时。

构造器
构造器和说明
`SCOPE()` 已过时。

方法概要

方法
限定符和类型	方法和说明
`void`	`clearQueue(Address member)` 已过时。
`protected static java.util.concurrent.ExecutorService`	`createThreadPool(int min_threads, int max_threads, long keep_alive_time, ThreadFactory factory)` 已过时。
`java.lang.Object`	`down(Event evt)` 已过时。 An event is to be sent down the stack.
`java.lang.String`	`dumpScopes()` 已过时。
`void`	`expire(short scope)` 已过时。 Multicasts an EXPIRE message to all members, and - on reception - each member removes the scope locally
`int`	`getNumActiveThreads()` 已过时。
`int`	`getNumberOfMessages()` 已过时。
`int`	`getNumberOfReceiverScopes()` 已过时。
`protected SCOPE.MessageQueue`	`getOrCreateQueue(Address sender, short scope)` 已过时。
`long`	`getThreadPoolKeepAliveTime()` 已过时。
`int`	`getThreadPoolMaxThreads()` 已过时。
`int`	`getThreadPoolMinThreads()` 已过时。
`void`	`init()` 已过时。 Called after instance has been created (null constructor) and before protocol is started.
`void`	`removeAllQueues()` 已过时。
`void`	`removeScope(Address member, short scope)` 已过时。
`void`	`setThreadPoolKeepAliveTime(long time)` 已过时。
`void`	`setThreadPoolMaxThreads(int size)` 已过时。
`void`	`setThreadPoolMinThreads(int size)` 已过时。
`protected static void`	`shutdownThreadPool(java.util.concurrent.Executor thread_pool)` 已过时。
`void`	`start()` 已过时。 This method is called on a `Channel.connect(String)`.
`protected void`	`startExpiryTask()` 已过时。
`void`	`stop()` 已过时。 This method is called on a `Channel.disconnect()`.
`protected void`	`stopExpiryTask()` 已过时。
`java.lang.Object`	`up(Event evt)` 已过时。 An event was received from the layer below.
`void`	`up(MessageBatch batch)` 已过时。 Sends up a multiple messages in a `MessageBatch`.

从类继承的方法 com.fr.third.jgroups.stack.Protocol
accept, destroy, dumpStats, enableStats, getConfigurableObjects, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getName, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, isErgonomics, level, parse, printStats, providedDownServices, providedUpServices, requiredDownServices, requiredUpServices, resetStatistics, resetStats, setDownProtocol, setErgonomics, setId, setLevel, setProtocolStack, setSocketFactory, setUpProtocol, setValue, setValues, statsEnabled

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - thread_pool_min_threads
```
protected int thread_pool_min_threads
```
    已过时。
  - thread_pool_max_threads
```
protected int thread_pool_max_threads
```
    已过时。
  - thread_pool_keep_alive_time
```
protected long thread_pool_keep_alive_time
```
    已过时。
  - thread_naming_pattern
```
protected java.lang.String thread_naming_pattern
```
    已过时。
  - expiration_time
```
protected long expiration_time
```
    已过时。
  - expiration_interval
```
protected long expiration_interval
```
    已过时。
  - expiry_task
```
protected java.util.concurrent.Future<?> expiry_task
```
    已过时。
  - queues
```
protected final java.util.concurrent.ConcurrentMap<Address,java.util.concurrent.ConcurrentMap<java.lang.Short,SCOPE.MessageQueue>> queues
```
    已过时。
    
    Used to find the correct AckReceiverWindow on message reception and deliver it in the right order
  - cluster_name
```
protected java.lang.String cluster_name
```
    已过时。
  - local_addr
```
protected Address local_addr
```
    已过时。
  - thread_pool
```
protected java.util.concurrent.Executor thread_pool
```
    已过时。
  - thread_factory
```
protected ThreadFactory thread_factory
```
    已过时。
  - timer
```
protected TimeScheduler timer
```
    已过时。
- 构造器详细资料
  - SCOPE
```
public SCOPE()
```
    已过时。
- 方法详细资料
  - getNumberOfReceiverScopes
```
public int getNumberOfReceiverScopes()
```
    已过时。
  - getNumberOfMessages
```
public int getNumberOfMessages()
```
    已过时。
  - setThreadPoolMinThreads
```
public void setThreadPoolMinThreads(int size)
```
    已过时。
  - getThreadPoolMinThreads
```
public int getThreadPoolMinThreads()
```
    已过时。
  - setThreadPoolMaxThreads
```
public void setThreadPoolMaxThreads(int size)
```
    已过时。
  - getThreadPoolMaxThreads
```
public int getThreadPoolMaxThreads()
```
    已过时。
  - setThreadPoolKeepAliveTime
```
public void setThreadPoolKeepAliveTime(long time)
```
    已过时。
  - getThreadPoolKeepAliveTime
```
public long getThreadPoolKeepAliveTime()
```
    已过时。
  - removeAllQueues
```
public void removeAllQueues()
```
    已过时。
  - expire
```
public void expire(short scope)
```
    已过时。
    
    Multicasts an EXPIRE message to all members, and - on reception - each member removes the scope locally
    
    参数:
    scope -
  - removeScope
```
public void removeScope(Address member,
               short scope)
```
    已过时。
  - dumpScopes
```
public java.lang.String dumpScopes()
```
    已过时。
  - getNumActiveThreads
```
public int getNumActiveThreads()
```
    已过时。
  - init
```
public void init()
          throws java.lang.Exception
```
    已过时。
    
    从类复制的说明: Protocol
    
    Called after instance has been created (null constructor) and before protocol is started. Properties are already set. Other protocols are not yet connected and events cannot yet be sent.
    
    覆盖:
    
    init 在类中 Protocol
    
    抛出:
    
    java.lang.Exception - Thrown if protocol cannot be initialized successfully. This will cause the ProtocolStack to fail, so the channel constructor will throw an exception
  - start
```
public void start()
           throws java.lang.Exception
```
    已过时。
    
    从类复制的说明: Protocol
    
    This method is called on a Channel.connect(String). Starts work. Protocols are connected and queues are ready to receive events. Will be called from bottom to top. This call will replace the START and START_OK events.
    
    覆盖:
    
    start 在类中 Protocol
    
    抛出:
    
    java.lang.Exception - Thrown if protocol cannot be started successfully. This will cause the ProtocolStack to fail, so Channel.connect(String) will throw an exception
  - stop
```
public void stop()
```
    已过时。
    
    从类复制的说明: Protocol
    
    This method is called on a Channel.disconnect(). Stops work (e.g. by closing multicast socket). Will be called from top to bottom. This means that at the time of the method invocation the neighbor protocol below is still working. This method will replace the STOP, STOP_OK, CLEANUP and CLEANUP_OK events. The ProtocolStack guarantees that when this method is called all messages in the down queue will have been flushed
    
    覆盖:
    
    stop 在类中 Protocol
  - down
```
public java.lang.Object down(Event evt)
```
    已过时。
    
    从类复制的说明: Protocol
    
    An event is to be sent down the stack. The layer may want to examine its type and perform some action on it, depending on the event's type. If the event is a message MSG, then the layer may need to add a header to it (or do nothing at all) before sending it down the stack using down_prot.down(). In case of a GET_ADDRESS event (which tries to retrieve the stack's address from one of the bottom layers), the layer may need to send a new response event back up the stack using up_prot.up().
    
    覆盖:
    
    down 在类中 Protocol
  - up
```
public java.lang.Object up(Event evt)
```
    已过时。
    
    从类复制的说明: Protocol
    
    An event was received from the layer below. Usually the current layer will want to examine the event type and - depending on its type - perform some computation (e.g. removing headers from a MSG event type, or updating the internal membership list when receiving a VIEW_CHANGE event). Finally the event is either a) discarded, or b) an event is sent down the stack using down_prot.down() or c) the event (or another event) is sent up the stack using up_prot.up().
    
    覆盖:
    
    up 在类中 Protocol
  - up
```
public void up(MessageBatch batch)
```
    已过时。
    
    从类复制的说明: Protocol
    
    Sends up a multiple messages in a MessageBatch. The sender of the batch is always the same, and so is the destination (null == multicast messages). Messages in a batch can be OOB messages, regular messages, or mixed messages, although the transport itself will create initial MessageBatches that contain only either OOB or regular messages.
    The default processing below sends messages up the stack individually, based on a matching criteria (calling Protocol.accept(Message)), and - if true - calls Protocol.up(Event) for that message and removes the message. If the batch is not empty, it is passed up, or else it is dropped.
    Subclasses should check if there are any messages destined for them (e.g. using MessageBatch.getMatchingMessages(short, boolean)), then possibly remove and process them and finally pass the batch up to the next protocol. Protocols can also modify messages in place, e.g. ENCRYPT could decrypt all encrypted messages in the batch, not remove them, and pass the batch up when done.
    
    覆盖:
    
    up 在类中 Protocol
    
    参数:
    batch - The message batch
  - getOrCreateQueue
```
protected SCOPE.MessageQueue getOrCreateQueue(Address sender,
                                  short scope)
```
    已过时。
  - startExpiryTask
```
protected void startExpiryTask()
```
    已过时。
  - stopExpiryTask
```
protected void stopExpiryTask()
```
    已过时。
  - createThreadPool
```
protected static java.util.concurrent.ExecutorService createThreadPool(int min_threads,
                                                    int max_threads,
                                                    long keep_alive_time,
                                                    ThreadFactory factory)
```
    已过时。
  - shutdownThreadPool
```
protected static void shutdownThreadPool(java.util.concurrent.Executor thread_pool)
```
    已过时。
  - clearQueue
```
public void clearQueue(Address member)
```
    已过时。

类 SCOPE

嵌套类概要

字段概要

从类继承的字段 com.fr.third.jgroups.stack.Protocol

构造器概要

方法概要

从类继承的方法 com.fr.third.jgroups.stack.Protocol

从类继承的方法 java.lang.Object

字段详细资料

thread_pool_min_threads

thread_pool_max_threads

thread_pool_keep_alive_time

thread_naming_pattern

expiration_time

expiration_interval

expiry_task

queues

cluster_name

local_addr

thread_pool

thread_factory

timer

构造器详细资料

SCOPE

方法详细资料

getNumberOfReceiverScopes

getNumberOfMessages

setThreadPoolMinThreads

getThreadPoolMinThreads

setThreadPoolMaxThreads

getThreadPoolMaxThreads

setThreadPoolKeepAliveTime

getThreadPoolKeepAliveTime

removeAllQueues

expire

removeScope

dumpScopes

getNumActiveThreads

init

start

stop

down

up

up

getOrCreateQueue

startExpiryTask

stopExpiryTask

createThreadPool

shutdownThreadPool

clearQueue