[asterisk-dev] [Code Review] 4085: ExtensionStatus: Add additional documentation describing the ExtensionStatus event

[Jonathan Rose]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviewboard.asterisk.org/r/4085/
-----------------------------------------------------------

Review request for Asterisk Developers, Matt Jordan and Mark Michelson.


Repository: Asterisk


Description
-------

Some internals developers pointed out that this event was poorly documented, particularly when it comes to Status and StatusText which really need to be explained in order to be useful.


Diffs
-----

  /branches/13/main/manager.c 425546 

Diff: https://reviewboard.asterisk.org/r/4085/diff/


Testing
-------

Checked the output of

> manager show event ExtensionStatus

Exten
    Name of the extension.
Context
    Context that owns the extension.
Hint
    Devices mapped to the extension which determine the extension status
Status
    Numerical data indicating the status of the extension based on its
    devices. Negative values indicate that the extension was removed (-2)
    or deactivated (-1). Zero indicates that the extension is idle. Positive
    values work as bitflags and may combine to indicate different things.
    For example 1 would mean inuse, 2 would mean busy, and the two can add
    together additively into 3 to mean that a line is both inuse and busy.
    Each of the major classifications is a power of two and they can
    potentailly be added in any combination.
    -2 - Removed - The extension was removed. Not additive.
    -1 - Deactivated - The extension's hit was removed. Not additive.
    0 - Idle - No device INUSE or BUSY. Not additive.
    1 - In Use - one or more devices INUSE. Additive.
    2 - Busy - All devices are BUSY. Additive.
    4 - Unavailable - All devices are UNAVAILABLE and/or UNREGISTERED.
    Additive.
    8 - Ringing - All devices are RINGING. Additive.
    16 - Onhold - All devices are ONHOLD. Additive.
StatusText
    Human readable representation of the status. The options are also
    more strictly defined and may only be one thing from the following
    enumerator.
    Idle - No device INUSE or BUSY.
    InUse - One or more devices are INUSE.
    Busy - All devices are BUSY.
    Unavailable - All devices are UNAVAILABLE and/or UNREGISTERED
    Ringing - All devices are RINGING
    InUse&Ringing - All devices are RINGING and one or more devices are
    INUSE
    Hold - All devices are ONHOLD.
    InUse&Hold - All devices are ONHOLD and one or more devices are INUSE
    Unknown - None of the above descriptions matched the status
    value


Thanks,

Jonathan Rose

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-dev/attachments/20141015/f40bf673/attachment.html>