| <link rel="stylesheet" href="../style.css" /> |
| |
| [TOC] |
| # fuchsia.castconfig |
| |
| <div class="fidl-version-div"><span class="fidl-attribute fidl-version">Added: 7</span></div> |
| |
| |
| ## **PROTOCOLS** |
| |
| ## Provider {#Provider} |
| *Defined in [fuchsia.castconfig/cast_config.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.castconfig/cast_config.fidl;l=19)* |
| <p>Interface that provides cast config data.</p> |
| |
| |
| ### Notify {#Provider.Notify} |
| |
| <p>Notifies the config provider of the config status.</p> |
| <p><code>processed</code>: <code>true</code> if successfully received and processed |
| <code>retry</code>: If <code>processed</code> is <code>false</code> config provider determines if a retry |
| is appropriate.</p> |
| |
| |
| |
| #### Request {#Provider.Notify_Request} |
| |
| <table> |
| <tr><th>Name</th><th>Type</th></tr> |
| <tr> |
| <td><code>processed</code></td> |
| <td> |
| <code>bool</code> |
| </td> |
| </tr> |
| </table> |
| |
| |
| #### Response {#Provider.Notify_Response} |
| |
| <table> |
| <tr><th>Name</th><th>Type</th></tr> |
| <tr> |
| <td><code>retry</code></td> |
| <td> |
| <code>bool</code> |
| </td> |
| </tr> |
| </table> |
| |
| ### Watch {#Provider.Watch} |
| |
| <p>Requests a buffer containing cast config data. |
| This call implements the Hanging Get protocol as detailed in |
| https://fuchsia.dev/fuchsia-src/concepts/api/fidl#hanging-get</p> |
| <p>All error cases are terminal, clients should not retry on error.</p> |
| |
| |
| |
| #### Request {#Provider.Watch_Request} |
| |
| <EMPTY> |
| |
| |
| #### Response {#Provider.Watch_Response} |
| |
| <table> |
| <tr><th>Name</th><th>Type</th></tr> |
| <tr> |
| <td><code>result</code></td> |
| <td> |
| <code><a class='link' href='#Provider_Watch_Result'>Provider_Watch_Result</a></code> |
| </td> |
| </tr> |
| </table> |
| |
| |
| ## **STRUCTS** |
| |
| ### Provider_Watch_Response [resource](/fuchsia-src/reference/fidl/language/language.md#value-vs-resource){:.fidl-attribute} {#Provider_Watch_Response data-text="Provider_Watch_Response"} |
| *Defined in [fuchsia.castconfig/cast_config.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.castconfig/cast_config.fidl;l=25)* |
| |
| <table> |
| <tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr> |
| <tr id="Provider_Watch_Response.config"> |
| <td><code>config</code></td> |
| <td> |
| <code><a class='link' href='../fuchsia.mem/'>fuchsia.mem</a>/<a class='link' href='../fuchsia.mem/#Buffer'>Buffer</a></code> |
| </td> |
| <td></td> |
| <td>No default</td> |
| </tr> |
| </table> |
| |
| |
| ## **ENUMS** |
| |
| ### ErrorCode [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#ErrorCode data-text="ErrorCode"} |
| Type: <code>uint32</code> |
| |
| *Defined in [fuchsia.castconfig/cast_config.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.castconfig/cast_config.fidl;l=10)* |
| <p>Error codes for the Watch operation.</p> |
| |
| <table> |
| <tr><th>Name</th><th>Value</th><th>Description</th></tr> |
| <tr id="ErrorCode.NO_CAST_CONFIG"> |
| <td><h3 id="ErrorCode.NO_CAST_CONFIG" class="add-link hide-from-toc">NO_CAST_CONFIG</h3></td> |
| <td><code>1</code></td> |
| <td><p>Error when there is no cast config available.</p> |
| </td> |
| </tr> |
| <tr id="ErrorCode.INTERNAL"> |
| <td><h3 id="ErrorCode.INTERNAL" class="add-link hide-from-toc">INTERNAL</h3></td> |
| <td><code>2</code></td> |
| <td><p>Generic error.</p> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| ## **UNIONS** |
| |
| ### Provider_Watch_Result [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} [resource](/fuchsia-src/reference/fidl/language/language.md#value-vs-resource){:.fidl-attribute} {#Provider_Watch_Result data-text="Provider_Watch_Result"} |
| *Defined in [fuchsia.castconfig/cast_config.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.castconfig/cast_config.fidl;l=25)* |
| <table> |
| <tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr> |
| <tr id="Provider_Watch_Result.response"> |
| <td><h3 id="Provider_Watch_Result.response" class="add-link hide-from-toc">1</h3></td> |
| <td><code>response</code></td> |
| <td> |
| <code><a class='link' href='#Provider_Watch_Response'>Provider_Watch_Response</a></code> |
| </td> |
| <td></td> |
| </tr> |
| <tr id="Provider_Watch_Result.err"> |
| <td><h3 id="Provider_Watch_Result.err" class="add-link hide-from-toc">2</h3></td> |
| <td><code>err</code></td> |
| <td> |
| <code><a class='link' href='#ErrorCode'>ErrorCode</a></code> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| |