org.apache.plc4x.java.base.messages

Interface PlcSubscriber

public interface PlcSubscriber

Interface implemented by all PlcConnections that are able to receive notifications from remote resources.

Method Summary

Modifier and Type	Method and Description
PlcConsumerRegistration	register(Consumer<PlcSubscriptionEvent> consumer, Collection<PlcSubscriptionHandle> handles)
CompletableFuture<PlcSubscriptionResponse>	subscribe(PlcSubscriptionRequest subscriptionRequest) Subscribes to fields on the PLC.
void	unregister(PlcConsumerRegistration registration) // TODO: document me.
CompletableFuture<PlcUnsubscriptionResponse>	unsubscribe(PlcUnsubscriptionRequest unsubscriptionRequest) Unsubscribes from fields on the PLC.

Method Detail

subscribe

CompletableFuture<PlcSubscriptionResponse> subscribe(PlcSubscriptionRequest subscriptionRequest)

Subscribes to fields on the PLC.

Parameters:

subscriptionRequest - subscription request containing at least one subscription request item.

Returns:

subscription response containing a subscription response item for each subscription request item.

unsubscribe

CompletableFuture<PlcUnsubscriptionResponse> unsubscribe(PlcUnsubscriptionRequest unsubscriptionRequest)

Unsubscribes from fields on the PLC. For unsubscribing the unsubscription request uses the subscription handle returned as part of the subscription response item.

Parameters:

unsubscriptionRequest - unsubscription request containing at least one unsubscription request item.

Returns:

unsubscription response containing a unsubscription response item for each unsubscription request item.

register

PlcConsumerRegistration register(Consumer<PlcSubscriptionEvent> consumer,
                                 Collection<PlcSubscriptionHandle> handles)

Parameters:

consumer -

handles -

Returns:

TODO: document me

unregister

void unregister(PlcConsumerRegistration registration)

// TODO: document me.