|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface INtpService
This interface provides methods for configuring the NTP Service. The NTP Service is used to synchronize the system time with a remote NTP server.
Field Summary | |
---|---|
static java.lang.String |
SERVICE_NAME
Reports the class name representing this interface. |
Method Summary | |
---|---|
java.lang.String |
getBackupURL()
This method returns the URL of the backup NTP server that is used to synchronize the system time with. |
int |
getRetryAttempts()
This method returns the number of retry attempts after a failed attempt to synchronize the system time with the NTP server. |
long |
getRetryInterval()
This method returns the interval, in milliseconds, between failed attmepts to synchronize the system time with the NTP server. |
boolean |
getSyncAtBoot()
This method returns whether the service will synchronize with the NTP server at boot. |
boolean |
getSyncHWClock()
This method returns whether the service will synchronize the hardware clock to the system time every time the service synchronizes the system time with the NTP Server. |
long |
getSyncInterval()
This method returns the interval (in milliseconds) between successful attempts to synchronize the system time with the NTP server. |
java.lang.String |
getURL()
This method returns the URL of the NTP server that is used to synchronize the system time with. |
void |
init(java.lang.String url,
java.lang.String url_backup,
boolean boot_sync,
boolean clock_sync,
long sync_interval,
long retry_interval,
int retries)
This method is used to initialize the NTP Service configuration. |
boolean |
isRunning()
Check the operational status of any functional operation associated with the implementation. |
void |
restart()
Perform both the action of the stop and the start methods. |
void |
setBackupURL(java.lang.String url2)
This method is used to set the URL of the backup NTP server that is used to synchronize the system time. |
void |
setPersistent()
Store the current configuration (through @IConfigurationManagerService or in the OS as appropriate). |
void |
setRetryAttempts(int retries)
This method is used to set the number of retry attempts after a failed attempt to synchronize the system time with the NTP server. |
void |
setRetryInterval(long interval)
This method is used to set the interval, in milliseconds, between failed attempts to synchronize the system time with the NTP server. |
void |
setSyncAtBoot(boolean sync)
This method is used to set whether the service will synchronize with the NTP server at boot. |
void |
setSyncHWClock(boolean sync)
This method is used to set whether the service will synchronize the hardware clock to the system time every time the service synchronizes the system time with the NTP Server. |
void |
setSyncInterval(long interval)
This method is used to set the interval (in milliseconds) between successful attempts to synchronize the system time with the NTP server. |
void |
setURL(java.lang.String url)
This method is used to set the URL of the NTP server that is used to synchronize the system time. |
void |
start()
The start method will start any functional operation associated with the specific implementation. |
void |
stop()
The stop method will stop any functional operation started by the start method. |
boolean |
sync()
This methods issues a command to synchronize the system date with the NTP server. |
boolean |
syncBackup()
This methods issues a command to synchronize the system date with the backup NTP server. |
boolean |
syncBackupWithRetries()
This methods issues a command to synchronize the system date with the backup NTP server. |
boolean |
syncHWClock()
This method issues a command to synchronize the hardware clock with the system time. |
boolean |
syncWithRetries()
This methods issues a command to synchronize the system date with the NTP server. |
Field Detail |
---|
static final java.lang.String SERVICE_NAME
Method Detail |
---|
void init(java.lang.String url, java.lang.String url_backup, boolean boot_sync, boolean clock_sync, long sync_interval, long retry_interval, int retries)
url
- A String representing the URL of the NTP server.url_backup
- A String representing the URL of the backup NTP server.boot_sync
- A boolean used to determine whether to sync to the NTP server at boot.clock_sync
- A boolean used to determine whether to sync the hardware clock to system time.sync_interval
- The number of milliseconds between successful NTP server sync attempts.retry_interval
- The number of milliseconds between failed NTP server sync/retry attempts.retries
- The number of retries after a failed NTP server sync attempt.void setURL(java.lang.String url)
url
- A String representing the URL of the NTP server.void setBackupURL(java.lang.String url2)
url2
- A String representing the URL of the NTP server.void setSyncAtBoot(boolean sync)
Note: this method is not yet implemented.
sync
- A boolean used to determine whether to sync to the NTP server at boot.void setSyncHWClock(boolean sync)
sync
- A boolean used to determine whether to sync the hardware clock to system time.void setSyncInterval(long interval)
interval
- The number of milliseconds between successful NTP server sync attempts.void setRetryInterval(long interval)
interval
- The number of milliseconds between failed NTP server sync/retry attempts.void setRetryAttempts(int retries)
retries
- The number of retries after a failed NTP server sync attempt.java.lang.String getURL()
java.lang.String getBackupURL()
boolean getSyncAtBoot()
boolean getSyncHWClock()
long getSyncInterval()
long getRetryInterval()
int getRetryAttempts()
boolean sync()
boolean syncWithRetries()
boolean syncBackup()
boolean syncBackupWithRetries()
boolean syncHWClock()
void start() throws java.lang.Exception
java.lang.Exception
- start failed (could be missing a configuration).void stop() throws java.lang.Exception
java.lang.Exception
- stop failedvoid restart() throws java.lang.Exception
java.lang.Exception
- restart failed (could be missing a configuration)void setPersistent() throws java.lang.Exception
java.lang.Exception
- no current configuration to storeboolean isRunning()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |