io.spine.web.subscription

Interface SubscriptionBridge<S extends com.google.protobuf.Message,K extends com.google.protobuf.Message,C extends com.google.protobuf.Message>

Type Parameters:

S - response type for SubscriptionBridge.subscribe(Topic) requests

K - response type for SubscriptionBridge.keepUp(Subscription) requests

C - response type for SubscriptionBridge.cancel(Subscription) requests

public interface SubscriptionBridge<S extends com.google.protobuf.Message,K extends com.google.protobuf.Message,C extends com.google.protobuf.Message>

A bridge for requests to a subscription SubscriptionService.

Defines an interface for subscribing to a Topic, keeping up an existing Subscription and canceling an existing Subscription.

Method Summary

Modifier and Type	Method and Description
C	cancel(io.spine.client.Subscription subscription) Cancel the existing subscription, which stopping sending new data updates to the client.
K	keepUp(io.spine.client.Subscription subscription) Keep up the subscription, prohibiting it from closing from the server-side.
S	subscribe(io.spine.client.Topic topic) Creates a new Subscription to a provided topic supplying this subscription to the client as a result.

Method Detail

subscribe

S subscribe(io.spine.client.Topic topic)

Creates a new Subscription to a provided topic supplying this subscription to the client as a result.

Parameters:

topic - a topic to subscribe the client to

Returns:

a message describing the created subscription

keepUp

K keepUp(io.spine.client.Subscription subscription)

Keep up the subscription, prohibiting it from closing from the server-side.

This operation is performed because subscription can only live some finite amount of time. Server cancels the subscription at some point, because maintaining the subscription requires resources and the client cannot be trusted to cancel every subscription it creates.

Parameters:

subscription - a subscription that should stay open

Returns:

the keep-up response

cancel

C cancel(io.spine.client.Subscription subscription)

Cancel the existing subscription, which stopping sending new data updates to the client.

Parameters:

subscription - a subscription that should be stopped from receiving updates

Returns:

the cancellation response