Package org.apache.plc4x.java.simulated.connection

Class SimulatedConnection

java.lang.Object

org.apache.plc4x.java.spi.connection.AbstractPlcConnection

org.apache.plc4x.java.simulated.connection.SimulatedConnection

All Implemented Interfaces:

AutoCloseable, PlcConnectionMetadata, PlcConnection, PlcBrowser, PlcPinger, PlcReader, PlcSubscriber, PlcWriter

public class SimulatedConnection
extends AbstractPlcConnection
implements PlcReader, PlcWriter, PlcSubscriber

Connection to a test device. This class is not thread-safe.

Constructor Summary

Constructors

Constructor	Description
SimulatedConnection(SimulatedDevice device)

Method Summary

Modifier and Type	Method	Description
void	close()
void	connect()
boolean	isConnected()
CompletableFuture<? extends PlcPingResponse>	ping()
CompletableFuture<PlcReadResponse>	read(PlcReadRequest readRequest)
PlcConsumerRegistration	register(Consumer<PlcSubscriptionEvent> consumer, Collection<PlcSubscriptionHandle> handles)
CompletableFuture<PlcSubscriptionResponse>	subscribe(PlcSubscriptionRequest subscriptionRequest)	Blocking subscribe call
String	toString()
void	unregister(PlcConsumerRegistration registration)
CompletableFuture<PlcUnsubscriptionResponse>	unsubscribe(PlcUnsubscriptionRequest unsubscriptionRequest)
CompletableFuture<PlcWriteResponse>	write(PlcWriteRequest writeRequest)

Methods inherited from class org.apache.plc4x.java.spi.connection.AbstractPlcConnection

browse, browseRequestBuilder, browseWithInterceptor, getAuthentication, getMetadata, getPlcTagHandler, getPlcValueHandler, isBrowseSupported, isReadSupported, isSubscribeSupported, isWriteSupported, ping, readRequestBuilder, setProtocol, subscriptionRequestBuilder, unsubscriptionRequestBuilder, writeRequestBuilder

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.plc4x.java.api.PlcConnection

parseTagAddress

Constructor Detail

SimulatedConnection

public SimulatedConnection(SimulatedDevice device)

Method Detail

connect

public void connect()

Specified by:

connect in interface PlcConnection

isConnected

public boolean isConnected()

Specified by:

isConnected in interface PlcConnection

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface PlcConnection

ping

public CompletableFuture<? extends PlcPingResponse> ping()

Specified by:

ping in interface PlcConnection

Overrides:

ping in class AbstractPlcConnection

read

public CompletableFuture<PlcReadResponse> read(PlcReadRequest readRequest)

Specified by:

read in interface PlcReader

Overrides:

read in class AbstractPlcConnection

write

public CompletableFuture<PlcWriteResponse> write(PlcWriteRequest writeRequest)

Specified by:

write in interface PlcWriter

Overrides:

write in class AbstractPlcConnection

toString

public String toString()

Overrides:

toString in class Object

subscribe

public CompletableFuture<PlcSubscriptionResponse> subscribe(PlcSubscriptionRequest subscriptionRequest)

Blocking subscribe call

Specified by:

subscribe in interface PlcSubscriber

Overrides:

subscribe in class AbstractPlcConnection

Parameters:

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

Returns:

the PlcSubscriptionResponse

unsubscribe

public CompletableFuture<PlcUnsubscriptionResponse> unsubscribe(PlcUnsubscriptionRequest unsubscriptionRequest)

Specified by:

unsubscribe in interface PlcSubscriber

Overrides:

unsubscribe in class AbstractPlcConnection

register

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

Specified by:

register in interface PlcSubscriber

Overrides:

register in class AbstractPlcConnection

unregister

public void unregister(PlcConsumerRegistration registration)

Specified by:

unregister in interface PlcSubscriber

Overrides:

unregister in class AbstractPlcConnection