-
Notifications
You must be signed in to change notification settings - Fork 17
RDKEMW-10717 : Update OCIContainer Api header #641
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
Changes from all commits
02dc46c
5a6b69f
7b471e0
f34b59f
387330a
6c7b51f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -55,7 +55,7 @@ struct EXTERNAL IOCIContainer : virtual public Core::IUnknown { | |||||
| // @text onContainerStopped | ||||||
| virtual void OnContainerStopped(const string& containerId, const string& name) {} | ||||||
|
|
||||||
| // @brief Notifies failure in container execution | ||||||
| // @brief Notifies failure in container execution, Only triggered for states start, stop, hibernate, wakeup. | ||||||
| // @text onContainerFailed | ||||||
| virtual void OnContainerFailed(const string& containerId, const string& name, uint32_t error) {} | ||||||
|
Comment on lines
+58
to
60
|
||||||
|
|
||||||
|
|
@@ -71,84 +71,84 @@ struct EXTERNAL IOCIContainer : virtual public Core::IUnknown { | |||||
| /** Unregister notification interface */ | ||||||
| virtual Core::hresult Unregister(INotification *notification) = 0; | ||||||
|
|
||||||
| /** Provide list of containers */ | ||||||
| // @brief Provide list of containers | ||||||
| // @text listContainers | ||||||
| // @param containers - out/json - string | ||||||
| virtual Core::hresult ListContainers(string& containers /* @out @opaque */, bool& success /* @out */, string& errorReason /* @out */) = 0; | ||||||
|
Comment on lines
+74
to
77
|
||||||
|
|
||||||
| /** Get the information about container */ | ||||||
| // @brief Get the information about container | ||||||
| // @text getContainerInfo | ||||||
| // @param containerId Identifier of container | ||||||
| virtual Core::hresult GetContainerInfo(const string& containerId , string& info /* @out @opaque */, bool& success /* @out */, string& errorReason /* @out */) = 0; | ||||||
|
Comment on lines
+79
to
82
|
||||||
|
|
||||||
| /** Get the state of container */ | ||||||
| // @brief Get the state of container | ||||||
| // @text getContainerState | ||||||
| // @param containerId Identifier of container | ||||||
| virtual Core::hresult GetContainerState(const string& containerId , ContainerState& state /* @out */, bool& success /* @out */, string& errorReason /* @out */) = 0; | ||||||
|
Comment on lines
+84
to
87
|
||||||
|
|
||||||
| /** Start the container from bundle */ | ||||||
| // @brief Start the container from bundle | ||||||
| // @text startContainer | ||||||
| // @param containerId Identifier of container | ||||||
| // @param bundlePath path of application bundle | ||||||
| // @param command(optional) command to run in container | ||||||
| // @param westerosSocket(optional) Westeros socket container need to connect | ||||||
| virtual Core::hresult StartContainer(const string& containerId , const string& bundlePath , const string& command , const string& westerosSocket , int32_t& descriptor /* @out */, bool& success /* @out */, string& errorReason /* @out */) = 0; | ||||||
|
Comment on lines
+89
to
95
|
||||||
|
|
||||||
| /** Start the container from dobby specification */ | ||||||
| // @brief Start the container from dobby specification | ||||||
| // @text startContainerFromDobbySpec | ||||||
| // @param containerId Identifier of container | ||||||
| // @param dobbySpec dobby specification as json string | ||||||
| // @param command(optional) command to run in container | ||||||
| // @param westerosSocket(optional) Westeros socket container need to connect | ||||||
| virtual Core::hresult StartContainerFromDobbySpec(const string& containerId , const string& dobbySpec , const string& command , const string& westerosSocket , int32_t& descriptor /* @out */, bool& success /* @out */, string& errorReason /* @out */) = 0; | ||||||
|
Comment on lines
+97
to
103
|
||||||
|
|
||||||
| /** Stop the container */ | ||||||
| // @brief Stop the container | ||||||
| // @text stopContainer | ||||||
| // @param containerId Identifier of container | ||||||
| // @param force(optional) Metion forceful or graceful termination of container | ||||||
|
||||||
| // @param force(optional) Metion forceful or graceful termination of container | |
| // @param force(optional) Mention forceful or graceful termination of container |
Copilot
AI
Dec 5, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
According to the Documentation Tags Guidelines, each method must include @retval tags to describe each return code associated with the function. The method is missing @retval tags.
Copilot
AI
Dec 5, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
According to the Documentation Tags Guidelines, each method must include @retval tags to describe each return code associated with the function. The method is missing @retval tags.
Copilot
AI
Dec 5, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
According to the Documentation Tags Guidelines, each method must include @retval tags to describe each return code associated with the function. The method is missing @retval tags.
Copilot
AI
Dec 5, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
According to the Documentation Tags Guidelines, each method must include @retval tags to describe each return code associated with the function. The method is missing @retval tags.
Copilot
AI
Dec 5, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
According to the Documentation Tags Guidelines, each method must include @retval tags to describe each return code associated with the function. The method is missing @retval tags.
Copilot
AI
Dec 5, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
According to the Documentation Tags Guidelines, each method must include @retval tags to describe each return code associated with the function. The method is missing @retval tags.
Copilot
AI
Dec 5, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
According to the Documentation Tags Guidelines, each method must include @retval tags to describe each return code associated with the function. The method is missing @retval tags.
Copilot
AI
Dec 5, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
According to the Documentation Tags Guidelines, each method must include @retval tags to describe each return code associated with the function. The method is missing @retval tags.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The word "Only" should not be capitalized mid-sentence. It should be "only".