Qore DebugHandler Module Reference
0.1
|
the main web socket debug handler class More...
Public Member Functions | |
constructor (*HttpServer::AbstractAuthenticator auth, WebSocketDebugProgramControl dpc, *list args) | |
create the object optionally with the given AbstractAuthenticator More... | |
WebSocketHandler::WebSocketConnection | getConnectionImpl (hash cx, hash hdr, string cid) |
called when a connection is established; the default implementation creates a WebSocketConnection object | |
hash | handleRequest (hash cx, hash hdr, *data b) |
called by the HTTP server to handle incoming HTTP requests More... | |
the main web socket debug handler class
connections are represented by an object descended from WebSocketConnection. WebSocketHandler::WebSocketHandler::getConnectionImpl() returns a suitable object for each connection, this method can be overridden in subclasses to return a custom object for each connection if required.
Websocket connections are identified by their HTTP connection ID as passed in WebSocketHandler::handleRequest() in the "cx.id"
argument when the connection is first established.
DebugHandler::WebSocketDebugHandler::constructor | ( | *HttpServer::AbstractAuthenticator | auth, |
WebSocketDebugProgramControl | dpc, | ||
*list | args | ||
) |
create the object optionally with the given AbstractAuthenticator
auth | the authentication object to use to authenticate connections (see AbstractAuthenticator); if no AbstractAuthenticator object is passed, then by default no authentication will be required |
dpc | the debug program controller object |
args | an optional list of arguments for the setLogger() method |
called by the HTTP server to handle incoming HTTP requests
To accept a dedicated connection; make sure the return value hash's "code"
key is 101 (ie "Switching Protocols"
) and the "close"
key is not False
cx | call context hash; this hash will have the following keys:
|
hdr | incoming header hash; all keys will be converted to lower-case, additionally the following keys will be present:
|
b | message body, if any |
"code"
is 101 (ie "Switching Protocols"
) and the "close"
key is not False:"code"
: the HTTP return code (see HttpServer::HttpCodes) (101 "Switching Protocols"
to accept the dedicated connection, in which case the start() method will be called)"body"
: the message body to return in the response"close"
: (optional) set this key to True if the connection should be unconditionally closed when the handler returns"hdr"
: (optional) set this key to a hash of extra header information to be returned with the response; this class returns the Qore websocket debug protocol version in the header "QoreDebugWsProtocol"
Websocket connections are identified by their HTTP connection ID as passed in "cx.id"
Reimplemented from WebSocketHandler::WebSocketHandler.