Class UniversalisWsBuilder

java.lang.Object
de.chojo.universalis.websocket.builder.UniversalisWsBuilder
public class UniversalisWsBuilder extends Object
Builder to create a UniversalisWs instance.

  • Field Details

    • DEFAULT_WEBSOCKET_URL

      public static final String DEFAULT_WEBSOCKET_URL
      Default websocket URL for the universalis service.
      See Also:

  • Constructor Details

    • UniversalisWsBuilder

      public UniversalisWsBuilder(com.neovisionaries.ws.client.WebSocketFactory factory)
      Create a new universalis websocket builder
      Parameters:
      factory - factory to create a websocket

  • Method Details

    • registerListener

      public UniversalisWsBuilder registerListener(EventListener... eventListener)
      Registers a listener.
      Parameters:
      eventListener - event listener
      Returns:
      builder instance

    • subscribe

      public UniversalisWsBuilder subscribe(Subscription subscription)
      Add a subscription for a channel.
      Parameters:
      subscription - subscription to add
      Returns:
      builder instance

    • eventThreadPool

      public UniversalisWsBuilder eventThreadPool(ExecutorService executorService)
      Set the thread pool used to handle websocket events
      Parameters:
      executorService - executor service
      Returns:
      builder instance

    • itemNameSupplier

      public UniversalisWsBuilder itemNameSupplier(NameSupplier nameSupplier)
      Name supplier for item names. If this is not set item names will be blank.
      Parameters:
      nameSupplier - name supplier for items
      Returns:
      builder instance

    • websocketUrl

      public UniversalisWsBuilder websocketUrl(String websocketUrl)
      Override the websocket URL. Defaults to DEFAULT_WEBSOCKET_URL.
      Parameters:
      websocketUrl - websocket url
      Returns:
      builder instance

    • build

      public UniversalisWs build()
      Builds and attempts to connect the websocket.

      Use UniversalisWs.awaitReady() to wait until the socket is connected.

      Returns:
      Universalis websocket instance