diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 54 |
1 files changed, 49 insertions, 5 deletions
@@ -24,9 +24,6 @@ Features include: - I/O Formats selectable on a per-client basis - Written in c/pthreads to be fast and robust -For example, you can use Astmanproxy as a single point of contact to -communicate with multiple Asterisk servers. - You can use Astmanproxy as the basis for a web-based application: send it data using HTTP POST or HTTP GET, and receive XML output. Or use HTTP POST and get Standard (text/plain) output back! @@ -98,6 +95,7 @@ OutputFormat: (standard|xml) ProxyAction: SetAutoFilter AutoFilter: (on|off) Sets the AutoFilter property on a per-client basis + (See autofiltering section below) ProxyAction: Logoff Logs client out of Proxy and leaves Asterisk alone. @@ -165,6 +163,52 @@ Blank Commands blank command blocks. =================================================================== +AstManProxy Autofiltering Functionality + +One of the most powerful features of AstManProxy is its ability to +automatically filter output on a per-client basis. It can do this +with its Autofilter capability, which can be set 'on' in the config +file or enabled via the ProxyAction: SetAutoFilter function. + +With autofiltering enabled, each client only receives output containing +the "ActionID" parameter it has set most recently. This is useful +for single atomic requests into asterisk from a client, such as +when creating a simple UI to inject a command. + +For example, if a client sends this packet while autofiltering is +enabled: + +Action: Ping +ActionID: foo + +Then the autofilter ActionID for that client is set to foo, and no +output besides for responses containing "foo" will be returned +to that client, such as: + +Response: Pong +ActionID: foo + +Replace Ping with Originate and Pong with Success and you can see +how this same mechanism can be used to quickly query asterisk +box(es), initiate calls, etc, without your client having to worry +with filtering a lot of unrelated output. + +=================================================================== +On the astmanproxy.users output filtering functionality + +Users may now be defined in your astmanproxy.users configuration file. +This enables a traditional user/password based login mechanism +for Astmanproxy similar to what is found in Asterisk. Output may be +filtered on a per-user basis. + +"user" is the username, secret is the password, and the (optional) +channel setting causes filtering of events only for the specified +channel to be sent to this user. + +; user=secret,channel,out_context (to Asterisk),in_context (From Asterisk) +; steve=steve,SIP/snom190,local, + +=================================================================== On the 'Action: Challenge' Authentication Mechanism John Todd wrote this excellent summary of the Action: Challenge @@ -280,7 +324,7 @@ Be sure to use the full URL path to the version you wish to check out; for example, do not checkout the 'branches' tree, but instead choose which branch to checkout, as in: -http://svncommunity.digium.com/view/astmanproxy/branches/1.2x +http://svncommunity.digium.com/svn/astmanproxy/branches/1.2x I will also try to post current tarballs here: http://www.popvox.com/astmanproxy @@ -342,4 +386,4 @@ and output format -- implemented as abstracted I/O handlers -- and these are configurable on a per-client basis. =================================================================== -(C) 2005 David C. Troy, dave@popvox.com +(C) 2005-2006 David C. Troy, dave@popvox.com |