Changeset 2557

Timestamp:

04/06/12 12:29:04 (15 months ago)

Author:

peter

Message:

doc updates, mostly for backend writers

Files:

• trunk/pdns/pdns/docs/pdns.xml (modified) (11 diffs)

trunk/pdns/pdns/docs/pdns.xml

@@ -10222 +10222 @@
     <para>
       Another very important setting <command>cache-ttl</command>. PDNS caches entire packets it sends out so as to save the
-      time to query backends to assemble all data. The default setting of 10 seconds may be low for high traffic sites, a value of
+      time to query backends to assemble all data. The default setting of 20 seconds may be low for high traffic sites, a value of
       60 seconds rarely leads to problems.
     </para>
@@ -13438 +13438 @@
           <varlistentry><term>slave-cycle-interval=60</term>
             <listitem><para>
-              Schedule slave up-to-date checks of domains whose status is unknown every .. seconds. See <xref linkend="fancy-records"/>.
+              Schedule slave up-to-date checks of domains whose status is unknown every .. seconds.
               </para></listitem></varlistentry>
           <varlistentry><term>smtpredirector=...</term>
@@ -17334 +17334 @@
         public:
 
-        virtual bool lookup(const QType &amp;qtype, const string &amp;qdomain, DNSPacket *pkt_p=0, int zoneId=-1)=0; 
-        virtual bool list(int domain_id)=0; 
+        virtual void lookup(const QType &amp;qtype, const string &amp;qdomain, DNSPacket *pkt_p=0, int zoneId=-1)=0;
+        virtual bool list(const string &amp;target, int domain_id)=0;
         virtual bool get(DNSResourceRecord &amp;r)=0;
-        virtual bool getSOA(const string &amp;name, SOAData &amp;soadata);
+        virtual bool getSOA(const string &amp;name, SOAData &amp;soadata, DNSPacket *p=0);
         };
         </programlisting>
@@ -17407 +17407 @@
 {
 public:
-  bool list(int id) {
+  bool list(const string &amp;target, int id)
+  {
     return false; // we don't support AXFR
   }
@@ -17507 +17508 @@
               </row>
               <row>
-                <entry>u_int16_t priority</entry><entry>priority of an MX record.</entry>
+                <entry>uint16_t priority</entry><entry>priority of an MX record.</entry>
               </row>
               <row>
-                <entry>u_int32_t ttl</entry><entry>Time To Live of this record</entry>
+                <entry>uint32_t ttl</entry><entry>Time To Live of this record</entry>
               </row>
               <row>
@@ -17517 +17518 @@
               <row>
                 <entry>time_t last_modified</entry><entry>If unzero, last time_t this record was changed</entry>
+              </row>
+              <row>
+                <entry>bool auth</entry><entry>Used for DNSSEC operations. See <xref linkend="powerdnssec-auth" /> and more specifically <xref linkend="dnssec-migration" />. It is also useful to check out the <function>rectifyZone()</function> in pdnssec.cc</entry>
               </row>
             </tbody>
@@ -17592 +17596 @@
                 </para>
                 <para>
-                  It is legal to return here, and have the first call to <function>get()</function> return false. This is interpreted as 'no data'
+                  It is legal to return here, and have the first call to <function>get()</function> return false. This is interpreted as 'no data'.
                 </para>
               </listitem>
@@ -17824 +17828 @@
             <tbody>
               <row>
-                <entry>int id</entry><entry>ID of this zone within this backend</entry>
+                <entry>uint32_t id</entry><entry>ID of this zone within this backend</entry>
               </row>
               <row>
@@ -17830 +17834 @@
               </row>
               <row>
-                <entry>u_int32_t serial</entry><entry>Serial number of this zone</entry>
+                <entry>uint32_t serial</entry><entry>Serial number of this zone</entry>
               </row>
               <row>
-                <entry>u_int32_t notified_serial</entry><entry>Last serial number of this zone that slaves have seen</entry>
+                <entry>uint32_t notified_serial</entry><entry>Last serial number of this zone that slaves have seen</entry>
               </row>
               <row>
@@ -17994 +17998 @@
            /* ... */
            virtual void getUpdatedMasters(vector&lt;DomainInfo&gt;* domains);
-           virtual void setNotified(int id, u_int32_t serial);
+           virtual void setNotified(uint32_t id, uint32_t serial);
            /* ... */
          }
@@ -18015 +18019 @@
           </varlistentry>
           <varlistentry>
-            <term>bool setNotified(int domain_id, u_int32_t serial)</term>
+            <term>bool setNotified(uint32_t domain_id, uint32_t serial)</term>
             <listitem>
               <para>