SecureBlackbox 2020 Qt Edition

Questions / Feedback?

OptionsRequest Event

Reports an OPTIONS request.

Syntax

class RESTServerOptionsRequestEventParams {
public:
  qint64 ConnectionID();
  const QString &URI();
  bool Handled();
  void SetHandled(bool bHandled);
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void OptionsRequest(RESTServerOptionsRequestEventParams *e);
// Or, subclass RESTServer and override this emitter function. virtual int FireOptionsRequest(RESTServerOptionsRequestEventParams *e) {...}

Remarks

The class fires this event to notify the application about an OPTIONS request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Handled to true to indicate that your application's code will take care of the request. The application does it by providing the necessary details via SetResponseStatus, SetResponseHeader, and SetResponseFile methods. If the returned value of Handled is false, the server will try to take care of the request automatically by searching for the requested resource in DocumentRoot.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 Qt Edition - Version 20.0 [Build 8154]