Package org.apache.plc4x.java.base.connection

Class AbstractPlcConnection

java.lang.Object

org.apache.plc4x.java.base.connection.AbstractPlcConnection

All Implemented Interfaces:

AutoCloseable, PlcConnectionMetadata, PlcConnection

Direct Known Subclasses:

NettyPlcConnection

public abstract class AbstractPlcConnection
extends Object
implements PlcConnection, PlcConnectionMetadata

Base class for implementing connections. Per default, all operations (read, write, subscribe) are unsupported. Concrete implementations should override the methods indicating connection capabilities and for obtaining respective request builders.

Constructor Summary

Constructors

Constructor	Description
AbstractPlcConnection()

Method Summary

Modifier and Type	Method	Description
boolean	canRead()
boolean	canSubscribe()
boolean	canWrite()
protected <T extends InternalPlcMessage> T	checkInternal(Object o, Class<T> clazz)	Can be used to check and cast a parameter to its required internal type (can be used for general type checking too).
PlcConnectionMetadata	getMetadata()
CompletableFuture<Void>	ping()
PlcReadRequest.Builder	readRequestBuilder()
PlcSubscriptionRequest.Builder	subscriptionRequestBuilder()
PlcUnsubscriptionRequest.Builder	unsubscriptionRequestBuilder()
PlcWriteRequest.Builder	writeRequestBuilder()

Methods inherited from class java.lang.Object

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

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

close, connect, isConnected, prepareField

Constructor Details

AbstractPlcConnection

public AbstractPlcConnection()

Method Details

getMetadata

public PlcConnectionMetadata getMetadata()

Specified by:

getMetadata in interface PlcConnection

ping

public CompletableFuture<Void> ping()

Specified by:

ping in interface PlcConnection

canRead

public boolean canRead()

Specified by:

canRead in interface PlcConnectionMetadata

canWrite

public boolean canWrite()

Specified by:

canWrite in interface PlcConnectionMetadata

canSubscribe

public boolean canSubscribe()

Specified by:

canSubscribe in interface PlcConnectionMetadata

readRequestBuilder

public PlcReadRequest.Builder readRequestBuilder()

Specified by:

readRequestBuilder in interface PlcConnection

writeRequestBuilder

public PlcWriteRequest.Builder writeRequestBuilder()

Specified by:

writeRequestBuilder in interface PlcConnection

subscriptionRequestBuilder

public PlcSubscriptionRequest.Builder subscriptionRequestBuilder()

Specified by:

subscriptionRequestBuilder in interface PlcConnection

unsubscriptionRequestBuilder

public PlcUnsubscriptionRequest.Builder unsubscriptionRequestBuilder()

Specified by:

unsubscriptionRequestBuilder in interface PlcConnection

checkInternal

protected <T extends InternalPlcMessage> T checkInternal(Object o, Class<T> clazz)

Can be used to check and cast a parameter to its required internal type (can be used for general type checking too).

Type Parameters:

T - the type of the expected clazz.

Parameters:

o - the object to be checked against target clazz.

clazz - the expected clazz.

Returns:

the cast type of clazz.