Package org.basex.http.ws

Class WsResponse

java.lang.Object

org.basex.http.web.WebResponse

org.basex.http.ws.WsResponse

public final class WsResponse
extends WebResponse

Creates WebSocket responses.

Author:

BaseX Team 2005-21, BSD License, Johannes Finckh

Nested Class Summary

Nested classes/interfaces inherited from class org.basex.http.web.WebResponse

WebResponse.Response

Field Summary

Fields inherited from class org.basex.http.web.WebResponse

ctx, qc

Method Summary

Modifier and Type	Method	Description
protected void	bind(Expr[] args, Object data)	Binds values to the function parameters.
protected void	init(WebFunction function)	Creates and returns a function instance that can be evaluated.
WebResponse.Response	serialize(boolean body)	Serializes the response.

Methods inherited from class org.basex.http.web.WebResponse

create

Methods inherited from class java.lang.Object

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

Method Details

init

protected void init(WebFunction function)
             throws QueryException

Description copied from class: WebResponse

Creates and returns a function instance that can be evaluated.

Specified by:

init in class WebResponse

Parameters:

function - function template

Throws:

QueryException - query exception

bind

protected void bind(Expr[] args,
 Object data)
             throws QueryException

Description copied from class: WebResponse

Binds values to the function parameters.

Specified by:

bind in class WebResponse

Parameters:

args - arguments

data - additional data (result, function, error, can be null)

Throws:

QueryException - query exception

serialize

public WebResponse.Response serialize(boolean body)
                               throws QueryException,
IOException

Description copied from class: WebResponse

Serializes the response.

Specified by:

serialize in class WebResponse

Parameters:

body - serialize body (if false, only the headers will be assigned)

Returns:

response type

Throws:

QueryException - query exception

IOException - I/O exception