Package io.streamnative.oxia.proto
Class OxiaClientGrpc.OxiaClientBlockingStub
java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractBlockingStub<OxiaClientGrpc.OxiaClientBlockingStub>
io.streamnative.oxia.proto.OxiaClientGrpc.OxiaClientBlockingStub
- Enclosing class:
- OxiaClientGrpc
public static final class OxiaClientGrpc.OxiaClientBlockingStub
extends io.grpc.stub.AbstractBlockingStub<OxiaClientGrpc.OxiaClientBlockingStub>
A stub to allow clients to do synchronous rpc calls to service OxiaClient.
Oxia service that allows clients to discover shard-to-server assignments and submit batches of requests. Clients should connect to a random server to discover the shard-to-server assignments and then send the actual batched requests to the appropriate shard leader. In the future, this may be handled server-side in a proxy layer to allows clients to not be concerned with sharding.
-
Nested Class Summary
Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub
io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>> -
Method Summary
Modifier and TypeMethodDescriptionprotected OxiaClientGrpc.OxiaClientBlockingStubbuild(io.grpc.Channel channel, io.grpc.CallOptions callOptions) closeSession(CloseSessionRequest request) Closes a session and removes all ephemeral values associated with it.createSession(CreateSessionRequest request) Creates a new client session.getNotifications(NotificationsRequest request) Gets all shard-to-server assignments as a stream.keepAlive(SessionHeartbeat request) Sends a heartbeat to prevent the session from timing out.list(ListRequest request) Requests all the keys between a range of keys.rangeScan(RangeScanRequest request) Requests all the records between a range of keys.read(ReadRequest request) Batches get requests.write(WriteRequest request) Batches put, delete and delete_range requests.Methods inherited from class io.grpc.stub.AbstractBlockingStub
newStub, newStubMethods inherited from class io.grpc.stub.AbstractStub
getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady
-
Method Details
-
build
protected OxiaClientGrpc.OxiaClientBlockingStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions) - Specified by:
buildin classio.grpc.stub.AbstractStub<OxiaClientGrpc.OxiaClientBlockingStub>
-
getShardAssignments
Gets all shard-to-server assignments as a stream. Each set of assignments in the response stream will contain all the assignments to bring the client up to date. For example, if a shard is split, the stream will return a single response containing all the new shard assignments as opposed to multiple stream responses, each containing a single shard assignment. Clients should connect to a single random server which will stream the assignments for all shards on all servers.
-
write
Batches put, delete and delete_range requests. Clients should send this request to the shard leader. In the future, this may be handled server-side in a proxy layer. Deprecated
-
read
Batches get requests. Clients should send this request to the shard leader. In the future, this may be handled server-side in a proxy layer.
-
list
Requests all the keys between a range of keys. Clients should send an equivalent request to all respective shards, unless a particular partition key was specified.
-
rangeScan
Requests all the records between a range of keys. Clients should send an equivalent request to all respective shards, unless a particular partition key was specified.
-
getNotifications
-
createSession
Creates a new client session. Sessions are kept alive by regularly sending heartbeats via the KeepAlive rpc.
-
keepAlive
Sends a heartbeat to prevent the session from timing out.
-
closeSession
Closes a session and removes all ephemeral values associated with it.
-