#include <request.h>
Public Member Functions | |
| IDBRequest (optional< variant< Member< IDBObjectStore >, Member< IDBCursor >>> source, RefPtr< IDBTransaction > transaction) | |
| void | Trace (memory::HeapTracer *tracer) const override |
| virtual void | PerformOperation (SqliteTransaction *transaction)=0 |
| void | OnAbort () |
| ExceptionOr< Any > | Result () const |
| ExceptionOr< Any > | Error () const |
 Public Member Functions inherited from shaka::js::events::EventTarget | |
| EventTarget () | |
| void | AddEventListener (const std::string &type, Listener callback) |
| void | SetCppEventListener (EventType type, std::function< void()> callback) |
| void | RemoveEventListener (const std::string &type, Listener callback) |
| void | UnsetCppEventListener (EventType type) |
| ExceptionOr< bool > | DispatchEvent (RefPtr< Event > event) |
| ExceptionOr< bool > | DispatchEventInternal (RefPtr< Event > event, bool *did_listeners_throw) |
| template<typename EventType , typename... Args> | |
| std::shared_ptr< ThreadEvent< bool > > | ScheduleEvent (Args &&... args) |
| template<typename EventType , typename... Args> | |
| ExceptionOr< bool > | RaiseEvent (Args... args) |
| Public Member Functions inherited from shaka::BackingObject | |
| BackingObject () | |
| void | Trace (memory::HeapTracer *tracer) const override |
| bool | IsRootedAlive () const override |
| std::string | name () const |
| virtual BackingObjectFactoryBase * | factory () const =0 |
| bool | DerivedFrom (const std::string &base) |
| ReturnVal< JsValue > | JsThis () const |
| void | SetJsThis (Handle< JsObject > this_) |
| Public Member Functions inherited from shaka::memory::Traceable | |
| virtual | ~Traceable () |
| virtual bool | IsShortLived () const |
Public Attributes | |
| optional< variant< Member< IDBObjectStore >, Member< IDBCursor > > > | source |
| Member< IDBTransaction > | transaction |
| IDBRequestReadyState | ready_state = IDBRequestReadyState::PENDING |
| Listener | on_success |
| Listener | on_error |
Protected Member Functions | |
| void | CompleteSuccess (Any result) |
| void | CompleteError (JsError error) |
| void | CompleteError (DatabaseStatus status) |
| Protected Member Functions inherited from shaka::js::events::EventTarget | |
| void | AddListenerField (EventType type, Listener *on_field) |
| Protected Member Functions inherited from shaka::BackingObject | |
| ~BackingObject () override | |
Protected Attributes | |
| Any | result_ |
| Any | error_ |
Additional Inherited Members | |
| Public Types inherited from shaka::js::events::EventTarget | |
| using | Listener = optional< Callback > |
| Static Public Member Functions inherited from shaka::BackingObject | |
| static void * | operator new[] (size_t size)=delete |
| static void | operator delete[] (void *)=delete |
| Static Public Attributes inherited from shaka::BackingObject | |
| static constexpr const size_t | kInternalFieldCount = 2 |
| Static Public Attributes inherited from shaka::memory::Traceable | |
| static constexpr const uint64_t | kShortLiveDurationMs = 5000 |
Detailed Description
Constructor & Destructor Documentation
§ IDBRequest()
| shaka::js::idb::IDBRequest::IDBRequest | ( | optional< variant< Member< IDBObjectStore >, Member< IDBCursor >>> | source, |
| RefPtr< IDBTransaction > | transaction | ||
| ) |
Definition at line 28 of file request.cc.
Member Function Documentation
§ CompleteError() [1/2]
|
protected |
Called when the request is completed with an error. This synchronously invokes the error callback.
Definition at line 75 of file request.cc.
§ CompleteError() [2/2]
|
protected |
Definition at line 81 of file request.cc.
§ CompleteSuccess()
|
protected |
Called when the request is completed with a success. This synchronously invokes the success callback.
Definition at line 64 of file request.cc.
§ Error()
| ExceptionOr< Any > shaka::js::idb::IDBRequest::Error | ( | ) | const |
Definition at line 58 of file request.cc.
§ OnAbort()
| void shaka::js::idb::IDBRequest::OnAbort | ( | ) |
Called if the request is part of a transaction that gets aborted. This synchronously fires the error event.
Definition at line 48 of file request.cc.
§ PerformOperation()
|
pure virtual |
Performs the operation for this request. This will synchronously fire events into JavaScript.
Implemented in shaka::js::idb::IDBIterateCursorRequest, shaka::js::idb::IDBDeleteRequest, shaka::js::idb::IDBStoreRequest, shaka::js::idb::IDBOpenDBRequest, shaka::js::idb::IDBGetRequest, and shaka::js::idb::IDBDeleteDBRequest.
§ Result()
| ExceptionOr< Any > shaka::js::idb::IDBRequest::Result | ( | ) | const |
Definition at line 52 of file request.cc.
§ Trace()
|
overridevirtual |
Called during a GC run. This should call HeapTracer::Trace on all Traceable members. Be sure to call the base method when overriding.
Reimplemented from shaka::js::events::EventTarget.
Reimplemented in shaka::js::idb::IDBIterateCursorRequest.
Definition at line 40 of file request.cc.
Member Data Documentation
§ error_
§ on_error
§ on_success
§ ready_state
| IDBRequestReadyState shaka::js::idb::IDBRequest::ready_state = IDBRequestReadyState::PENDING |
§ result_
§ source
§ transaction
| Member<IDBTransaction> shaka::js::idb::IDBRequest::transaction |
The documentation for this class was generated from the following files:
- shaka/src/js/idb/request.h
- shaka/src/js/idb/request.cc
