Package com.inductiveautomation.ignition.common.rpc

Interface ClientRpcSerializer

All Known Subinterfaces:

RpcSerializer

All Known Implementing Classes:

ProtoRpcSerializer

public interface ClientRpcSerializer

The Client half of the negotiation of RPC payloads between the gateway and clients/designers.

See Also:

• GatewayRpcSerializer
• ProtoRpcSerializer

Method Summary

Modifier and Type	Method	Description
Object	readReturnValue(InputStream stream, RpcCall call)
void	writeParameters(OutputStream stream, RpcCall call, Object... parameters)	Write the parameters of an RPC call out to the gateway.

Method Details

writeParameters

void writeParameters(OutputStream stream,
 RpcCall call,
 Object... parameters)
              throws IOException

Write the parameters of an RPC call out to the gateway.

Parameters:

call - The call information, useful for disambiguation or debugging.

parameters - An array (possibly empty and possibly containing null elements) of parameters to write.

Throws:

IOException - If there was any issue writing to the stream.

readReturnValue

Object readReturnValue(InputStream stream,
 RpcCall call)
                throws Exception

Returns:

Whatever the return value was from the RPC call; possibly null.

Throws:

IOException - If there was an error reading from the stream.

Exception - If an error was thrown on the gateway (and sent down to the client).