TSDuck v3.46-4806
MPEG Transport Stream Toolkit
Loading...
Searching...
No Matches
ts::ReactiveWebHandlerInterface Class Reference

Interface class for WebRequest Reactor handlers. More...

#include <tsReactiveWebHandlerInterface.h>

Public Member Functions

virtual void handleWebOpen (ReactiveWebRequest &request, int error_code, const ObjectPtr &user_data)
 Handle the completion of a Web request open operation.
 
virtual void handleWebReceive (ReactiveWebRequest &request, const ByteBlockPtr &data, int error_code, const ObjectPtr &user_data)
 Handle the reception of data from a Web request.
 

Detailed Description

Interface class for WebRequest Reactor handlers.

All methods are empty by default. An application may implement the required ones only.

Member Function Documentation

◆ handleWebOpen()

virtual void ts::ReactiveWebHandlerInterface::handleWebOpen ( ReactiveWebRequest &  request,
int  error_code,
const ObjectPtr &  user_data 
)
virtual

Handle the completion of a Web request open operation.

Parameters
[in,out]requestWeb request for which the handler is invoked.
[in]error_codeSystem-specific error code, SYS_SUCCESS on success.
[in]user_dataThe user-data shared pointer which was passed to startOpen().

◆ handleWebReceive()

virtual void ts::ReactiveWebHandlerInterface::handleWebReceive ( ReactiveWebRequest &  request,
const ByteBlockPtr &  data,
int  error_code,
const ObjectPtr &  user_data 
)
virtual

Handle the reception of data from a Web request.

Parameters
[in,out]requestWeb request for which the handler is invoked.
[in]dataSafe pointer to the received data. Can be null in case of error. The handler may safely copy the shared pointer, the pointed data will not be modified by the ReactiveWebRequest.
[in]error_codeSystem-specific error code, including:
  • SYS_SUCCESS on success.
  • SYS_CANCELED when the transfer was aborted by the application.
  • SYS_EOF at end of file or if the other end of a communication link has disconnected,
  • SYS_ERROR in case of unknown error.
[in]user_dataThe user-data shared pointer which was passed to startOpen().

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