Package org.apache.plc4x.java.eip.base

Class EIPDriver

java.lang.Object

org.apache.plc4x.java.spi.connection.GeneratedDriverBase<EipPacket>

org.apache.plc4x.java.eip.base.EIPDriver

All Implemented Interfaces:

PlcDriver

public class EIPDriver
extends GeneratedDriverBase<EipPacket>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EIPDriver.ByteLengthEstimator	Estimate the Length of a Packet
static class	EIPDriver.CorruptPackageCleaner	Consumes all Bytes till another Magic Byte is found

Field Summary

Fields

Modifier and Type	Field	Description
static int	PORT

Fields inherited from class org.apache.plc4x.java.spi.connection.GeneratedDriverBase

PROPERTY_PLC4X_FORCE_AWAIT_DISCONNECT_COMPLETE, PROPERTY_PLC4X_FORCE_AWAIT_DISCOVER_COMPLETE, PROPERTY_PLC4X_FORCE_AWAIT_SETUP_COMPLETE, PROPERTY_PLC4X_FORCE_FIRE_DISCOVER_EVENT

Constructor Summary

Constructors

Constructor	Description
EIPDriver()

Method Summary

Modifier and Type	Method	Description
protected boolean	awaitDisconnectComplete()	This protocol doesn't have a disconnect procedure, so there is no need to wait for a login to finish.
protected boolean	canRead()
protected boolean	canWrite()
protected Class<? extends PlcConnectionConfiguration>	getConfigurationClass()
PlcConnection	getConnection(String connectionString)
protected Optional<String>	getDefaultTransportCode()
String	getProtocolCode()
String	getProtocolName()
protected ProtocolStackConfigurer<EipPacket>	getStackConfigurer()
protected List<String>	getSupportedTransportCodes()
protected PlcTagHandler	getTagHandler()
protected Optional<Class<? extends PlcTransportConfiguration>>	getTransportConfigurationClass(String transportCode)
protected PlcValueHandler	getValueHandler()
EipTag	prepareTag(String query)

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

awaitDiscoverComplete, awaitSetupComplete, canBrowse, canPing, canSubscribe, fireDiscoverEvent, getAllFields, getConnection, getMetadata, getOptimizer, getStackConfigurer, initializePipeline, resolveTransportConfigurationClass

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.PlcDriver

discoveryRequestBuilder

Field Detail

PORT

public static final int PORT

See Also:

Constant Field Values

Constructor Detail

EIPDriver

public EIPDriver()

Method Detail

getProtocolCode

public String getProtocolCode()

getProtocolName

public String getProtocolName()

getConfigurationClass

protected Class<? extends PlcConnectionConfiguration> getConfigurationClass()

Specified by:

getConfigurationClass in class GeneratedDriverBase<EipPacket>

getTransportConfigurationClass

protected Optional<Class<? extends PlcTransportConfiguration>> getTransportConfigurationClass(String transportCode)

Overrides:

getTransportConfigurationClass in class GeneratedDriverBase<EipPacket>

getDefaultTransportCode

protected Optional<String> getDefaultTransportCode()

Overrides:

getDefaultTransportCode in class GeneratedDriverBase<EipPacket>

getSupportedTransportCodes

protected List<String> getSupportedTransportCodes()

Overrides:

getSupportedTransportCodes in class GeneratedDriverBase<EipPacket>

getTagHandler

protected PlcTagHandler getTagHandler()

Specified by:

getTagHandler in class GeneratedDriverBase<EipPacket>

getValueHandler

protected PlcValueHandler getValueHandler()

Specified by:

getValueHandler in class GeneratedDriverBase<EipPacket>

awaitDisconnectComplete

protected boolean awaitDisconnectComplete()

This protocol doesn't have a disconnect procedure, so there is no need to wait for a login to finish.

Overrides:

awaitDisconnectComplete in class GeneratedDriverBase<EipPacket>

Returns:

false

canRead

protected boolean canRead()

Overrides:

canRead in class GeneratedDriverBase<EipPacket>

canWrite

protected boolean canWrite()

Overrides:

canWrite in class GeneratedDriverBase<EipPacket>

getStackConfigurer

protected ProtocolStackConfigurer<EipPacket> getStackConfigurer()

Specified by:

getStackConfigurer in class GeneratedDriverBase<EipPacket>

getConnection

public PlcConnection getConnection(String connectionString)
                            throws PlcConnectionException

Specified by:

getConnection in interface PlcDriver

Overrides:

getConnection in class GeneratedDriverBase<EipPacket>

Throws:

PlcConnectionException

prepareTag

public EipTag prepareTag(String query)