Package com.mewna.catnip.rest.requester

Interface Requester

All Known Implementing Classes:
AbstractRequester, BurstRequester, SerialRequester
public interface Requester
A REST requester. The requester is responsible for queuing up new requests, and executing them at some point in the future. Once the request has been executed, the observable can then start emitting the response.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    Requester.OutboundRequest
    POJO that represents an outbound request to Discord's REST API.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    REASON_HEADER
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    catnip(Catnip catnip)
     
    io.reactivex.rxjava3.core.Observable<ResponsePayload>
    queue(Requester.OutboundRequest r)
    Queues a new request to be executed.

  • Field Details

  • Method Details

    • catnip

      void catnip(@Nonnull Catnip catnip)

    • queue

      @Nonnull @CheckReturnValue io.reactivex.rxjava3.core.Observable<ResponsePayload> queue(@Nonnull Requester.OutboundRequest r)
      Queues a new request to be executed.
      Parameters:
      r - The request to execute.
      Returns:
      An Observable that emits when the request has completed.