Files
react-native/ReactCommon/react/renderer/core/EventQueue.h
T
Samuel Susla 2016460528 Pass event priority to React
Summary:
Changelog: [internal]

This is a mechanism that will guess event's React priority based on other events ongoing on the platform.

If an event happens within span of ContinuousStart -> ContinuousEnd and its category is unspecified, we deduce it's React priority to be default. All other events are discrete.

Special case: `onScroll`, which is always treated as "Default".

Reviewed By: JoshuaGross

Differential Revision: D28485060

fbshipit-source-id: d2eae63dbcf03271dfed97128a1590dd165a3ce2
2021-05-25 01:16:04 -07:00

77 lines
2.0 KiB
C++

/*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
#pragma once
#include <memory>
#include <mutex>
#include <vector>
#include <jsi/jsi.h>
#include <react/renderer/core/EventBeat.h>
#include <react/renderer/core/EventQueueProcessor.h>
#include <react/renderer/core/RawEvent.h>
#include <react/renderer/core/StateUpdate.h>
namespace facebook {
namespace react {
/*
* Event Queue synchronized with given Event Beat and dispatching event
* using given Event Pipe.
*/
class EventQueue {
public:
EventQueue(
EventQueueProcessor eventProcessor,
std::unique_ptr<EventBeat> eventBeat);
virtual ~EventQueue() = default;
/*
* Enqueues and (probably later) dispatch a given event.
* Can be called on any thread.
*/
void enqueueEvent(RawEvent &&rawEvent) const;
/*
* Enqueues and (probably later) dispatches a given event.
* Deletes last RawEvent from the queue if it has the same type and target.
* Can be called on any thread.
*/
void enqueueUniqueEvent(RawEvent &&rawEvent) const;
/*
* Enqueues and (probably later) dispatch a given state update.
* Can be called on any thread.
*/
void enqueueStateUpdate(StateUpdate &&stateUpdate) const;
protected:
/*
* Called on any enqueue operation.
* Override in subclasses to trigger beat `request` and/or beat `induce`.
* Default implementation does nothing.
*/
virtual void onEnqueue() const = 0;
void onBeat(jsi::Runtime &runtime) const;
void flushEvents(jsi::Runtime &runtime) const;
void flushStateUpdates() const;
EventQueueProcessor eventProcessor_;
const std::unique_ptr<EventBeat> eventBeat_;
// Thread-safe, protected by `queueMutex_`.
mutable std::vector<RawEvent> eventQueue_;
mutable std::vector<StateUpdate> stateUpdateQueue_;
mutable std::mutex queueMutex_;
mutable bool hasContinuousEventStarted_{false};
};
} // namespace react
} // namespace facebook