org.wso2.transport.http.netty.contract.websocket

Interface WebSocketMessage

All Known Subinterfaces:

WebSocketBinaryMessage, WebSocketCloseMessage, WebSocketControlMessage, WebSocketHandshaker, WebSocketTextMessage

All Known Implementing Classes:

DefaultWebSocketBinaryMessage, DefaultWebSocketCloseMessage, DefaultWebSocketControlMessage, DefaultWebSocketHandshaker, DefaultWebSocketMessage, DefaultWebSocketTextMessage

public interface WebSocketMessage

This is the common interface for all WebSocket messages. Note: Use this interface in the application level only and only if the user needs only the channel details of a WebSocket message otherwise use the extensions of this interface.

Method Summary

Modifier and Type	Method and Description
String	getTarget() Retrieve the target of the application as a String.
WebSocketConnection	getWebSocketConnection() Retrieve the session of the connection.
boolean	isServerMessage() Check whether the message is coming from server connector or client connector.

Method Detail

getTarget

String getTarget()

Retrieve the target of the application as a String.

Returns:

the target of the application.

isServerMessage

boolean isServerMessage()

Check whether the message is coming from server connector or client connector.

Returns:

true if the message is coming from server connector else return false if the message is coming from client connector.

getWebSocketConnection

WebSocketConnection getWebSocketConnection()

Retrieve the session of the connection.

Returns:

the session of the connection.