Interface MessageChannel
-
- All Known Implementing Classes:
WebSocketChannel
public interface MessageChannel
Interface representing the channel used by the backend to send messages down to the client (the websocket).
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
close()
Close the message channeljava.lang.String
getPageId()
Returns the view group identifier, which is used to differentiate between different instances of the same project .java.lang.String
getProject()
Returns the name of the project, which is unique.boolean
isOpen()
void
send(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
-
getProject
java.lang.String getProject()
Returns the name of the project, which is unique.
-
getPageId
java.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.
-
isOpen
boolean isOpen()
- Returns:
- false if the message channel not connected
-
send
void send(java.lang.String protocol, java.lang.String payload) throws java.io.IOException
Sends a message to be handled by the appropriate handler (as identified by the protocol)- Throws:
java.io.IOException
-
close
void close()
Close the message channel
-
-