Class GatewayInterface.AbstractMessagePrinter
- java.lang.Object
-
- com.inductiveautomation.ignition.client.gateway_interface.GatewayInterface.AbstractMessagePrinter
-
- All Implemented Interfaces:
GatewayInterface.MessagePrinter
- Direct Known Subclasses:
GatewayInterface.BasicMessage
,GatewayInterface.InvokeMessage
- Enclosing class:
- GatewayInterface
public abstract static class GatewayInterface.AbstractMessagePrinter extends java.lang.Object implements GatewayInterface.MessagePrinter
A MessagePrinter that has some static string values pre-encoded into byte[]'s
-
-
Field Summary
Fields Modifier and Type Field Description protected static byte[]
arg1
<arg name="protected static byte[]
arg2
"><![CDATA[protected static byte[]
arg3
]]></arg>protected static byte[]
argindex
protected static byte[]
argnull
protected static byte[]
end
</messagebody></message>protected static byte[]
head1
<message><messagetype>protected static byte[]
head2
</messagetype><messagebody>protected int
type
-
Constructor Summary
Constructors Constructor Description AbstractMessagePrinter(int type)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getMinConnectionMode()
Minimum connection mode needed to run, or zero to always run.StatMetric
getStatMetric()
A stat metric to update when this message finishes.protected void
writeArg(java.io.OutputStream pw, java.lang.String argName, java.lang.String argVal)
protected void
writeArg(java.io.OutputStream pw, java.lang.String argName, java.lang.String argVal, int idx)
protected void
writeHead(java.io.OutputStream pw)
Opens message element, writes messagetype element, opens messagebody element-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.inductiveautomation.ignition.client.gateway_interface.GatewayInterface.MessagePrinter
printMessage
-
-
-
-
Field Detail
-
head1
protected static byte[] head1
<message><messagetype>
-
head2
protected static byte[] head2
</messagetype><messagebody>
-
arg1
protected static byte[] arg1
<arg name="
-
arg2
protected static byte[] arg2
"><![CDATA[
-
arg3
protected static byte[] arg3
]]></arg>
-
argnull
protected static byte[] argnull
-
argindex
protected static byte[] argindex
-
end
protected static byte[] end
</messagebody></message>
-
type
protected int type
-
-
Method Detail
-
writeHead
protected void writeHead(java.io.OutputStream pw) throws java.io.IOException
Opens message element, writes messagetype element, opens messagebody element- Throws:
java.io.IOException
-
writeArg
protected void writeArg(java.io.OutputStream pw, java.lang.String argName, java.lang.String argVal) throws java.io.IOException
- Throws:
java.io.IOException
-
writeArg
protected void writeArg(java.io.OutputStream pw, java.lang.String argName, java.lang.String argVal, int idx) throws java.io.IOException
- Throws:
java.io.IOException
-
getMinConnectionMode
public int getMinConnectionMode()
Description copied from interface:GatewayInterface.MessagePrinter
Minimum connection mode needed to run, or zero to always run.- Specified by:
getMinConnectionMode
in interfaceGatewayInterface.MessagePrinter
-
getStatMetric
public StatMetric getStatMetric()
Description copied from interface:GatewayInterface.MessagePrinter
A stat metric to update when this message finishes. Optional, may be null.- Specified by:
getStatMetric
in interfaceGatewayInterface.MessagePrinter
-
-