Package com.automation_pros.odva.cip.core

Class IOConx

java.lang.Object

com.automation_pros.odva.cip.types.CipTree

com.automation_pros.odva.cip.types.CipTreeCtx

com.automation_pros.odva.cip.types.CipObject

com.automation_pros.odva.cip.core.CipInstance

com.automation_pros.odva.cip.core.ConxInstance

com.automation_pros.odva.cip.core.LocalConx

com.automation_pros.odva.cip.core.IOConx

All Implemented Interfaces:

DataContext, CipReplyConsumer, AppLinkBase, AppOwner, AppProducer, AttributeHolder, LinkConsumer, java.lang.Comparable<CipInstance>

public class IOConx
extends LocalConx

Nested Class Summary

Nested classes/interfaces inherited from class com.automation_pros.odva.cip.types.CipObject

CipObject.FutureMultipleReply

Nested classes/interfaces inherited from class com.automation_pros.odva.cip.types.CipTree

CipTree.ChildMap

Field Summary

Fields

Modifier and Type	Field	Description
protected AppOwnerAdapter	aoa
protected AppProducerAdapter	apa
protected Connectable	appProducer
protected byte[]	lastProduced
protected int	lastProducedActual
protected java.lang.ref.Cleaner.Cleanable	lastProducedClean
protected long	lastTxID
protected java.util.concurrent.ScheduledFuture<?>	producerFuture
protected long	TxInhDeadline
long	TxInhnsec
protected long	TxT2ODeadline
long	TxT2Onsec

Fields inherited from class com.automation_pros.odva.cip.core.ConxInstance

appConsumer, connSN, consapi, consid, conssize, consumer, cxstate, deadline, dirtrigcls, DNconsid, DNmsggrps, DNprodid, insttype, linkProducer, O2Tapi, O2TconnID, O2TconnIDrq, O2Tparams, O2Trpi, oport, origSN, pktrate, prodapi, prodid, prodinh, prodsize, producer, T2Oapi, T2OconnID, T2OconnIDrq, T2Oparams, T2Orpi, timeoutMult, tport, vendor, WDTDeadline, WDTnsec, wdtoact

Fields inherited from class com.automation_pros.odva.cip.core.CipInstance

attr_all

Fields inherited from class com.automation_pros.odva.cip.types.CipObject

iLogger, name

Fields inherited from class com.automation_pros.odva.cip.types.CipTree

children, objEPath, parent, segment

Fields inherited from interface com.automation_pros.odva.cip.data.DataContext

emptyContext

Constructor Summary

Constructors

Constructor	Description
IOConx(ConxClass parent, FwdOpenReq request, java.util.List<CipPath> appPaths, java.util.List<CipObject> appObjects, SimpleDataSeg data, int inhibit)
IOConx(InstanceSeg inst, ConxClass parent, FwdOpenReq request, java.util.List<CipPath> appPaths, java.util.List<CipObject> appObjects, SimpleDataSeg data, int inhibit)

Method Summary

Modifier and Type	Method	Description
void	accept(CipReply t)	Subclasses whose constructor defers replying to the forward open request must add the connection to the request's callback list, and call super.accept() to finalize the connection details.
void	appProduce(long txID, java.nio.ByteBuffer payload)	Connections must be able to receive arbitrary payloads from their connected applications.
protected void	ensureLastProduced(int size)
protected AppConsumer	getAppConsumer(CipObject obj)
void	linkConsume(long txID, java.nio.ByteBuffer payload)	Connections must be able to receive arbitrary payloads from port links.
void	shutdown()

Methods inherited from class com.automation_pros.odva.cip.core.LocalConx

isOrigin

Methods inherited from class com.automation_pros.odva.cip.core.ConxInstance

disconnect, getConsumer, getConsumerID, getConsumerSize, getConsumeRTF, getConxData, getCXState, getDeadline, getDirTrigCls, getDNConsumerID, getDNMsgGroups, getDNProducerID, getInhibit, getInstanceType, getPacketRate, getParent, getProducer, getProducerID, getProducerSize, getProduceRTF, getRealTimeMode, isDisconnected, setRealTimeMode, toString

Methods inherited from class com.automation_pros.odva.cip.core.CipInstance

