com.inductiveautomation.ignition.client.gateway_interface

Interface GatewayInterface.MessagePrinter

All Known Implementing Classes:

GatewayInterface.AbstractMessagePrinter, GatewayInterface.BasicMessage, GatewayInterface.InvokeMessage, MessageBuilder, RunPrepStmtMessage, RunUpdateQueryMessage

Enclosing class:

GatewayInterface

public static interface GatewayInterface.MessagePrinter

A MessagePrinter simply prints its message to an outputstream. This is used as an alternative to a String based message in cases where we don't want to incur the overhead of creating String objects, opting instead to stream the message in pieces. It can also specify a min connection mode needed to run.

Method Summary

Modifier and Type	Method and Description
int	getMinConnectionMode() Minimum connection mode needed to run, or zero to always run.
StatMetric	getStatMetric() A stat metric to update when this mesage finishes.
void	printMessage(java.io.OutputStream pw)

Method Detail

printMessage

void printMessage(java.io.OutputStream pw)
           throws java.io.IOException

Throws:

java.io.IOException

getMinConnectionMode

int getMinConnectionMode()

Minimum connection mode needed to run, or zero to always run.

getStatMetric

StatMetric getStatMetric()

A stat metric to update when this mesage finishes. Optional, may be null.