fix documentation

This commit is contained in:
Miek Gieben 2012-05-18 19:41:20 +02:00
parent bf3771da8e
commit 0ff492af57
3 changed files with 5 additions and 4 deletions

View File

@ -6,7 +6,7 @@ be fixed.
* Speed, we can always go faster. A simple reflect server now hits 35/45K qps
* go test; only works correct on my machine
* privatekey.Precompute() when signing?
* outgoing xfr fixen
* outgoing [AI]xfr
* zonereader that extracts glue (or at least signals it) and other usefull stuff?
## Examples to add

View File

@ -306,7 +306,7 @@ func (c *Client) Exchange(m *Msg, a string) (r *Msg, err error) {
// contained in a and waits for an reply. Basic use pattern with a *Client:
//
// c := dns.NewClient()
// in, rtt, addr, err := c.Exchange(message, "127.0.0.1:53")
// in, rtt, addr, err := c.ExchangeFull(message, "127.0.0.1:53")
//
// The 'addr' return value is superfluous in this case, but it is here to retain symmetry
// with the asynchronous call, see Client.Do().

5
xfr.go
View File

@ -2,15 +2,16 @@ package dns
// XfrReceives requests an incoming Ixfr or Axfr. If the message q's question
// section has type TypeAXFR an Axfr is performed, if it is TypeIXFR it does an Ixfr.
// The [AI]xfr's records are returned on the channel. Note the with an IXFR the client
// The [AI]xfr's records are returned on the channel. Note that with an IXFR the client
// needs to determine if records are to be removed are added.
// The channel is closed when the transfer is terminated.
//
// Basic use pattern for setting up a transfer:
//
// // m contains the [AI]xfr request
// t, _ := client.XfrReceive(m, "127.0.0.1:53")
// for r := range t {
// //
// // ... deal with r.Reply or r.Error
// }
func (c *Client) XfrReceive(q *Msg, a string) (chan *Exchange, error) {
w := new(reply)