shaka::NetworkFilters Class Reference

#include <net.h>

Public Member Functions
	NetworkFilters ()
virtual	~ NetworkFilters ()
	NetworkFilters (const NetworkFilters &)=delete
NetworkFilters &	operator= (const NetworkFilters &)=delete
	NetworkFilters (NetworkFilters &&)=delete
NetworkFilters &	operator= (NetworkFilters &&)=delete
virtual std::future< optional< Error > >	OnRequestFilter (RequestType type, Request *request)
virtual std::future< optional< Error > >	OnResponseFilter (RequestType type, Response *response)

Detailed Description

Defines an interface for request/response filters. These are used by Shaka Player as part of making a network request. These allow modifying the request/response before handing it off to other pieces. This is only used for MSE playback, this doesn't affect src= playback.

These can be completed asynchronously by returning a std::future instance. This may be called while an asynchronous request is still completing, but won't be called concurrently. This is called on the JS main thread, so it is preferable to avoid lots of work and do it asynchronously.

Definition at line 228 of file net.h.

Constructor & Destructor Documentation

NetworkFilters() [1/3]

shaka::NetworkFilters::NetworkFilters

(

)

~ NetworkFilters()

virtual shaka::NetworkFilters::~ NetworkFilters ( )

virtual

NetworkFilters() [2/3]

shaka::NetworkFilters::NetworkFilters ( const NetworkFilters &  )

delete

NetworkFilters() [3/3]

shaka::NetworkFilters::NetworkFilters ( NetworkFilters &&  )

delete

Member Function Documentation

OnRequestFilter()

Doxygen_Skip std::future< optional< Error > > shaka::NetworkFilters::OnRequestFilter ( RequestType  type, Request *  request  )

virtual

Called before a request is sent. This can modify the request object to change properties of the request.

Parameters

type	The type of the request.
request	The request object. This can be modified by the callback and remains valid until the returned future is resolved.

Returns

A future for when this filter completes.

Definition at line 126 of file net_public.cc.

OnResponseFilter()

std::future< optional< Error > > shaka::NetworkFilters::OnResponseFilter ( RequestType  type, Response *  response  )

virtual

Called after a request sent, but before it is handled by the library. This can modify the response object.

Parameters

type	The type of the request.
response	The response object. This can be modified by the callback and remains valid until the returned future is resolved.

Returns

A future for when this filter completes.

Definition at line 131 of file net_public.cc.

operator=() [1/2]

NetworkFilters& shaka::NetworkFilters::operator= ( const NetworkFilters &  )

delete

operator=() [2/2]

NetworkFilters& shaka::NetworkFilters::operator= ( NetworkFilters &&  )

delete

---

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

• shaka/include/shaka/net.h
• shaka/src/public/net_public.cc