Interface OctopusGrpc.AsyncService

All Known Implementing Classes:
OctopusGrpc.OctopusImplBase
Enclosing class:
OctopusGrpc
public static interface OctopusGrpc.AsyncService

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    call(Object request, io.grpc.stub.StreamObserver<Entry> responseObserver)
    Stores an object on key in the database and returns the stored version, including the revision and ID.
    default void
    get(GetRequest request, io.grpc.stub.StreamObserver<GetResponse> responseObserver)
    Retrieves only one existing entry from the database matching a key.
    default io.grpc.stub.StreamObserver<ListenMessage>
    listen(io.grpc.stub.StreamObserver<EventCall> responseObserver)
    Bidirectional stream for real-time updates.
    default void
    query(QueryRequest request, io.grpc.stub.StreamObserver<QueryResponse> responseObserver)
    Retrieves existing entries from the database matching a key pattern.
    default void
    write(Object request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
    Stores an object on key.

  • Method Details

    • query

      default void query(QueryRequest request, io.grpc.stub.StreamObserver<QueryResponse> responseObserver)
      
Retrieves existing entries from the database matching a
key pattern. Can optionally include expired (include all
revisions) objects and filter by creation time.

    • get

      default void get(GetRequest request, io.grpc.stub.StreamObserver<GetResponse> responseObserver)
      
Retrieves only one existing entry from the database matching a key.

    • write

      default void write(Object request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
      
Stores an object on key.

    • call

      default void call(Object request, io.grpc.stub.StreamObserver<Entry> responseObserver)
      
Stores an object on key in the database and returns the
stored version, including the revision and ID.

    • listen

      default io.grpc.stub.StreamObserver<ListenMessage> listen(io.grpc.stub.StreamObserver<EventCall> responseObserver)
      
Bidirectional stream for real-time updates. Clients
register for key-patterns (ListenMessage) and receive
events (EventCall).
Step 1: Registration
The client must first send a `ListenMessage` message
to specify which key-pattern to listen to.
Step 2: Event Reception
After registration, the server sends `EventCall` messages
for objects matching the registered key-pattern.
If you need other keys/more keys you can just send a new
`ListenMessage`. This will reset all keys for the current
subscription and the new keys will be used.