IWebBrowserSchemeHandler Class Reference

#include <IWebBrowserSchemeHandler.h>

Classes
class	IHeaders

Public Member Functions
virtual	~IWebBrowserSchemeHandler ()
virtual bool	ProcessRequest (const FString &Verb, const FString &Url, const FSimpleDelegate &OnHeadersReady)=0
virtual void	GetResponseHeaders (IHeaders &OutHeaders)=0
virtual bool	ReadResponse (uint8 *OutBytes, int32 BytesToRead, int32 &BytesRead, const FSimpleDelegate &OnMoreDataReady)=0
virtual void	Cancel ()=0

Detailed Description

This is the interface that needs to be implemented to handle a request made via a custom scheme. It will be created by implementing an IWebBrowserSchemeHandlerFactory, given to the web browser singleton.

Constructor & Destructor Documentation

~IWebBrowserSchemeHandler()

virtual IWebBrowserSchemeHandler::~IWebBrowserSchemeHandler ( )

inlinevirtual

Member Function Documentation

Cancel()

virtual void IWebBrowserSchemeHandler::Cancel ( )

pure virtual

Called if the request should be canceled.

GetResponseHeaders()

virtual void IWebBrowserSchemeHandler::GetResponseHeaders ( IHeaders &  OutHeaders )

pure virtual

Retrieves the headers for this request.

Parameters

OutHeaders

The interface to use to set headers.

ProcessRequest()

virtual bool IWebBrowserSchemeHandler::ProcessRequest ( const FString &  Verb, const FString &  Url, const FSimpleDelegate &  OnHeadersReady  )

pure virtual

Process an incoming request.

Parameters

Verb	This is the verb used for the request (GET, PUT, POST, etc).
Url	This is the full url for the request being made.
OnHeadersReady	You must execute this delegate once the response headers are ready to be retrieved with GetResponseHeaders. You may execute it during this call to state headers are available now.

Returns

You should return true if the request has been accepted and will be processed, otherwise false to cancel this request.

ReadResponse()

virtual bool IWebBrowserSchemeHandler::ReadResponse ( uint8 *  OutBytes, int32  BytesToRead, int32 &  BytesRead, const FSimpleDelegate &  OnMoreDataReady  )

pure virtual

Retrieves the headers for this request.

Parameters

OutBytes	You should copy up to BytesToRead of data to this ptr.
BytesToRead	The maximum number of bytes that can be copied to OutBytes.
BytesRead	You should set this to the number of bytes that were copied. This can be set to zero, to indicate more data is not ready yet, and OnMoreDataReady must then be executed when there is.
OnMoreDataReady	You should execute this delegate when more data is available to read.

Returns

You should return true if more data needs to be read, otherwise false if this is the end of the response data.

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/WebBrowser/Public/IWebBrowserSchemeHandler.h