Zend_TimeSync-Working.xml 13 KB

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