org.apache.dubbo.rpc.cluster.router.mesh.route

Class MeshRuleRouter

java.lang.Object

org.apache.dubbo.rpc.cluster.router.mesh.route.MeshRuleRouter

All Implemented Interfaces:

Comparable<Router>, Router, VsDestinationGroupRuleListener

public class MeshRuleRouter
extends Object
implements Router, VsDestinationGroupRuleListener

Field Summary

Fields inherited from interface org.apache.dubbo.rpc.cluster.Router

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor and Description
MeshRuleRouter(org.apache.dubbo.common.URL url)

Method Summary

Modifier and Type	Method and Description
List<Invoker<?>>	getInvokerList()
int	getPriority() Router's priority, used to sort routers.
Map<String,String>	getSourcesLabels()
Map<String,List<Invoker<?>>>	getSubsetMap()
org.apache.dubbo.common.URL	getUrl() Get the router url.
VsDestinationGroup	getVsDestinationGroup()
boolean	isForce() To decide whether this router should take effect when none of the invoker can match the router rule, which means the Router.route(List, URL, Invocation) would be empty.
boolean	isRuntime() To decide whether this router need to execute every time an RPC comes or should only execute when addresses or rule change.
<T> void	notify(List<Invoker<T>> invokers) Notify the router the invoker list.
void	onRuleChange(VsDestinationGroup vsDestinationGroup)
<T> RouterResult<Invoker<T>>	route(List<Invoker<T>> invokers, org.apache.dubbo.common.URL url, Invocation invocation, boolean needToPrintMessage) ** This method can return the state of whether routerChain needed to continue route.
void	stop()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.dubbo.rpc.cluster.Router

compareTo, route

Constructor Detail

MeshRuleRouter

public MeshRuleRouter(org.apache.dubbo.common.URL url)

Method Detail

getUrl

public org.apache.dubbo.common.URL getUrl()

Description copied from interface: Router

Get the router url.

Specified by:

getUrl in interface Router

Returns:

url

route

public <T> RouterResult<Invoker<T>> route(List<Invoker<T>> invokers,
                                          org.apache.dubbo.common.URL url,
                                          Invocation invocation,
                                          boolean needToPrintMessage)
                                   throws RpcException

Description copied from interface: Router

** This method can return the state of whether routerChain needed to continue route. ** Filter invokers with current routing rule and only return the invokers that comply with the rule.

Specified by:

route in interface Router

Parameters:

invokers - invoker list

url - refer url

invocation - invocation

needToPrintMessage - whether to print router state. Such as `use router branch a`.

Returns:

state with route result

Throws:

RpcException

notify

public <T> void notify(List<Invoker<T>> invokers)

Description copied from interface: Router

Notify the router the invoker list. Invoker list may change from time to time. This method gives the router a chance to prepare before Router.route(List, URL, Invocation) gets called.

Specified by:

notify in interface Router

Type Parameters:

T - invoker's type

Parameters:

invokers - invoker list

onRuleChange

public void onRuleChange(VsDestinationGroup vsDestinationGroup)

Specified by:

onRuleChange in interface VsDestinationGroupRuleListener

isRuntime

public boolean isRuntime()

Description copied from interface: Router

To decide whether this router need to execute every time an RPC comes or should only execute when addresses or rule change.

Specified by:

isRuntime in interface Router

Returns:

true if the router need to execute every time.

isForce

public boolean isForce()

Description copied from interface: Router

To decide whether this router should take effect when none of the invoker can match the router rule, which means the Router.route(List, URL, Invocation) would be empty. Most of time, most router implementation would default this value to false.

Specified by:

isForce in interface Router

Returns:

true to execute if none of invokers matches the current router

getPriority

public int getPriority()

Description copied from interface: Router

Router's priority, used to sort routers.

Specified by:

getPriority in interface Router

Returns:

router's priority

stop

public void stop()

Specified by:

stop in interface Router

getVsDestinationGroup

public VsDestinationGroup getVsDestinationGroup()

getSourcesLabels

public Map<String,String> getSourcesLabels()

getInvokerList

public List<Invoker<?>> getInvokerList()

getSubsetMap

public Map<String,List<Invoker<?>>> getSubsetMap()