Commit b281fa91 authored by (no author)'s avatar (no author)

This commit was manufactured by cvs2svn to create tag

'OCAP10-I10-March05-2004'.
parent ebc683b8
// RebootHandler.java
package org.ocap.hardware;
/**
* <p>
* The RebootHandler interface provides a callback method to notify the
* result of a reboot request.
* </p><p>
* The monitor application can set an instance of a class that implements
* this interface to the org.ocap.hardware.Host. See the
* {@link org.ocap.hardware.Host#setRebootHandler} method.
* </p>
*
* @author Brent Foust
* @author Shigeaki Watanabe
*
* @see org.ocap.hardware.Host#setRebootHandler
*/
public interface RebootHandler {
/**
* <p>
* This is a callback method to notify that a reboot is initiated.
* This method shall be called in following cases:
* <ul>
* <li> The org.ocap.hardware.Host.reboot() method is called.
* <li> The Host device initiates a reboot.
* </ul>
* </p><p>
* This method shall be called before the requested reboot is performed
* by the Host device.
* It gives the monitor application an opportunity to clean up
* resources before a reboot.
* The Host device continues the reboot process after this method call
* returns.
* </p>
*/
public void notifyReboot();
}
// HostParamHandler.java
package org.ocap.system;
/**
* <em>HostParamHandler</em> is a handler for host parameter update
* requests from the CableCARD device. OCAP applications can set the handler using
*
{@link org.ocap.hardware.pod.POD#setHostParamHandler} method and change the behavior to
* such requests.
*
* <p>Parameters to {@link #update} method must be one of the following
* combination:
*
* <blockquote>
* <table border=1 cellspacing=0 cellpadding=3 bgcolor="white">
* <thead bgcolor="#eeeeee">
* <td>value of <code>key</code> (String)
* <td>type of <code>value</code>
* <td>content of <code>value</code>
* </thead>
*
* <tr>
* <td>&quot;rf_output_channel&quot;
* <td>java.lang.Integer
* <td>RF output channel number (typically 3 or 4)
*
* <tr>
* <td>&quot;rf_output_channel_ui&quot;
* <td>java.lang.Boolean
* <td><code>True</code> to enable changing RF output channel on UI;<br>
* <code>False</code> to disable
*
* <tr>
* <td>&quot;p_c_pin&quot;
* <td>byte[]
* <td>parental control PIN (length up to 255)
*
* <tr>
* <td>&quot;reset_p_c_pin&quot;
* <td>(<code>null</code>)
* <td>reset parental control pin
*
* <tr>
* <td>&quot;p_c_factory_reset&quot;
* <td>(<code>null</code>)
* <td>factory reset for parental control channels
*
* <tr>
* <td>&quot;p_c_settings&quot;
* <td>int[]
* <td>list of virtual channels to be under parental control
*
* <tr>
* <td>&quot;time_zone&quot;
* <td>java.lang.Integer
* <td>offset from UTC in minutes
*
* <tr>
* <td>&quot;daylight_savings&quot;
* <td>java.lang.Boolean
* <td><code>True</code> for use daylight saving; <code>False</code> for not
*
* <tr>
* <td>&quot;ac_outlet&quot;
* <td>java.lang.String
* <td>AC outlet setting; either "user", "switched", or "unswitched"
*
* <tr>
* <td>&quot;language&quot;
* <td>java.lang.String
* <td>ISO_639_language_code
*
* <tr>
* <td>&quot;rating_region&quot;
* <td>java.lang.Integer
* <td>rating region (1: US, 2: Canada)
*
* </table>
* </blockquote>
*
* This table is applicable to {@link org.ocap.hardware.pod.POD#updateHostParam} and
* {@link org.ocap.hardware.pod.POD#getHostParam}, too, except that
* {@link org.ocap.hardware.pod.POD#getHostParam} ignores
* keys &quot;p_c_factory_reset&quot; and &quot;reset_p_c_pin&quot;.
*/
public interface HostParamHandler
{
/**
* This method is called when the CableCARD device submits a host parameter
* update request and this <code>HostParamHandler</code> is registered.
*
* <p>OCAP implementation must reject update requests with an
* invalid parameter key (unsupported feature) or an invalid
* parameter value before propagating them to this method. If and
* only if this method accepts the request (i.e. returns
* <code>true</code>), OCAP implementation must reflect the request
* to its database (e.g. PIN's), physical setting (e.g. "ac_outlet"
* switch), etc.
*
* @param key parameter key
*
* @param value parameter value
*
* @return <code>true</code> to accept the request,
* <code>false</code> to reject it.
*
* @see org.ocap.hardware.pod.POD#setHostParamHandler
**/
boolean update (String key, Object value);
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment