Package org.openremote.agent.protocol.tcp

Class TCPProtocol

java.lang.Object

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

org.openremote.agent.protocol.io.AbstractIOClientProtocol<T,U,V,W,X>

org.openremote.agent.protocol.io.AbstractNettyIOClientProtocol<T,U,W,X,V>

org.openremote.agent.protocol.tcp.AbstractTCPClientProtocol<TCPProtocol,TCPAgent,org.openremote.model.asset.agent.DefaultAgentLink,String,TCPIOClient<String>>

org.openremote.agent.protocol.tcp.TCPProtocol

All Implemented Interfaces:

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

public class TCPProtocol
extends AbstractTCPClientProtocol<TCPProtocol,TCPAgent,org.openremote.model.asset.agent.DefaultAgentLink,String,TCPIOClient<String>>

This is a generic TCP client protocol for communicating with TCP servers; it uses the TCPIOClient to handle the communication and all messages are processed as strings; if you require custom message type handling or more specific handling then sub class the AbstractTCPClientProtocol).

To use this protocol create a TCPAgent.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROTOCOL_DISPLAY_NAME
protected final List<org.openremote.model.util.Pair<org.openremote.model.attribute.AttributeRef,Consumer<String>>>	protocolMessageConsumers

Fields inherited from class org.openremote.agent.protocol.io.AbstractIOClientProtocol

client

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
TCPProtocol(TCPAgent agent)

Method Summary

Modifier and Type	Method	Description
protected String	createWriteMessage(org.openremote.model.attribute.Attribute<?> attribute, org.openremote.model.asset.agent.DefaultAgentLink agentLink, org.openremote.model.attribute.AttributeEvent event, Object processedValue)	Generate the actual message to send to the IOClient for this AttributeEvent
protected void	doLinkAttribute(String assetId, org.openremote.model.attribute.Attribute<?> attribute, org.openremote.model.asset.agent.DefaultAgentLink agentLink)	Link an Attribute to its linked Agent.
protected void	doUnlinkAttribute(String assetId, org.openremote.model.attribute.Attribute<?> attribute, org.openremote.model.asset.agent.DefaultAgentLink agentLink)	Unlink an Attribute from its linked Agent.
protected Supplier<io.netty.channel.ChannelHandler[]>	getEncoderDecoderProvider()	Gets the Netty ChannelHandlers for the IO client
String	getProtocolName()	Get the name for this protocol
protected void	onMessageReceived(String message)	Called when the IOClient receives a message from the server

Methods inherited from class org.openremote.agent.protocol.tcp.AbstractTCPClientProtocol

doCreateIoClient

Methods inherited from class org.openremote.agent.protocol.io.AbstractNettyIOClientProtocol

createIoClient

Methods inherited from class org.openremote.agent.protocol.io.AbstractIOClientProtocol

doLinkedAttributeWrite, doStart, doStop, getGenericStringEncodersAndDecoders, getProtocolInstanceUri, onConnectionStatusChanged

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

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

prefixLogMessage

Field Details

PROTOCOL_DISPLAY_NAME

public static final String PROTOCOL_DISPLAY_NAME

See Also:

• Constant Field Values

protocolMessageConsumers

protected final List<org.openremote.model.util.Pair<org.openremote.model.attribute.AttributeRef,Consumer<String>>> protocolMessageConsumers

Constructor Details

TCPProtocol

public TCPProtocol(TCPAgent agent)

Method Details

getProtocolName

public String getProtocolName()

Description copied from interface: org.openremote.model.asset.agent.Protocol

Get the name for this protocol

doLinkAttribute

protected void doLinkAttribute(String assetId,
 org.openremote.model.attribute.Attribute<?> attribute,
 org.openremote.model.asset.agent.DefaultAgentLink agentLink)

Description copied from class: AbstractProtocol

Link an Attribute to its linked Agent.

Specified by:

doLinkAttribute in class AbstractProtocol<TCPAgent,org.openremote.model.asset.agent.DefaultAgentLink>

doUnlinkAttribute

protected void doUnlinkAttribute(String assetId,
 org.openremote.model.attribute.Attribute<?> attribute,
 org.openremote.model.asset.agent.DefaultAgentLink agentLink)

Description copied from class: AbstractProtocol

Unlink an Attribute from its linked Agent.

Specified by:

doUnlinkAttribute in class AbstractProtocol<TCPAgent,org.openremote.model.asset.agent.DefaultAgentLink>

getEncoderDecoderProvider

protected Supplier<io.netty.channel.ChannelHandler[]> getEncoderDecoderProvider()

Description copied from class: AbstractNettyIOClientProtocol

Gets the Netty ChannelHandlers for the IO client

Specified by:

getEncoderDecoderProvider in class AbstractNettyIOClientProtocol<TCPProtocol,TCPAgent,String,TCPIOClient<String>,org.openremote.model.asset.agent.DefaultAgentLink>

onMessageReceived

protected void onMessageReceived(String message)

Description copied from class: AbstractIOClientProtocol

Called when the IOClient receives a message from the server

Specified by:

onMessageReceived in class AbstractIOClientProtocol<TCPProtocol,TCPAgent,String,TCPIOClient<String>,org.openremote.model.asset.agent.DefaultAgentLink>

createWriteMessage

protected String createWriteMessage(org.openremote.model.attribute.Attribute<?> attribute,
 org.openremote.model.asset.agent.DefaultAgentLink agentLink,
 org.openremote.model.attribute.AttributeEvent event,
 Object processedValue)

Description copied from class: AbstractIOClientProtocol

Generate the actual message to send to the IOClient for this AttributeEvent

Specified by:

createWriteMessage in class AbstractIOClientProtocol<TCPProtocol,TCPAgent,String,TCPIOClient<String>,org.openremote.model.asset.agent.DefaultAgentLink>