public class EventWait extends APIServlet.APIRequestHandler
The EventWait API will wait for one of the server events registered by EventRegister. EventWait will return immediately if one or more events have occurred since the last time EventWait was called. All pending events will be returned in a single response. The events remain registered so successive calls to EventWait can be made without another call to EventRegister.
Request parameters:
Response parameters:
Error Response parameters:
Event object:
Event names:
Event object identifiers:
Modifier and Type | Method and Description |
---|---|
protected boolean |
allowRequiredBlockParameters() |
protected boolean |
isChainSpecific() |
protected org.json.simple.JSONStreamAware |
processRequest(javax.servlet.http.HttpServletRequest req)
Process the EventWait API request
The response will be returned immediately if there are any
pending events.
|
protected boolean |
requirePost() |
canHaveRecipient, getAPITags, getCreateTransactionTypes, getFileParameters, getParameters, getSensitiveParameters, isIgnisOnly, isTextArea, processRequest, requireBlockchain, requireFullClient, requirePassword, startDbTransaction
protected org.json.simple.JSONStreamAware processRequest(javax.servlet.http.HttpServletRequest req) throws ParameterException
processRequest
in class APIServlet.APIRequestHandler
req
- API requestParameterException
- Invalid parameter specifiedprotected final boolean requirePost()
requirePost
in class APIServlet.APIRequestHandler
protected boolean allowRequiredBlockParameters()
allowRequiredBlockParameters
in class APIServlet.APIRequestHandler
protected boolean isChainSpecific()
isChainSpecific
in class APIServlet.APIRequestHandler