Files
react-native/ReactCommon/react/renderer/core/EventQueue.h
T
Samuel Susla ffa533a19d Add option to use unbatched queues only
Summary:
Changelog: [internal]

My suggestion is to simplify event dispatching to only two options, synchronous and asynchronous.

Why?
- Fabric has only been using one queue, `AsynchronousBatched`.
- Batching happens even on `AsynchronousUnbatched`. It just batches events until JS thread starts processing them instead of waiting for the main run loop.
- It will make it easier to reason about the code in the future once we start utilising different priorities for Concurrent Mode.

Reviewed By: JoshuaGross

Differential Revision: D28603472

fbshipit-source-id: 14e3a9c15a012c550dc16a044c31d722051a2bdc
2021-05-22 12:19:05 -07:00

78 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/EventPipe.h>
#include <react/renderer/core/RawEvent.h>
#include <react/renderer/core/StatePipe.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(
EventPipe eventPipe,
StatePipe statePipe,
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;
const EventPipe eventPipe_;
const StatePipe statePipe_;
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_;
};
} // namespace react
} // namespace facebook