Package org.opentcs.access
Interface KernelServicePortal
- All Known Implementing Classes:
RemoteKernelServicePortalProxy
public interface KernelServicePortal
Provides clients access to kernel services.
-
Method Summary
Modifier and Type Method Description java.util.List<java.lang.Object>fetchEvents(long timeout)Fetches events buffered for the client.DispatcherServicegetDispatcherService()Returns the service a client can use to access methods regarding the dispatcher.NotificationServicegetNotificationService()Returns the service a client can use to access methods regarding user notifications.PeripheralDispatcherServicegetPeripheralDispatcherService()Returns the service a client can use to access methods regarding the peripheral dispatcher.PeripheralJobServicegetPeripheralJobService()Returns the service a client can use to access methods regarding peripheral jobs.PeripheralServicegetPeripheralService()Returns the service a client can use to access methods regarding peripherals.PlantModelServicegetPlantModelService()Returns the service a client can use to access methods regarding the plant model.QueryServicegetQueryService()Returns the service a client can use to access methods for generic queries.RouterServicegetRouterService()Returns the service a client can use to access methods regarding the router.SchedulerServicegetSchedulerService()Returns the service a client can use to access methods regarding the scheduler.Kernel.StategetState()Returns the current state of the kernel.TransportOrderServicegetTransportOrderService()Returns the service a client can use to access methods regarding transport orders and order sequences.VehicleServicegetVehicleService()Returns the service a client can use to access methods regarding vehicles.voidlogin(java.lang.String hostName, int port)Logs in with/establishes a connection to the remote kernel service portal.voidlogout()Logs out from/clears the connection to the remote kernel service portal.voidpublishEvent(java.lang.Object event)Publishes an event.
-
Method Details
-
login
Logs in with/establishes a connection to the remote kernel service portal.- Parameters:
hostName- The host on which the remote portal is running.port- The port at which we can reach the remote RMI registry.- Throws:
KernelRuntimeException- If there was a problem logging in with the remote portal.
-
logout
Logs out from/clears the connection to the remote kernel service portal.- Throws:
KernelRuntimeException- If there was a problem logging out from the remote portal, i.e. it is no longer available.
-
getState
Returns the current state of the kernel.- Returns:
- The current state of the kernel.
- Throws:
KernelRuntimeException- In case there is an exception executing this method.
-
fetchEvents
Fetches events buffered for the client.- Parameters:
timeout- A timeout (in ms) for which to wait for events to arrive.- Returns:
- A list of events (in the order they arrived).
- Throws:
KernelRuntimeException- In case there is an exception executing this method.
-
publishEvent
Publishes an event.- Parameters:
event- The event to be published.- Throws:
KernelRuntimeException- In case there is an exception executing this method.
-
getPlantModelService
Returns the service a client can use to access methods regarding the plant model.- Returns:
- The service a client can use to access methods regarding the plant model.
-
getTransportOrderService
Returns the service a client can use to access methods regarding transport orders and order sequences.- Returns:
- The service a client can use to access methods regarding transport orders and order sequences.
-
getVehicleService
Returns the service a client can use to access methods regarding vehicles.- Returns:
- The service a client can use to access methods regarding vehicles.
-
getNotificationService
Returns the service a client can use to access methods regarding user notifications.- Returns:
- The service a client can use to access methods regarding user notifications.
-
getDispatcherService
Returns the service a client can use to access methods regarding the dispatcher.- Returns:
- The service a client can use to access methods regarding the dispatcher.
-
getRouterService
Returns the service a client can use to access methods regarding the router.- Returns:
- The service a client can use to access methods regarding the router.
-
getSchedulerService
Returns the service a client can use to access methods regarding the scheduler.- Returns:
- The service a client can use to access methods regarding the scheduler.
-
getQueryService
Returns the service a client can use to access methods for generic queries.- Returns:
- The service a client can use to access methods for generic queries.
-
getPeripheralService
Returns the service a client can use to access methods regarding peripherals.- Returns:
- The service a client can use to access methods regarding peripherals.
-
getPeripheralJobService
Returns the service a client can use to access methods regarding peripheral jobs.- Returns:
- The service a client can use to access methods regarding peripheral jobs.
-
getPeripheralDispatcherService
Returns the service a client can use to access methods regarding the peripheral dispatcher.- Returns:
- The service a client can use to access methods regarding the peripheral dispatcher.
-