documentation/manual/en/module_specs/Zend_TimeSync.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect1 id="zend.timesync.introduction">
   4     <title>Introduction</title>
   5
   6     <para>
   7         <classname>Zend_TimeSync</classname> is able to receive internet or network time from a time
   8         server using the <emphasis>NTP</emphasis> or <emphasis>SNTP</emphasis> protocol.
   9         With <classname>Zend_TimeSync</classname>, Zend Framework is able to act independently from
  10         the time settings of the server where it is running.
  11     </para>
  12
  13     <para>
  14         To be independent from the actual time of the server, <classname>Zend_TimeSync</classname>
  15         works with the difference of the real time which is sent through NTP or SNTP and the
  16         internal server's time.
  17     </para>
  18
  19     <note>
  20         <title>Background</title>
  21
  22         <para>
  23             <classname>Zend_TimeSync</classname> is not able to change the server's time, but it
  24             will return a <link linkend="zend.date.introduction">Zend_Date</link> instance from
  25             which the difference from the server's time can be worked with.
  26         </para>
  27     </note>
  28
  29     <sect2 id="zend.timesync.introduction.why">
  30         <title>Why Zend_TimeSync ?</title>
  31
  32         <para>
  33             So why would someone use <classname>Zend_TimeSync</classname> ?
  34         </para>
  35
  36         <para>
  37             Normally every server within a multi-server farm will have a service running which
  38             synchronizes its own time with a time server. So within a standard environment it should
  39             not be necessary to use <classname>Zend_TimeSync</classname>. But it can become handy if
  40             there is no service available and if you don't have the right to install such a service.
  41         </para>
  42
  43         <para>
  44             Here are some example use cases, for which <classname>Zend_TimeSync</classname> is
  45             perfect suited:
  46         </para>
  47
  48         <itemizedlist mark='opencircle'>
  49             <listitem>
  50                 <para>
  51                     <emphasis>Server without time service</emphasis>
  52                 </para>
  53
  54                 <para>
  55                     If your application is running on a server and this server does not have any
  56                     time service running, it may make sense to use
  57                     <classname>Zend_TimeSync</classname> in your application.
  58                 </para>
  59             </listitem>
  60
  61             <listitem>
  62                 <para>
  63                     <emphasis>Separate database server</emphasis>
  64                 </para>
  65
  66                 <para>
  67                     If your database is running on a different server and this server is not
  68                     connected with <emphasis>NTP</emphasis> or <emphasis>SNTP</emphasis>
  69                     to the application server, you might have problems using storing and using time
  70                     stamp data.
  71                 </para>
  72             </listitem>
  73
  74             <listitem>
  75                 <para>
  76                     <emphasis>Multiple servers</emphasis>
  77                 </para>
  78
  79                 <para>
  80                     If your application is running on more than one server and these servers' time
  81                     bases are not syncronized, you can expect problems within your application when
  82                     part of the application is coming from one server and another part from another
  83                     server.
  84                 </para>
  85             </listitem>
  86
  87             <listitem>
  88                 <para>
  89                     <emphasis>Batch processing</emphasis>
  90                 </para>
  91
  92                 <para>
  93                     If you want to work with a time service within a batch file or within a
  94                     command line application, <classname>Zend_TimeSync</classname> may be of use.
  95                 </para>
  96             </listitem>
  97         </itemizedlist>
  98
  99         <para>
 100             <classname>Zend_TimeSync</classname> may provide a good solution in all of these cases
 101             and can be used if you are unable to run any services on your server.
 102         </para>
 103     </sect2>
 104
 105     <sect2 id="zend.timesync.introduction.ntp">
 106         <title>What is NTP ?</title>
 107
 108         <para>
 109             The Network Time Protocol (<emphasis>NTP</emphasis>) is a protocol
 110             for synchronizing multiple systems' clocks over packet-switched, variable-latency data
 111             networks. NTP uses UDP port 123 as its transport layer. See the <ulink
 112                 url="http://en.wikipedia.org/wiki/Network_Time_Protocol">wikipedia article</ulink>
 113             for details about this protocol.
 114         </para>
 115     </sect2>
 116
 117     <sect2 id="zend.timesync.introduction.sntp">
 118         <title>What is SNTP?</title>
 119
 120         <para>
 121             The Simple Network Time Protocol (<emphasis>SNTP</emphasis>) is a
 122             protocol synchronizing multiple systems' clocks over packet-switched, variable-latency
 123             data networks. SNTP uses UDP port 37 as its transport layer. It is closely related to
 124             the Network Time Protocol, but simpler.
 125         </para>
 126     </sect2>
 127
 128     <sect2 id="zend.timesync.introduction.problematic">
 129         <title>Problematic usage</title>
 130
 131         <para>
 132             Be warned that when you are using <classname>Zend_TimeSync</classname> you will have to
 133             think about some details related to the structure of time sync and the internet itself.
 134             Correct usage and best practices will be described here. Read carefully before you begin
 135             using <classname>Zend_TimeSync</classname>.
 136         </para>
 137     </sect2>
 138
 139     <sect2 id="zend.timesync.introduction.decision">
 140         <title>Decide which server to use</title>
 141
 142         <para>
 143             You should select the time server that you want to use very carefully according to the
 144             following criteria:
 145         </para>
 146
 147         <itemizedlist mark='opencircle'>
 148             <listitem>
 149                 <para>
 150                     Distance
 151                 </para>
 152
 153                 <para>
 154                     The distance from your application server to the time server. If your server is
 155                     in Europe, it would make little sense to select a time server in Tahiti. Always
 156                     select a server which is not far away. This reduces the request time and overall
 157                     network load.
 158                 </para>
 159             </listitem>
 160
 161             <listitem>
 162                 <para>
 163                     Speed
 164                 </para>
 165
 166                 <para>
 167                     How long it takes to receive the request is also relevant. Try different servers
 168                     to get the best result. If you are requesting a server which is never
 169                     accessible, you will always have an unnecessary delay.
 170                 </para>
 171             </listitem>
 172
 173             <listitem>
 174                 <para>
 175                     Splitting
 176                 </para>
 177
 178                 <para>
 179                     Do not always use the same server. All time servers will lock out requests from
 180                     servers that are flooding the server. If your application requires heavy use of
 181                     time servers, you should consider one of the pools described later.
 182                 </para>
 183             </listitem>
 184         </itemizedlist>
 185
 186         <para>
 187             So where can you find a time server? Generally you can use any timeserver you can
 188             connect to. This can be a time server within your LAN or any public time server you have
 189             access to. If you decide to use a public time server, you should consider using a server
 190             pool. Server pools are public addresses from which you will get a random, pooled time
 191             server by requesting the time. This way you will not have to split your requests. There
 192             are public server pools available for many regions which you may use to avoid problems
 193             mentioned above.
 194         </para>
 195
 196         <para>
 197             See <ulink url="http://www.pool.ntp.org">pool.ntp.org</ulink> to find your nearest
 198             server pool. For example, if your server is located within Germany you can connect to
 199             <emphasis>0.europe.pool.ntp.org</emphasis>.
 200         </para>
 201     </sect2>
 202 </sect1>