HeadRequest Event
Reports a HEAD request.
Syntax
ANSI (Cross Platform) virtual int FireHeadRequest(RESTServerHeadRequestEventParams *e);
typedef struct {
int64 ConnectionID;
const char *URI;
int Handled; int reserved; } RESTServerHeadRequestEventParams; Unicode (Windows) virtual INT FireHeadRequest(RESTServerHeadRequestEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR URI;
BOOL Handled; INT reserved; } RESTServerHeadRequestEventParams;
- (void)onHeadRequest:(long long)connectionID :(NSString*)URI :(int*)handled;
#define EID_RESTSERVER_HEADREQUEST 13 virtual INT SECUREBLACKBOX_CALL FireHeadRequest(LONG64 &lConnectionID, LPSTR &lpszURI, BOOL &bHandled);
Remarks
The class fires this event to notify the application about a HEAD 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.