compareTo, getAttribute, getEPathImpl, getSegment, isPrivate, number, service, setParent

Methods inherited from class com.automation_pros.odva.cip.types.CipObject

executor, getChild, getDevice, getDisplayName, getName, isShutdown, logger, onReplacement, removeChildSymbol, scheduler, setChild, setChildSymbol, setName

Methods inherited from class com.automation_pros.odva.cip.types.CipTreeCtx

getCtxDataImpl, getNamedDef, getParentDataCtx, getTypeByCRC, getTypeByName, getTypesImpl

Methods inherited from class com.automation_pros.odva.cip.types.CipTree

cleanup, entrySet, follow, getChildren, getEPath, keySet, removeChild, setSegment

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.automation_pros.odva.cip.types.AttributeHolder

executor, getChild, getDisplayName, getEPath, isShutdown, logger, scheduler

Methods inherited from interface com.automation_pros.odva.cip.data.DataContext

fromEnum, getCtxData, getCtxDataOrNull, getTypes, makeHosted, makeUnhosted, toEnum

Field Detail

appProducer

protected Connectable appProducer

TxT2Onsec

public long TxT2Onsec

TxInhnsec

public long TxInhnsec

producerFuture

protected java.util.concurrent.ScheduledFuture<?> producerFuture

TxT2ODeadline

protected long TxT2ODeadline

TxInhDeadline

protected long TxInhDeadline

aoa

protected AppOwnerAdapter aoa

apa

protected AppProducerAdapter apa

lastProduced

protected byte[] lastProduced

lastProducedActual

protected int lastProducedActual

lastProducedClean

protected java.lang.ref.Cleaner.Cleanable lastProducedClean

lastTxID

protected long lastTxID

Constructor Detail

IOConx

public IOConx(InstanceSeg inst,
              ConxClass parent,
              FwdOpenReq request,
              java.util.List<CipPath> appPaths,
              java.util.List<CipObject> appObjects,
              SimpleDataSeg data,
              int inhibit)

IOConx

public IOConx(ConxClass parent,
              FwdOpenReq request,
              java.util.List<CipPath> appPaths,
              java.util.List<CipObject> appObjects,
              SimpleDataSeg data,
              int inhibit)

Method Detail

getAppConsumer

protected AppConsumer getAppConsumer(CipObject obj)

shutdown

public void shutdown()

Specified by:

shutdown in interface AttributeHolder

Overrides:

shutdown in class ConxInstance

accept

public void accept(CipReply t)

Description copied from class: ConxInstance

Subclasses whose constructor defers replying to the forward open request must add the connection to the request's callback list, and call super.accept() to finalize the connection details. If not shutdown on return, proceed with subclass-specific finalization. That must include a call to getParent().bgPing().

Specified by:

accept in interface CipReplyConsumer

Overrides:

accept in class ConxInstance

Parameters:

t - Any CipReply. If a Forward Open Response, apply the final connection parameters.

linkConsume

public void linkConsume(long txID,
                        java.nio.ByteBuffer payload)

Description copied from class: ConxInstance

Connections must be able to receive arbitrary payloads from port links. These would be TCP or UDP sockets in Ethernet/IP, platform-dependent OS devices in DeviceNet or other physical transports, or peer connections in bridging.

The connection's watchdog timer is updated on link packet processing.

Specified by:

linkConsume in interface LinkConsumer

Overrides:

linkConsume in class ConxInstance

Parameters:

txID - Link-specific transaction ID. Not always 64 bits, if used at all.

payload - The CIP payload extracted from the outer transport protocol.

ensureLastProduced

protected void ensureLastProduced(int size)

appProduce

public void appProduce(long txID,
                       java.nio.ByteBuffer payload)

Description copied from class: ConxInstance

Connections must be able to receive arbitrary payloads from their connected applications. These would be producing assemblies in typical I/O connections, producing tags in a Logix system, message replies from a message router, or a bridging connection peer.

Application packet production does not normally update the connection's watchdog timer.

Specified by:

appProduce in interface AppProducer

Overrides:

appProduce in class ConxInstance

Parameters:

txID - Transaction ID. Not always 64 bits, if used at all. If applicable, matches the txID consumed by the application for this message.

payload - The CIP payload to send to the outer transport protocol.