Interface SetServiceAccess

  • All Known Implementing Classes:
    ScoController

    public interface SetServiceAccess
    API to invoke set operations.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      <T extends org.somda.sdc.biceps.model.message.AbstractSet,​V extends org.somda.sdc.biceps.model.message.AbstractSetResponse>
      com.google.common.util.concurrent.ListenableFuture<ScoTransaction<V>>
      invoke​(T setRequest, Class<V> responseClass)
      Invokes a set operation.
      <T extends org.somda.sdc.biceps.model.message.AbstractSet,​V extends org.somda.sdc.biceps.model.message.AbstractSetResponse>
      com.google.common.util.concurrent.ListenableFuture<ScoTransaction<V>>
      invoke​(T setRequest, Consumer<org.somda.sdc.biceps.model.message.OperationInvokedReport.ReportPart> reportListener, Class<V> responseClass)
      Invokes a set operation.
    • Method Detail

      • invoke

        <T extends org.somda.sdc.biceps.model.message.AbstractSet,​V extends org.somda.sdc.biceps.model.message.AbstractSetResponse> com.google.common.util.concurrent.ListenableFuture<ScoTransaction<V>> invoke​(T setRequest,
                                                                                                                                                                                                                       Class<V> responseClass)
        Invokes a set operation.

        If there is no service to access the SCO, this function returns with a cancelled future.

        Type Parameters:
        T - the set request type.
        V - the set response type.
        Parameters:
        setRequest - the set request to send to the remote peer.
        responseClass - the expected response class (due to type erasure cannot be designated generically.
        Returns:
        a future to listen for the SCO transaction (which includes the set response).
      • invoke

        <T extends org.somda.sdc.biceps.model.message.AbstractSet,​V extends org.somda.sdc.biceps.model.message.AbstractSetResponse> com.google.common.util.concurrent.ListenableFuture<ScoTransaction<V>> invoke​(T setRequest,
                                                                                                                                                                                                                       @Nullable
                                                                                                                                                                                                                       Consumer<org.somda.sdc.biceps.model.message.OperationInvokedReport.ReportPart> reportListener,
                                                                                                                                                                                                                       Class<V> responseClass)
        Invokes a set operation.

        If there is no service to access the SCO, this function returns with a cancelled future.

        Type Parameters:
        T - the set request type.
        V - the set response type.
        Parameters:
        setRequest - the set request to send to the remote peer.
        responseClass - the expected response class (due to type erasure cannot be designated generically.
        reportListener - a callback function that accepts reports being received after invocation.
        Returns:
        a future to listen for the SCO transaction (which includes the set response).