Package pbx

Class PluginGrpc.PluginBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<PluginGrpc.PluginBlockingStub>

pbx.PluginGrpc.PluginBlockingStub

Enclosing class:

PluginGrpc

public static final class PluginGrpc.PluginBlockingStub
extends io.grpc.stub.AbstractBlockingStub<PluginGrpc.PluginBlockingStub>

 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

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

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

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

Methods inherited from class java.lang.Object

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

Method Detail

build

protected PluginGrpc.PluginBlockingStub build(io.grpc.Channel channel,
                                              io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<PluginGrpc.PluginBlockingStub>

fireHose

public 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 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 Model.Unused account(Model.AccountEvent request)

 Account created, updated or deleted
 

topic

public Model.Unused topic(Model.TopicEvent request)

 Topic created, updated [or deleted -- not supported yet]
 

subscription

public Model.Unused subscription(Model.SubscriptionEvent request)

 Subscription created, updated or deleted
 

message

public Model.Unused message(Model.MessageEvent request)

 Message published or deleted