|
|
@@ -1,4 +1,4 @@
|
|
|
-1. Blst Module
|
|
|
+Blst Module
|
|
|
|
|
|
Andrei Pelinescu-Onciul
|
|
|
|
|
|
@@ -7,25 +7,22 @@ Andrei Pelinescu-Onciul
|
|
|
Copyright © 2007 iptelorg GmbH
|
|
|
__________________________________________________________________
|
|
|
|
|
|
- 1.1. Overview
|
|
|
- 1.2. Functions
|
|
|
+ List of Examples
|
|
|
|
|
|
- 1.2.1. blst_add([timeout])
|
|
|
- 1.2.2. blst_add_retry_after(min, max)
|
|
|
- 1.2.3. blst_del()
|
|
|
- 1.2.4. blst_is_blacklisted()
|
|
|
- 1.2.5. blst_set_ignore([flags])
|
|
|
- 1.2.6. blst_rpl_set_ignore([flags])
|
|
|
- 1.2.7. blst_clear_ignore([flags])
|
|
|
- 1.2.8. blst_rpl_clear_ignore([flags])
|
|
|
+ 1. blst_add usage
|
|
|
+ 2. blst_add_retry_after usage
|
|
|
+ 3. blst_del usage
|
|
|
+ 4. blst_is_blacklisted usage
|
|
|
+ 5. blst_set_ignore usage
|
|
|
+ 6. blst_clear_ignore usage
|
|
|
|
|
|
-1.1. Overview
|
|
|
+1. Overview
|
|
|
|
|
|
This module exports blacklist related functions to the script.
|
|
|
|
|
|
-1.2. Functions
|
|
|
+2. Functions
|
|
|
|
|
|
-1.2.1. blst_add([timeout])
|
|
|
+2.1. blst_add([timeout])
|
|
|
|
|
|
Adds the source of the current message to the blacklist for timeout
|
|
|
seconds. If timeout is missing or 0 it uses the default blacklist
|
|
|
@@ -39,7 +36,7 @@ else
|
|
|
blst_add(); # use default blacklist timeout
|
|
|
...
|
|
|
|
|
|
-1.2.2. blst_add_retry_after(min, max)
|
|
|
+2.2. blst_add_retry_after(min, max)
|
|
|
|
|
|
Adds the source of the current message to the blacklist for the time
|
|
|
interval specified in the Retry-After header. If the Retry-After header
|
|
|
@@ -57,7 +54,7 @@ if (msg_status==503){ # blacklist 503 source for Retry-After seconds
|
|
|
}
|
|
|
...
|
|
|
|
|
|
-1.2.3. blst_del()
|
|
|
+2.3. blst_del()
|
|
|
|
|
|
Removes the source of the current message from the blacklist. If the
|
|
|
address is not present in the blacklist at the time of the call it
|
|
|
@@ -68,7 +65,7 @@ if (msg_status==503){ # blacklist 503 source for Retry-After seconds
|
|
|
blst_del();
|
|
|
...
|
|
|
|
|
|
-1.2.4. blst_is_blacklisted()
|
|
|
+2.4. blst_is_blacklisted()
|
|
|
|
|
|
Returns true if the source of the current message is blacklisted.
|
|
|
|
|
|
@@ -80,7 +77,7 @@ if (msg_status==503){ # blacklist 503 source for Retry-After seconds
|
|
|
}
|
|
|
...
|
|
|
|
|
|
-1.2.5. blst_set_ignore([flags])
|
|
|
+2.5. blst_set_ignore([flags])
|
|
|
|
|
|
Set errors that will not be taken into account when deciding whether to
|
|
|
blacklist a destination for the current message or a local reply to the
|
|
|
@@ -111,11 +108,11 @@ Note
|
|
|
Example 5. blst_set_ignore usage
|
|
|
blst_set_ignore(6); # ignore send and connect errors
|
|
|
|
|
|
-1.2.6. blst_rpl_set_ignore([flags])
|
|
|
+2.6. blst_rpl_set_ignore([flags])
|
|
|
|
|
|
See function blst_set_ignore([flags]).
|
|
|
|
|
|
-1.2.7. blst_clear_ignore([flags])
|
|
|
+2.7. blst_clear_ignore([flags])
|
|
|
|
|
|
Clears blacklist ignore flags previously set by the corresponding
|
|
|
blst_set_ignore(...) or blst_rpl_set_ignore(...) functions.
|
|
|
@@ -125,6 +122,6 @@ Note
|
|
|
Example 6. blst_clear_ignore usage
|
|
|
blst_clear_ignore(4); # ignore connect errors
|
|
|
|
|
|
-1.2.8. blst_rpl_clear_ignore([flags])
|
|
|
+2.8. blst_rpl_clear_ignore([flags])
|
|
|
|
|
|
See function blst_clear_ignore([flags]).
|
Olle E. Johansson