From ac96458dcd57922e165b2cdce6b2e196b83d012e Mon Sep 17 00:00:00 2001 From: Aki Tuomi Date: Wed, 21 Aug 2013 10:28:39 +0300 Subject: [PATCH] Changed backend to connector for remotebackend docs --- pdns/docs/pdns.xml | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/pdns/docs/pdns.xml b/pdns/docs/pdns.xml index d61d4a6485..c751ea47db 100755 --- a/pdns/docs/pdns.xml +++ b/pdns/docs/pdns.xml @@ -19605,7 +19605,7 @@ record building scripts on his - * If provided by the underlying backend. + * If provided by the responder (your script). - This backend provides unix socket / pipe / http remoting for powerdns. + This backend provides unix socket / pipe / http remoting for powerdns. You should think this as normal RPC thin client, which converts native C++ calls into JSON/RPC and passes them to you via connector. Important notices Please do not use remotebackend shipped before version 3.3. This version has severe bug that can crash the entire process. @@ -19648,12 +19648,12 @@ remote-connection-string=<type>:<param>=<value>,<param>= - You can pass as many parameters as you want. For unix and pipe backends, these + You can pass as many parameters as you want. For unix and pipe connectors, these are passed along to the remote end as initialization. See . - Initialize is not called for http backend. + Initialize is not called for http connector. - Unix backend + Unix connector parameters: path, timeout (default 2000ms) @@ -19664,7 +19664,7 @@ remote-connection-string=unix:path=/path/to/socket - Pipe backend + Pipe connector parameters: command,timeout (default 2000ms) @@ -19676,7 +19676,7 @@ remote-connection-string=unix:command=/path/to/executable,timeout=2000 - HTTP backend + HTTP connector parameters: url, url-suffix, post, post_json, cafile, capath, timeout (default 2000) @@ -19686,7 +19686,7 @@ remote-connection-string=http:url=http://localhost:63636/dns,url-suffix=.php - HTTP backend tries to do RESTful requests to your server. See examples. You can also + HTTP connector tries to do RESTful requests to your server. See examples. You can also use post to change behaviour so that it will send POST request to url/method + url_suffix with parameters=json-formatted-parameters. If you use post and post_json, it will POST url with text/javascript containing JSON formatted RPC request, just like for pipe and unix. @@ -19696,7 +19696,7 @@ remote-connection-string=http:url=http://localhost:63636/dns,url-suffix=.php URL should not end with /, and url-suffix is optional, but if you define it, it's up to you to write the ".php" or ".json". Lack of dot causes lack of dot in URL. Timeout is divided by 1000 because libcurl only supports seconds, but this is - given in milliseconds for consistency with other backends. + given in milliseconds for consistency with other connectors. You can use HTTPS requests. If cafile and capath is left empty, remote SSL certificate is not checked. @@ -19708,19 +19708,19 @@ remote-connection-string=http:url=http://localhost:63636/dns,url-suffix=.php API Queries - Unix and Pipe backend sends JSON formatted string to the remote end. Each + Unix and Pipe connector sends JSON formatted string to the remote end. Each JSON query has two sections, 'method' and 'parameters'. - HTTP backend calls methods based on URL and has parameters in the query string. - Most calls are GET; see the methods listing for details. + HTTP connector calls methods based on URL and has parameters in the query string. + Most calls are GET; see the methods listing for details. You can change this with post and post_json attributes. Replies You *must* always reply with JSON hash with at least one key, 'result'. This must be boolean false if the query failed. Otherwise it must conform to the expected - result. For HTTP backend, to signal bare success, you can just reply with HTTP 200 OK, and omit any output. This will result in same outcome as sending {"result":true}. + result. For HTTP connector, to signal bare success, you can just reply with HTTP 200 OK, and omit any output. This will result in same outcome as sending {"result":true}. You can optionally add 'log' array, each line in this array will be logged in @@ -19733,7 +19733,7 @@ remote-connection-string=http:url=http://localhost:63636/dns,url-suffix=.php Mandatory: - Yes (except HTTP backend) + Yes (except HTTP connector) Parameters: @@ -19745,7 +19745,7 @@ remote-connection-string=http:url=http://localhost:63636/dns,url-suffix=.php Description - Called to initialize the backend. This is not called for HTTP backend. You should + Called to initialize the backend. This is not called for HTTP connector. You should do your initializations here. @@ -21286,7 +21286,7 @@ Content-Type: text/javascript; charset=utf-8 Examples - Scenario: SOA lookup via pipe or unix + Scenario: SOA lookup via pipe or unix connector Query: @@ -21319,7 +21319,7 @@ Reply: -Scenario: SOA lookup via HTTP backend +Scenario: SOA lookup with HTTP connector Query: -- 2.47.2