org.yamcs.protobuf.RocksDbApiClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yamcs-api Show documentation
Used by external clients to communicate with Yamcs
There is a newer version: 5.10.9
package org.yamcs.protobuf;

import com.google.protobuf.Empty;
import org.yamcs.api.HttpBody;
import org.yamcs.api.MethodHandler;
import org.yamcs.api.Observer;

@javax.annotation.processing.Generated(value = "org.yamcs.maven.ServiceGenerator", date = "2025-02-13T11:12:59.912608913Z")
public class RocksDbApiClient extends AbstractRocksDbApi {

    private final MethodHandler handler;

    public RocksDbApiClient(MethodHandler handler) {
        this.handler = handler;
    }

    /**
     *      *  List tablespaces
     * 
     */
    @Override
    public final void listTablespaces(Void ctx, Empty request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(0),
            request,
            ListRocksDbTablespacesResponse.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Backup database
     * 
     */
    @Override
    public final void backupDatabase(Void ctx, BackupDatabaseRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(1),
            request,
            Empty.getDefaultInstance(),
            observer);
    }

    /**
     *      *  List databases
     * 
     */
    @Override
    public final void listDatabases(Void ctx, Empty request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(2),
            request,
            ListRocksDbDatabasesResponse.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Compact database
     * 
     */
    @Override
    public final void compactDatabase(Void ctx, CompactDatabaseRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(3),
            request,
            Empty.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Get a text-dump with general RocksDB info
     * 
     */
    @Override
    public final void describeRocksDb(Void ctx, Empty request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(4),
            request,
            HttpBody.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Get a text-dump describing a database
     * 
     *  This operation can be used to debug the inner workings of RocksDB database.
     *  For example the property rocksdb.estimate-table-readers-mem will provide an
     *  estimation of how much memory is used by the index and filter cache of
     *  RocksDB (note that the memory used by RocksDB is outside the java heap space).
     * 
     *  See also: https://github.com/facebook/rocksdb/blob/master/include/rocksdb/db.h
     * 
     *  The response contains a dump of various rocksdb properties for each column
     *  family. The single value properties are presented in a "name: value" list.
     *  The multiline properties are preceded by a line including the property name
     *  between dashes.
     * 
     */
    @Override
    public final void describeDatabase(Void ctx, DescribeDatabaseRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(5),
            request,
            HttpBody.getDefaultInstance(),
            observer);
    }
}