Package pbx

Class PluginGrpc.PluginFutureStub

  • Enclosing class:
    PluginGrpc
    public static final class PluginGrpc.PluginFutureStub
extends io.grpc.stub.AbstractFutureStub<PluginGrpc.PluginFutureStub>
    A stub to allow clients to do ListenableFuture-style rpc calls to service Plugin. 
     Plugin interface.

    • 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

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.google.common.util.concurrent.ListenableFuture<Model.Unused> account​(Model.AccountEvent request)
      Account created, updated or deleted
      protected PluginGrpc.PluginFutureStub build​(io.grpc.Channel channel, io.grpc.CallOptions callOptions)  
      com.google.common.util.concurrent.ListenableFuture<Model.SearchFound> find​(Model.SearchQuery request)
      An alteranative user and topic discovery mechanism.
      com.google.common.util.concurrent.ListenableFuture<Model.ServerResp> fireHose​(Model.ClientReq request)
      This plugin method is called by Tinode server for every message received from the clients.
      com.google.common.util.concurrent.ListenableFuture<Model.Unused> message​(Model.MessageEvent request)
      Message published or deleted
      com.google.common.util.concurrent.ListenableFuture<Model.Unused> subscription​(Model.SubscriptionEvent request)
      Subscription created, updated or deleted
      com.google.common.util.concurrent.ListenableFuture<Model.Unused> topic​(Model.TopicEvent request)
      Topic created, updated [or deleted -- not supported yet]

      • 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 Detail

      • fireHose

        public com.google.common.util.concurrent.ListenableFuture<Model.ServerResp> fireHose​(Model.ClientReq request)
         This plugin method is called by Tinode server for every message received from the clients. The
 method returns a ServerCtrl message. Non-zero ServerCtrl.code indicates that no further
 processing is needed. The Tinode server will generate a {ctrl} message from the returned ServerCtrl
 and forward it to the client session.
 ServerCtrl.code equals to 0 instructs the server to continue with default processing of the client message.

      • find

        public com.google.common.util.concurrent.ListenableFuture<Model.SearchFound> find​(Model.SearchQuery request)
         An alteranative user and topic discovery mechanism.
 A search request issued on a 'fnd' topic. This method is called to generate an alternative result set.

      • account

        public com.google.common.util.concurrent.ListenableFuture<Model.Unused> account​(Model.AccountEvent request)
         Account created, updated or deleted

      • topic

        public com.google.common.util.concurrent.ListenableFuture<Model.Unused> topic​(Model.TopicEvent request)
         Topic created, updated [or deleted -- not supported yet]

      • subscription

        public com.google.common.util.concurrent.ListenableFuture<Model.Unused> subscription​(Model.SubscriptionEvent request)
         Subscription created, updated or deleted

      • message

        public com.google.common.util.concurrent.ListenableFuture<Model.Unused> message​(Model.MessageEvent request)
         Message published or deleted