Interface MessageChannel
- 
- All Known Implementing Classes:
- WebSocketChannel
 
 public interface MessageChannelInterface representing the channel used by the backend to send messages down to the client (the websocket).
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description voidclose()Close the message channeljava.lang.StringgetPageId()Returns the view group identifier, which is used to differentiate between different instances of the same project .java.lang.StringgetProject()Returns the name of the project, which is unique.booleanisClosed()booleanisOpen()voidsend(java.lang.String protocol, java.lang.String payload)Sends a message to be handled by the appropriate handler (as identified by the protocol)
 
- 
- 
- 
Method Detail- 
getProjectjava.lang.String getProject() Returns the name of the project, which is unique.
 - 
getPageIdjava.lang.String getPageId() Returns the view group identifier, which is used to differentiate between different instances of the same project . For a live project running in a browser, this might be the unique browser tab identifier. For a designer, this may be a specific workspace tab.
 - 
isOpenboolean isOpen() - Returns:
- false if the message channel not connected
 
 - 
isClosedboolean isClosed() - Returns:
- true iff this channel was closed by the local side of this connection (in order words: from a call
 to close()
 
 - 
sendvoid send(java.lang.String protocol, java.lang.String payload) throws java.io.IOExceptionSends a message to be handled by the appropriate handler (as identified by the protocol)- Throws:
- java.io.IOException
 
 - 
closevoid close() Close the message channel
 
- 
 
-