org.flmelody.core.ws

Class WebSocketWindwardContext

java.lang.Object

org.flmelody.core.context.AbstractWindwardContext

org.flmelody.core.ws.WebSocketWindwardContext

All Implemented Interfaces:

WindwardContext

public class WebSocketWindwardContext
extends AbstractWindwardContext

Author:

esotericman

Field Summary

Fields inherited from class org.flmelody.core.context.AbstractWindwardContext

windwardRequest, windwardResponse

Constructor Summary

Constructors

Constructor and Description
WebSocketWindwardContext(WindwardRequest windwardRequest, WindwardResponse windwardResponse)

Method Summary

Modifier and Type	Method and Description
Object	getWebSocketData()
WebSocketEvent	getWebSocketEvent()
Boolean	isCacheable() whether context can be cached
boolean	isUpgradedContext()
void	setHttpResponse(boolean httpResponse)
void	setWebSocketData(Object webSocketData)
void	setWebSocketEvent(WebSocketEvent webSocketEvent)
<T> void	write(int code, String contentType, T data) response with specific contentType
<T> void	writeBinaryData(T data) send any data

Methods inherited from class org.flmelody.core.context.AbstractWindwardContext

close, getPathVariables, getRequestBody, getRequestParameter, getRequestParameters, isClosed, windwardRequest, write, writeJson, writeJson, writeString, writeString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebSocketWindwardContext

public WebSocketWindwardContext(WindwardRequest windwardRequest,
                                WindwardResponse windwardResponse)

Method Detail

setWebSocketEvent

public void setWebSocketEvent(WebSocketEvent webSocketEvent)

setWebSocketData

public void setWebSocketData(Object webSocketData)

setHttpResponse

public void setHttpResponse(boolean httpResponse)

getWebSocketEvent

public WebSocketEvent getWebSocketEvent()

getWebSocketData

public Object getWebSocketData()

isUpgradedContext

public boolean isUpgradedContext()

write

public <T> void write(int code,
                      String contentType,
                      T data)

Description copied from class: AbstractWindwardContext

response with specific contentType

Specified by:

write in interface WindwardContext

Overrides:

write in class AbstractWindwardContext

Type Parameters:

T - data

Parameters:

code - code

contentType - contentType

data - data

writeBinaryData

public <T> void writeBinaryData(T data)

send any data

Type Parameters:

T - data type

Parameters:

data - any data or raw data

isCacheable

public Boolean isCacheable()

Description copied from interface: WindwardContext

whether context can be cached

Returns:

cacheable flag