Zend_TimeSync-Working.xml 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15157 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.timesync.working">
  5. <title>Arbeiten mit Zend_TimeSync</title>
  6. <para>
  7. <classname>Zend_TimeSync</classname> kann die aktuelle Zeit von jedem angegebenen
  8. <emphasis role="strong">NTP</emphasis> oder <emphasis role="strong">SNTP</emphasis>
  9. Zeitserver zurückgeben. Es kann automatisch mehrere Server handhaben und bietet ein
  10. einfaches Interface.
  11. </para>
  12. <note>
  13. <para>
  14. Alle Beispiele in diesem Kapitel verwenden einen öfentlichen, generellen
  15. Zeitserver: <emphasis role="strong">0.europe.pool.ntp.org</emphasis>.
  16. Man sollte einen öffentlichen, generellen Zeitserver verwenden der in der Nähe
  17. des eigenen Anwendungsservers steht. Siehe
  18. <ulink url="http://www.pool.ntp.org">http://www.pool.ntp.org</ulink> für Informationen.
  19. </para>
  20. </note>
  21. <sect2 id="zend.timesync.working.generic">
  22. <title>Generelle Anfragen von Zeitserver</title>
  23. <para>
  24. Die Anfrage der Zeit von einem Zeitserver ist einfach. Zuerst gibt man den Zeitserver an
  25. von dem man die Zeit anfragen will.
  26. </para>
  27. <programlisting role="php"><![CDATA[
  28. $server = new Zend_TimeSync('0.pool.ntp.org');
  29. print $server->getDate()->getIso();
  30. ]]></programlisting>
  31. <para>
  32. Was passiert also im Hintergrund von <classname>Zend_TimeSync</classname>? Zuerst wird der
  33. Syntax des Timeservers geprüft. In unserem Beispiel wird also
  34. '<code>0.pool.ntp.org</code>' geprüft und als möglicherweise richtige Adresse für einen
  35. Zeitserver erkannt. Wenn jetzt <code>getDate()</code> aufgerufen wird, wird der aktuell
  36. gesetzte Zeitserver angefragt und er gibt seine eigene Zeit zurück.
  37. <classname>Zend_TimeSync</classname> berechnet darauf die Differenz zur aktuellen Zeit des
  38. Servers auf dem das Skript läuft und gibt ein <classname>Zend_Date</classname> Objekt mit der
  39. korrigierten Zeit zurück.
  40. </para>
  41. <para>
  42. Für Details über <classname>Zend_Date</classname> und dessen Methoden siehe unter der Dokumentation
  43. von <link linkend="zend.date.introduction"><classname>Zend_Date</classname></link> nach.
  44. </para>
  45. </sect2>
  46. <sect2 id="zend.timesync.working.multiple">
  47. <title>Mehrere Zeitserver</title>
  48. <para>
  49. Nicht alle Zeitserver sind immer erreichbar und geben Ihr Zeit zurück. Server können wärend
  50. Ihrer Wartung nicht erreichbar sein. Senn die Zeit nicht vom Zeitserver angefragt werden kann,
  51. erhält man eine Ausnahme.
  52. </para>
  53. <para>
  54. <classname>Zend_TimeSync</classname> ist eine einfache Lösung die mehrere Zeitserver behandeln kann und
  55. einen automatischen Fallback Mechanismus bietet. Es gibt zwei unterstützte Wege;
  56. man kann entweder ein Array von Zeitserver angeben wenn die Instanz erstellt wird, oder
  57. zusätzliche Zeitserver zur Instanz durch Verwendung der <code>addServer()</code> Methode
  58. hinzufügen.
  59. </para>
  60. <programlisting role="php"><![CDATA[
  61. $server = new Zend_TimeSync(array('0.pool.ntp.org',
  62. '1.pool.ntp.org',
  63. '2.pool.ntp.org'));
  64. $server->addServer('3.pool.ntp.org');
  65. print $server->getDate()->getIso();
  66. ]]></programlisting>
  67. <para>
  68. Es gibt keine Begrenzung in der Anzahl an Zeitservern die hinzugefügt werden können.
  69. Wenn ein Zeitserver nicht erreicht werden kann, dann fällt <classname>Zend_TimeSync</classname>
  70. zurück und versucht den nächsten Zeitserver zu erreichen.
  71. </para>
  72. <para>
  73. Wenn man mehr als einen Zeitserver angibt - was die beste Praxis für <classname>Zend_TimeSync</classname>
  74. ist - sollte man jeden Server benennen. Man kann die Server mit dem Arrayschlüssel, mit dem
  75. zweiten Parameter wärend der Initiierung oder mit dem zweiten Parameter beim Hinzufügen von
  76. anderen Zeitservern, benennen.
  77. </para>
  78. <programlisting role="php"><![CDATA[
  79. $server = new Zend_TimeSync(array('generic' => '0.pool.ntp.org',
  80. 'fallback' => '1.pool.ntp.org',
  81. 'reserve' => '2.pool.ntp.org'));
  82. $server->addServer('3.pool.ntp.org', 'additional');
  83. print $server->getDate()->getIso();
  84. ]]></programlisting>
  85. <para>
  86. Die Benennung der Zeitserver gibt die Möglichkeit das ein spezieller Zeitserver
  87. angefragt werden kann wie man später in diesem Kapitel sieht.
  88. </para>
  89. </sect2>
  90. <sect2 id="zend.timesync.working.protocol">
  91. <title>Protokolle von Zeitservern</title>
  92. <para>
  93. Es gibt verschiedene Typen von Zeitservern. Die meisten öffentlichen Zeitserver
  94. verwenden <emphasis role="strong">NTP</emphasis> als Protokoll. Es sind auch
  95. andere Zeit Synchronisations Prtokolle vorhanden.
  96. </para>
  97. <para>
  98. Man kann das richtige Prokoll mit der Adresse des Zeitservers setzen. Aktuell gibt
  99. es zwei Prokolle die von <classname>Zend_TimeSync</classname> unterstützt werden:
  100. <emphasis role="strong">NTP</emphasis> und <emphasis role="strong">SNTP</emphasis>. Das
  101. Standardprotokoll ist <emphasis role="strong">NTP</emphasis>. Wenn man nur <emphasis role="strong">NTP</emphasis>
  102. verwendet kann das Protkoll in der Adresse, wie im vorherigen Beispiel gezeigt, unterdrücken.
  103. </para>
  104. <programlisting role="php"><![CDATA[
  105. $server = new Zend_TimeSync(array('generic' => 'ntp:\\0.pool.ntp.org',
  106. 'fallback' => 'ntp:\\1.pool.ntp.org',
  107. 'reserve' => 'ntp:\\2.pool.ntp.org'));
  108. $server->addServer('sntp:\\internal.myserver.com', 'additional');
  109. print $server->getDate()->getIso();
  110. ]]></programlisting>
  111. <para>
  112. <classname>Zend_TimeSync</classname> kann gemischte Zeitserver verwenden. Man ist also
  113. nicht auf ein einzelnes Prokoll beschränkt, aber man kann jeden Zeitserver unabhängig
  114. von seinem Protokoll hinzufügen.
  115. </para>
  116. </sect2>
  117. <sect2 id="zend.timesync.working.ports">
  118. <title>Ports für Zeitserver verwenden</title>
  119. <para>
  120. Wie bei jedes Protkoll im World Wide Web, verwenden das
  121. <emphasis role="strong">NTP</emphasis> und <emphasis role="strong">SNTP</emphasis>
  122. Protokoll Standardports. NTP verwendet den Port <emphasis role="strong">123</emphasis>,
  123. und SNTP den Port <emphasis role="strong">37</emphasis>.
  124. </para>
  125. <para>
  126. Aber manchmal differiert der Port den das Protokoll verwendet von Standard. Der zu
  127. verwendende Port kann mit der Adresse für jeden Server definiert werden. Es muß nur
  128. die Nummer des Ports nach der Adresse hinzugefügt werden. Wenn kein Port definiert
  129. wurde, dann verwendet <classname>Zend_TimeSync</classname> den Standardport.
  130. </para>
  131. <programlisting role="php"><![CDATA[
  132. $server = new Zend_TimeSync(array('generic' => 'ntp:\\0.pool.ntp.org:200',
  133. 'fallback' => 'ntp:\\1.pool.ntp.org'));
  134. $server->addServer('sntp:\\internal.myserver.com:399', 'additional');
  135. print $server->getDate()->getIso();
  136. ]]></programlisting>
  137. </sect2>
  138. <sect2 id="zend.timesync.working.options">
  139. <title>Optionen für Zeitserver</title>
  140. <para>
  141. Es gibt nur eine Option in <classname>Zend_TimeSync</classname> die intern verwendet wird:
  142. <emphasis role="strong">timeout</emphasis>. Man kann aber beliebige selbstdefinierte
  143. Optionen verwenden wenn man will und diese auch Abfragen.
  144. </para>
  145. <para>
  146. Die Option <emphasis role="strong">timeout</emphasis> definiert die Anzahl an Sekunden
  147. nach der eine Verbindung als Abgebrochen erkannt wird wenn keine Antwort kommt. Der
  148. Standardwert ist <emphasis role="strong">1</emphasis>, was bedeutet das
  149. <classname>Zend_TimeSync</classname> auf den nächsten Zeitserver zurückfällt wenn der
  150. angefragte Server nicht in einer Sekunde antwortet.
  151. </para>
  152. <para>
  153. Mit der <code>setOptions()</code> Methode kann jede Option gesetzt werden. Diese Funktion
  154. akzeptiert ein Array wobei die Schlüssel die zu setzende Option sind und der Wert der
  155. Wert dieser Option. Jede vorher gesetzte Option wird mit dem neuen Wert überschrieben.
  156. Wenn man wissen will welche Optionen gesetzt sind, kann die <code>getOptions()</code>
  157. Methode verwendet werden. Sie akzeptiert entweder einen Schlüssel welcher die gegebene
  158. Option zurückgibt wenn diese gesetzt ist, oder, wenn kein Schlüssel angegeben wird, gibt
  159. Sie alle gesetzten Optionen zurück.
  160. </para>
  161. <programlisting role="php"><![CDATA[
  162. Zend_TimeSync::setOptions(array('timeout' => 3, 'myoption' => 'timesync'));
  163. $server = new Zend_TimeSync(array('generic' => 'ntp:\\0.pool.ntp.org',
  164. 'fallback' => 'ntp:\\1.pool.ntp.org'));
  165. $server->addServer('sntp:\\internal.myserver.com', 'additional');
  166. print $server->getDate()->getIso();
  167. print_r(Zend_TimeSync::getOptions();
  168. print "Timeout = " . Zend_TimeSync::getOptions('timeout');
  169. ]]></programlisting>
  170. <para>
  171. Wie man sieht sind die Optionen für <classname>Zend_TimeSync</classname> statisch. Jede Instanz von
  172. <classname>Zend_TimeSync</classname> verwendet die gleichen Optionen.
  173. </para>
  174. </sect2>
  175. <sect2 id="zend.timesync.working.different">
  176. <title>Verschiedene Zeitserver verwenden</title>
  177. <para>
  178. <classname>Zend_TimeSync</classname>'s Standardverhalten für die Anfrage einer Zeit ist diese vom ersten
  179. gegebenen Server anzufragen. Manchmal ist es aber sinnvoll einen anderen Zeitserver zu setzen
  180. von dem die Zeit abgefragt werden soll. Das kann mit der <code>setServer()</code> Methode
  181. getan werden. Um den zu verwendenden Zeitserver zu definieren muß einfach der Alias
  182. als Parameter in dieser Methode gesetzt werden. Und um den aktuell verwendeten
  183. Zeitserver zu erhalten kann die <code>getServer()</code> Methode aufgerufen werden.
  184. Wenn kein Parameter angegeben wird, wird der aktuelle Zeitserver zurückgegeben.
  185. </para>
  186. <programlisting role="php"><![CDATA[
  187. $server = new Zend_TimeSync(array('generic' => 'ntp:\\0.pool.ntp.org',
  188. 'fallback' => 'ntp:\\1.pool.ntp.org'));
  189. $server->addServer('sntp:\\internal.myserver.com', 'additional');
  190. $actual = $server->getServer();
  191. $server = $server->setServer('additional');
  192. ]]></programlisting>
  193. </sect2>
  194. <sect2 id="zend.timesync.working.informations">
  195. <title>Informationen von Zeitservern</title>
  196. <para>
  197. Zeitserver bieten nicht nur die Zeit selbst sondern auch zusätzliche Informationen.
  198. Man kann diese Informationen mit der <code>getInfo()</code> Methode erhalten.
  199. </para>
  200. <programlisting role="php"><![CDATA[
  201. $server = new Zend_TimeSync(array('generic' => 'ntp:\\0.pool.ntp.org',
  202. 'fallback' => 'ntp:\\1.pool.ntp.org'));
  203. print_r ($server->getInfo());
  204. ]]></programlisting>
  205. <para>
  206. Die zurückgegebenen Informationen unterscheiden sich im verwendeten Protokoll und sie
  207. unterscheiden sich auch im verwendeten Server.
  208. </para>
  209. </sect2>
  210. <sect2 id="zend.timesync.working.exceptions">
  211. <title>Behandeln von Ausnahmen</title>
  212. <para>
  213. Ausnahmen werden für alle Zeitserver gesammelt und werden als Array zurückgegeben. Es
  214. ist also möglich durch alle geworfenen Ausnahmen zu laufen wie im folgenden Beispiel
  215. gezeigt:
  216. </para>
  217. <programlisting role="php"><![CDATA[
  218. $serverlist = array(
  219. // invalid servers
  220. 'invalid_a' => 'ntp://a.foo.bar.org',
  221. 'invalid_b' => 'sntp://b.foo.bar.org',
  222. );
  223. $server = new Zend_TimeSync($serverlist);
  224. try {
  225. $result = $server->getDate();
  226. echo $result->getIso();
  227. } catch (Zend_TimeSync_Exception $e) {
  228. $exceptions = $e->get();
  229. foreach ($exceptions as $key => $myException) {
  230. echo $myException->getMessage();
  231. echo '<br />';
  232. }
  233. }
  234. ]]></programlisting>
  235. </sect2>
  236. </sect1>