Package io.github.simplexdevelopment.scheduler

Class ServicePool

java.lang.Object
io.github.simplexdevelopment.scheduler.ServicePool
All Implemented Interfaces:
Identifier
public final class ServicePool extends Object implements Identifier
A service pool is a collection of services which are managed by a single scheduler. The scheduler can either be an instance of Scheduler or ReactorBukkitScheduler. Using Scheduler allows for more flexibility, but doesn't communicate with the Main thread. Using ReactorBukkitScheduler allows for communication with the Main thread, but is less flexible.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final Set<IService>
    associatedServices
    A collection of services related to this service pool.
    private static final String
    DEFAULT
    The default String used to identify unmarked services.
    private final String
    name
    The name used to identify this service pool.
    private final reactor.core.scheduler.Scheduler
    scheduler
    The scheduler used to run the services in this pool.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ServicePool(String name, boolean multithreaded)
    This will create a new instance of a Service Pool with a Scheduler as its main scheduler.
    ServicePool(String name, org.bukkit.plugin.java.JavaPlugin plugin)
    This will create a new instance of a Service Pool with the ReactorBukkitScheduler as its main scheduler.

  • Method Summary

    Modifier and Type
    Method
    Description
    (package private) void
    addService(IService service)
     
    @NotNull Set<IService>
    getAssociatedServices()
     
    String
    getName()
     
    reactor.core.scheduler.Scheduler
    getScheduler()
     
    @NotNull reactor.core.publisher.Mono<IService>
    getService(String service_name)
    Gets a service based on the name of the service defined by Identifier.getName().
    (package private) boolean
    isValidService(IService service)
    Checks to see if the defined service is present within this pool.
    @NotNull reactor.core.publisher.Mono<reactor.core.Disposable>
    queueService(IService service)
    This method is the actual method used to schedule a service.
    @NotNull reactor.core.publisher.Flux<reactor.core.Disposable>
    queueServices()
    This method can be used to start all the services registered with this pool.
    @NotNull reactor.core.publisher.Mono<ServicePool>
    recycle()
    This will clear the ServicePool of all services and return an empty pool.
    (package private) void
    removeService(IService service)
    This method removes a service from the service pool set.
    @NotNull reactor.core.publisher.Mono<Void>
    stopService(@NotNull String service_name, @Nullable reactor.core.publisher.Mono<reactor.core.Disposable> disposable)
    This is the method used to stop a service.
    @NotNull reactor.core.publisher.Mono<Void>
    stopServices(@NotNull reactor.core.publisher.Flux<reactor.core.Disposable> disposableThread)
    This method can be used to stop all the services registered with this pool.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface io.github.simplexdevelopment.api.Identifier

    getNumericalId, getUniqueId

  • Field Details

    • DEFAULT

      private static final String DEFAULT
      The default String used to identify unmarked services. This will cause errors if left unchecked.
      See Also:

    • associatedServices

      private final Set<IService> associatedServices
      A collection of services related to this service pool.

    • scheduler

      private final reactor.core.scheduler.Scheduler scheduler
      The scheduler used to run the services in this pool.

    • name

      private final String name
      The name used to identify this service pool.

  • Constructor Details

    • ServicePool

      public ServicePool(String name, boolean multithreaded)
      This will create a new instance of a Service Pool with a Scheduler as its main scheduler. This should be used if you'd like to execute tasks without communicating on the main server thread.
      Parameters:
      name - The name of this service pool.
      multithreaded - Whether this service pool should be multithreaded, or operate upon a single thread.

    • ServicePool

      public ServicePool(String name, org.bukkit.plugin.java.JavaPlugin plugin)
      This will create a new instance of a Service Pool with the ReactorBukkitScheduler as its main scheduler. This should be used if you'd like to execute tasks while communicating on the main server thread.
      Parameters:
      name - The name of this service pool.

  • Method Details

    • addService

      void addService(IService service)
      Parameters:
      service - Add a service to the pool's service collection.

    • isValidService

      boolean isValidService(IService service)
      Checks to see if the defined service is present within this pool.
      Parameters:
      service - The service to check against this pool.
      Returns:
      Whether the service is registered with this pool.

    • getAssociatedServices

      @Contract(pure=true) @NotNull public @NotNull Set<IService> getAssociatedServices()
      Returns:
      A Set of IService objects which are registered with this pool.

    • queueService

      @NotNull public @NotNull reactor.core.publisher.Mono<reactor.core.Disposable> queueService(IService service)
      This method is the actual method used to schedule a service. This will register the service with the scheduler, and then return a Disposable object encapsulated within a Mono. If IService.isPeriodic() returns true, then the service will be scheduled to run periodically. Otherwise, it will be scheduled to run once.
      Parameters:
      service - The name of the service to queue. This should be a service that is located within this service pool. If you name a service that is stored within another service pool, this method will throw an error.
      Returns:
      A Mono object which contains a Disposable element which can be used to destroy the registered service.

    • queueServices

      @NotNull public @NotNull reactor.core.publisher.Flux<reactor.core.Disposable> queueServices()
      This method can be used to start all the services registered with this pool. If there are no services, this will do nothing.
      Returns:
      A Flux object which contains a collection of Disposable elements, which can be used to destroy the registered services using stopServices(Flux).

    • stopServices

      @NotNull public @NotNull reactor.core.publisher.Mono<Void> stopServices(@NotNull @NotNull reactor.core.publisher.Flux<reactor.core.Disposable> disposableThread)
      This method can be used to stop all the services registered with this pool. If there are no services, this will do nothing.
      Parameters:
      disposableThread - A reactor.core.publisher.Flux<reactor.core.Disposable> which contains all the services that should be disposed..
      Returns:
      A reactor.core.publisher.Mono<Void> object which can be used to stop the services.

    • stopService

      @NotNull public @NotNull reactor.core.publisher.Mono<Void> stopService(@NotNull @NotNull String service_name, @Nullable @Nullable reactor.core.publisher.Mono<reactor.core.Disposable> disposable)
      This is the method used to stop a service. This will call the relative Disposable.dispose() method to the Scheduler supplied for this pool. If you are using the ReactorBukkitScheduler, this will cancel the task upstream on the BukkitScheduler.
      Parameters:
      service_name - The name of the service to stop.
      disposable - A Disposable object which contains the service that should be disposed.
      Returns:
      A reactor.core.publisher.Mono<Void> object which can be used to stop the service.

    • getService

      @NotNull public @NotNull reactor.core.publisher.Mono<IService> getService(String service_name)
      Gets a service based on the name of the service defined by Identifier.getName(). This will search the service pool for a service with the same name, and return it.
      Parameters:
      service_name - The name of the service to get.
      Returns:
      A Mono object which contains the service.

    • removeService

      void removeService(IService service)
      This method removes a service from the service pool set.
      Parameters:
      service - The service to remove from the pool's service collection.

    • recycle

      @NotNull public @NotNull reactor.core.publisher.Mono<ServicePool> recycle()
      This will clear the ServicePool of all services and return an empty pool.
      Returns:
      This service pool after being cleared of all services. You will need to register services with this pool again before using it.

    • getScheduler

      @Contract(pure=true) public reactor.core.scheduler.Scheduler getScheduler()
      Returns:
      The Scheduler which hosts the threads for the service pool.

    • getName

      public String getName()
      Specified by:
      getName in interface Identifier
      Returns:
      The name of the identifiable object in a readable format.