| Ninad Palsule | 927d093 | 2023-03-06 11:42:02 -0600 | [diff] [blame] | 1 | description: > |
| Ninad Palsule | b9f7c1d | 2023-05-16 10:39:31 -0500 | [diff] [blame] | 2 | Provides methods for supported consoles in the system. This interface should |
| 3 | be used to retrieve the console data. |
| Ninad Palsule | 927d093 | 2023-03-06 11:42:02 -0600 | [diff] [blame] | 4 | |
| Ninad Palsule | b9f7c1d | 2023-05-16 10:39:31 -0500 | [diff] [blame] | 5 | methods: |
| 6 | - name: Connect |
| Ninad Palsule | 927d093 | 2023-03-06 11:42:02 -0600 | [diff] [blame] | 7 | description: > |
| Ninad Palsule | b9f7c1d | 2023-05-16 10:39:31 -0500 | [diff] [blame] | 8 | Returns the unix socket file descriptor. The consumer can user this |
| 9 | descriptor to read the console data. |
| 10 | returns: |
| 11 | - name: fd |
| 12 | type: unixfd |
| 13 | description: > |
| 14 | The file descriptor to the unix socket. |
| 15 | errors: |
| 16 | - xyz.openbmc_project.Common.Error.InternalFailure |
| 17 | - xyz.openbmc_project.User.Common.Error.NoResource |