Package org.opentcs.access.rmi.services

Interface RemoteDispatcherService

All Superinterfaces:

java.rmi.Remote

public interface RemoteDispatcherService
extends java.rmi.Remote

Declares the methods provided by the DispatcherService via RMI.

The majority of the methods declared here have signatures analogous to their counterparts in DispatcherService, with an additional ClientID parameter which serves the purpose of identifying the calling client and determining its permissions.

To avoid redundancy, the semantics of methods that only pass through their arguments are not explicitly documented here again. See the corresponding API documentation in DispatcherService for these, instead.

Method Summary

Modifier and Type	Method	Description
default void	assignNow(ClientID clientId, TCSObjectReference<TransportOrder> ref)
void	dispatch(ClientID clientId)
default void	reroute(ClientID clientId, TCSObjectReference<Vehicle> ref, ReroutingType reroutingType)
default void	rerouteAll(ClientID clientId, ReroutingType reroutingType)
void	withdrawByTransportOrder(ClientID clientId, TCSObjectReference<TransportOrder> ref, boolean immediateAbort)
void	withdrawByVehicle(ClientID clientId, TCSObjectReference<Vehicle> ref, boolean immediateAbort)

Method Details

dispatch

void dispatch(ClientID clientId) throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

withdrawByVehicle

void withdrawByVehicle(ClientID clientId, TCSObjectReference<Vehicle> ref, boolean immediateAbort) throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

withdrawByTransportOrder

void withdrawByTransportOrder(ClientID clientId, TCSObjectReference<TransportOrder> ref, boolean immediateAbort) throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

reroute

@ScheduledApiChange(when="6.0", details="Default implementation will be removed.") default void reroute(ClientID clientId, TCSObjectReference<Vehicle> ref, ReroutingType reroutingType) throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

rerouteAll

@ScheduledApiChange(when="6.0", details="Default implementation will be removed.") default void rerouteAll(ClientID clientId, ReroutingType reroutingType) throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

assignNow

@ScheduledApiChange(when="6.0", details="Default implementation will be removed.") default void assignNow(ClientID clientId, TCSObjectReference<TransportOrder> ref) throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException