{"id":11910,"url":"https://patchwork.libcamera.org/api/1.1/patches/11910/?format=json","web_url":"https://patchwork.libcamera.org/patch/11910/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20210413122534.342138-3-kieran.bingham@ideasonboard.com>","date":"2021-04-13T12:25:33","name":"[libcamera-devel,2/3] libcamera: ipa_proxy: Document ProxyState","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"74f82b8eeead55ec79e22342d7e4780d2c2d117a","submitter":{"id":4,"url":"https://patchwork.libcamera.org/api/1.1/people/4/?format=json","name":"Kieran Bingham","email":"kieran.bingham@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/11910/mbox/","series":[{"id":1918,"url":"https://patchwork.libcamera.org/api/1.1/series/1918/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=1918","date":"2021-04-13T12:25:31","name":"Documentation cleanup","version":1,"mbox":"https://patchwork.libcamera.org/series/1918/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/11910/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/11910/checks/","tags":{},"headers":{"Return-Path":"","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id F10DFBD224\n\tfor ;\n\tTue, 13 Apr 2021 12:25:43 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 4EC9E68809;\n\tTue, 13 Apr 2021 14:25:43 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id B04A8602C8\n\tfor ;\n\tTue, 13 Apr 2021 14:25:40 +0200 (CEST)","from Q.local (cpc89244-aztw30-2-0-cust3082.18-1.cable.virginm.net\n\t[86.31.172.11])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 19EF48B7;\n\tTue, 13 Apr 2021 14:25:40 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com;\n\tdkim=fail reason=\"signature verification failed\" (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"u1CfCLpi\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1618316740;\n\tbh=qRqKTOOsGqO6Rhh9hiiWPjP4aZcyCV3wZoyFttQk06I=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=u1CfCLpi1e6cgQuD32zZh2wV+tWf70T9oGqg8RWGpW9vlF4CmnxWXJ644ix5+Au7T\n\t9HVxOFuib0BaddCgtozO4cpxfObTujip3QK7fjp3cwxOccujH+3Bqy7YeBFYhgihlJ\n\tKaGxbTikC7+mZ/WQwLYYAtS8xQBXNjkpu33X50fY=","From":"Kieran Bingham ","To":"libcamera devel ","Date":"Tue, 13 Apr 2021 13:25:33 +0100","Message-Id":"<20210413122534.342138-3-kieran.bingham@ideasonboard.com>","X-Mailer":"git-send-email 2.25.1","In-Reply-To":"<20210413122534.342138-1-kieran.bingham@ideasonboard.com>","References":"<20210413122534.342138-1-kieran.bingham@ideasonboard.com>","MIME-Version":"1.0","Subject":"[libcamera-devel] [PATCH 2/3] libcamera: ipa_proxy: Document\n\tProxyState","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Content-Type":"text/plain; charset=\"us-ascii\"","Content-Transfer-Encoding":"7bit","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"The documentation for the ProxyState and tracking variable was not added\nwhen the IPA was extended with a state machine.\n\nAdd it.\n\nFixes: 70238ceca5b2 (\"utils: ipc: proxy: Track IPA with a state machine\")\nSigned-off-by: Kieran Bingham \n---\n src/libcamera/ipa_proxy.cpp | 23 +++++++++++++++++++++++\n 1 file changed, 23 insertions(+)","diff":"diff --git a/src/libcamera/ipa_proxy.cpp b/src/libcamera/ipa_proxy.cpp\nindex ec4c2cc823c2..8608b0c92a87 100644\n--- a/src/libcamera/ipa_proxy.cpp\n+++ b/src/libcamera/ipa_proxy.cpp\n@@ -32,6 +32,18 @@ LOG_DEFINE_CATEGORY(IPAProxy)\n * Isolate IPA into separate process.\n */\n \n+/**\n+ * \\enum IPAProxy::ProxyState\n+ * \\brief Identifies the available operational states of the proxy\n+ *\n+ * \\var IPAProxy::ProxyStopped\n+ * \\brief The proxy is not active and only synchronous operations are permitted\n+ * \\var IPAProxy::ProxyStopping\n+ * \\brief No new tasks can be submitted to the proxy, however existing events can be completed\n+ * \\var IPAProxy::ProxyRunning\n+ * \\brief The Proxy is active and asynchronous tasks may be queued\n+ */\n+\n /**\n * \\brief Construct an IPAProxy instance\n * \\param[in] ipam The IPA module\n@@ -213,4 +225,15 @@ std::string IPAProxy::resolvePath(const std::string &file) const\n * construction.\n */\n \n+/**\n+ * \\var IPAProxy::state_\n+ * \\brief Current state of the IPAProxy\n+ *\n+ * The IPAProxy can be Running, Stopped, or Stopping.\n+ *\n+ * This state provides a means to ensure that asynchronous methods are only\n+ * called while the proxy is running, and prevent new tasks being submitted\n+ * while still enabling events to complete when the IPAProxy is stopping.\n+ */\n+\n } /* namespace libcamera */\n","prefixes":["libcamera-devel","2/3"]}