Deprecate GraphStatus()

PiperOrigin-RevId: 539992850
This commit is contained in:
MediaPipe Team 2023-06-13 09:51:42 -07:00 committed by Copybara-Service
parent b19b80e10f
commit e468bee584

View File

@ -109,9 +109,20 @@ class CalculatorContext {
// use OutputStream::SetOffset() directly. // use OutputStream::SetOffset() directly.
void SetOffset(TimestampDiff offset); void SetOffset(TimestampDiff offset);
// Returns the status of the graph run. // DEPRECATED: This was intended to get graph run status during
// `CalculatorBase::Close` call. However, `Close` can run simultaneously with
// other calculators `CalculatorBase::Process`, hence the actual graph
// status may change any time and returned graph status here does not
// necessarily reflect the actual graph status.
// //
// NOTE: This method should only be called during CalculatorBase::Close(). // As an alternative, instead of checking graph status in `Close` and doing
// work for "done" state, you can enable timestamp bound processing for your
// calculator (`CalculatorContract::SetProcessTimestampBounds`) to trigger
// `Process` on timestamp bound updates and handle "done" state there.
// Check examples in:
// mediapipe/framework/calculator_graph_summary_packet_test.cc.
//
ABSL_DEPRECATED("Does not reflect the actual graph status.")
absl::Status GraphStatus() const { return graph_status_; } absl::Status GraphStatus() const { return graph_status_; }
ProfilingContext* GetProfilingContext() const { ProfilingContext* GetProfilingContext() const {