Package proto.stream.v1

Class StreamServiceGrpc.StreamServiceFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<StreamServiceGrpc.StreamServiceFutureStub>

proto.stream.v1.StreamServiceGrpc.StreamServiceFutureStub

Enclosing class:

StreamServiceGrpc

public static final class StreamServiceGrpc.StreamServiceFutureStub
extends io.grpc.stub.AbstractFutureStub<StreamServiceGrpc.StreamServiceFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service StreamService.

 A StreamService is used to coordinate with a WebRTC the listing,
 addition, and removal of registered video streams.
 TODO(https://github.com/viamrobotics/rdk/issues/509): support removal
 

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 Type	Method	Description
com.google.common.util.concurrent.ListenableFuture<Stream.AddStreamResponse>	addStream(Stream.AddStreamRequest request)	AddStream requests a particular stream be added.
protected StreamServiceGrpc.StreamServiceFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<Stream.GetStreamOptionsResponse>	getStreamOptions(Stream.GetStreamOptionsRequest request)	GetStreamOptions returns the options for a particular stream.
com.google.common.util.concurrent.ListenableFuture<Stream.ListStreamsResponse>	listStreams(Stream.ListStreamsRequest request)	ListStreams returns all streams registered.
com.google.common.util.concurrent.ListenableFuture<Stream.RemoveStreamResponse>	removeStream(Stream.RemoveStreamRequest request)	RemoveStream requests a particular stream be removed.
com.google.common.util.concurrent.ListenableFuture<Stream.SetStreamOptionsResponse>	setStreamOptions(Stream.SetStreamOptionsRequest request)	SetStreamOptions sets the options for a particular stream.

Methods inherited from class io.grpc.stub.AbstractFutureStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

build

protected StreamServiceGrpc.StreamServiceFutureStub build(io.grpc.Channel channel,
 io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<StreamServiceGrpc.StreamServiceFutureStub>

listStreams

public com.google.common.util.concurrent.ListenableFuture<Stream.ListStreamsResponse> listStreams(Stream.ListStreamsRequest request)

 ListStreams returns all streams registered.
 

addStream

public com.google.common.util.concurrent.ListenableFuture<Stream.AddStreamResponse> addStream(Stream.AddStreamRequest request)

 AddStream requests a particular stream be added.
 

getStreamOptions

public com.google.common.util.concurrent.ListenableFuture<Stream.GetStreamOptionsResponse> getStreamOptions(Stream.GetStreamOptionsRequest request)

 GetStreamOptions returns the options for a particular stream.
 

setStreamOptions

public com.google.common.util.concurrent.ListenableFuture<Stream.SetStreamOptionsResponse> setStreamOptions(Stream.SetStreamOptionsRequest request)

 SetStreamOptions sets the options for a particular stream.
 

removeStream

public com.google.common.util.concurrent.ListenableFuture<Stream.RemoveStreamResponse> removeStream(Stream.RemoveStreamRequest request)

 RemoveStream requests a particular stream be removed. If the calling client
 is the last to be receiving the stream, it will attempt to be stopped to
 conserve resources.