Package org.openremote.agent.protocol.tcp

Class AbstractTCPServerProtocol<R,S extends AbstractTCPServer<R>,T extends AbstractTCPServerProtocol<R,S,T,U,V>,U extends AbstractTCPServerAgent<U,T,V>,V extends org.openremote.model.asset.agent.AgentLink<?>>

java.lang.Object

org.openremote.agent.protocol.AbstractProtocol<U,V>

org.openremote.agent.protocol.tcp.AbstractTCPServerProtocol<R,S,T,U,V>

All Implemented Interfaces:

org.openremote.model.asset.agent.Protocol<U>

public abstract class AbstractTCPServerProtocol<R,S extends AbstractTCPServer<R>,T extends AbstractTCPServerProtocol<R,S,T,U,V>,U extends AbstractTCPServerAgent<U,T,V>,V extends org.openremote.model.asset.agent.AgentLink<?>>
extends AbstractProtocol<U,V>

This is an abstract protocol for creating TCP Server protocols. This allows TCP clients to connect and exchange data. It is up to the concrete implementations whether or not linked Attributes can be used with this protocol and to define the semantics of these linked attributes.

Field Summary

Fields

Modifier and Type	Field	Description
protected S	tcpServer

Fields inherited from class org.openremote.agent.protocol.AbstractProtocol

agent, assetService, datapointService, dynamicAttributes, executorService, linkedAttributes, messageBrokerContext, predictedDatapointService, producerTemplate, timerService

Fields inherited from interface org.openremote.model.asset.agent.Protocol

ACTUATOR_TOPIC, ACTUATOR_TOPIC_TARGET_PROTOCOL, DYNAMIC_TIME_PLACEHOLDER_REGEXP, DYNAMIC_VALUE_PLACEHOLDER, DYNAMIC_VALUE_PLACEHOLDER_REGEXP, SENSOR_QUEUE, SENSOR_QUEUE_SOURCE_PROTOCOL

Constructor Summary

Constructors

Constructor	Description
AbstractTCPServerProtocol(U agent)

Method Summary

Modifier and Type	Method	Description
protected abstract S	createTcpServer(int port, String bindAddress, U agent)
protected void	doStart(org.openremote.model.Container container)	Start this protocol instance
protected void	doStop(org.openremote.model.Container container)	Stop this protocol instance
protected void	onServerConnectionStatusChanged(org.openremote.model.asset.agent.ConnectionStatus connectionStatus)
protected void	startTcpServer()
protected void	stopTcpServer()

Methods inherited from class org.openremote.agent.protocol.AbstractProtocol

doLinkAttribute, doLinkedAttributeWrite, doUnlinkAttribute, getAgent, getLinkedAttributes, linkAttribute, processLinkedAttributeWrite, sendAttributeEvent, sendAttributeEvent, setConnectionStatus, start, stop, toString, unlinkAttribute, updateAgentAttribute, updateLinkedAttribute, updateLinkedAttribute

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openremote.model.asset.agent.Protocol

getProtocolInstanceUri, getProtocolName, prefixLogMessage

Field Details

tcpServer

protected S extends AbstractTCPServer<R> tcpServer

Constructor Details

AbstractTCPServerProtocol

public AbstractTCPServerProtocol(U agent)

Method Details

doStart

protected void doStart(org.openremote.model.Container container)
                throws Exception

Description copied from class: AbstractProtocol

Start this protocol instance

Specified by:

doStart in class AbstractProtocol<U extends AbstractTCPServerAgent<U,T,V>,V extends org.openremote.model.asset.agent.AgentLink<?>>

Throws:

Exception

onServerConnectionStatusChanged

protected void onServerConnectionStatusChanged(org.openremote.model.asset.agent.ConnectionStatus connectionStatus)

doStop

protected void doStop(org.openremote.model.Container container)
               throws Exception

Description copied from class: AbstractProtocol

Stop this protocol instance

Specified by:

doStop in class AbstractProtocol<U extends AbstractTCPServerAgent<U,T,V>,V extends org.openremote.model.asset.agent.AgentLink<?>>

Throws:

Exception

createTcpServer

protected abstract S createTcpServer(int port,
 String bindAddress,
 U agent)

startTcpServer

protected void startTcpServer()

stopTcpServer

protected void stopTcpServer()