Errai 3.0.1-SNAPSHOT

org.jboss.errai.bus.client.api
Interface HasEncoded


public interface HasEncoded

This interface indicates to the bus whether or not the Message being routed already contains a pre-built JSON encoding. Messages that implement this interface have complete control over their own on-the-wire representation.

As of Errai 2.0, there is no corresponding interface on the message receiver end of the API, so the message's custom encoding must be consistent with the Errai bus format. Therefore, the only real use case for this functionality is as a performance optimization for messages that already have a pre-computed JSON representation lying around.


Method Summary
 String getEncoded()
          Gets the encoded JSON string to be used for this message when it is being sent via the Errai bus.
 

Method Detail

getEncoded

String getEncoded()
Gets the encoded JSON string to be used for this message when it is being sent via the Errai bus.

Returns:
the encoded JSON string

Errai 3.0.1-SNAPSHOT

Copyright © 2013-2014 JBoss, a division of Red Hat. All Rights Reserved.