org.fisco.bcos.web3j.protocol.Web3jService Maven / Gradle / Ivy
package org.fisco.bcos.web3j.protocol;
import io.reactivex.Flowable;
import java.io.IOException;
import java.util.concurrent.CompletableFuture;
import org.fisco.bcos.web3j.protocol.core.Request;
import org.fisco.bcos.web3j.protocol.core.Response;
import org.fisco.bcos.web3j.protocol.websocket.events.Notification;
/** Services API. */
public interface Web3jService {
T send(Request request, Class responseType) throws IOException;
CompletableFuture sendAsync(Request request, Class responseType);
/**
* Subscribe to a stream of notifications. A stream of notifications is opened by by performing a
* specified JSON-RPC request and is closed by calling the unsubscribe method. Different WebSocket
* implementations use different pair of subscribe/unsubscribe methods.
*
* This method creates an Flowable that can be used to subscribe to new notifications. When a
* client unsubscribes from this Flowable the service unsubscribes from the underlying stream of
* events.
*
* @param request JSON-RPC request that will be send to subscribe to a stream of events
* @param unsubscribeMethod method that will be called to unsubscribe from a stream of
* notifications
* @param responseType class of incoming events objects in a stream
* @param type of incoming event objects
* @return a {@link Flowable} instance that emits incoming events
*/
> Flowable subscribe(
Request request, String unsubscribeMethod, Class responseType);
/**
* Closes resources used by the service.
*
* @throws IOException thrown if a service failed to close all resources
*/
void close() throws IOException;
}