diff options
| author | oej <oej@f38db490-d61c-443f-a65b-d21fe96a405b> | 2006-04-04 07:59:02 +0000 |
|---|---|---|
| committer | oej <oej@f38db490-d61c-443f-a65b-d21fe96a405b> | 2006-04-04 07:59:02 +0000 |
| commit | 48e3469f05a9a3b6ddf0286ff2a4bc115122a1a6 (patch) | |
| tree | 92bad1e817bd0cc134548572cb0f734c8c6316da /doc | |
| parent | 1ad6e500c4bcb297897ae8a1f90cfc3dc325c6cd (diff) | |
Clarify syntax of new manager events that reports a status.
We do not longer approve "ThisEventOn" and "ThisEventOff" named events,
they need to be named "ThisEvent" with a status header showing the
current status.
(Approved by Mark)
Old events won't be changed to keep backwards compatibility,
until we have a revision plan for the AMI.
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@17199 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/CODING-GUIDELINES | 13 | ||||
| -rw-r--r-- | doc/manager.txt | 1 |
2 files changed, 14 insertions, 0 deletions
diff --git a/doc/CODING-GUIDELINES b/doc/CODING-GUIDELINES index c8afc704e..a19fd0ad0 100644 --- a/doc/CODING-GUIDELINES +++ b/doc/CODING-GUIDELINES @@ -522,6 +522,19 @@ int len = 0; if (name && (len = strlen(name) + strlen(prefix) + strlen(postfix) + 3) && (newname = alloca(len))) snprintf(newname, len, "%s/%s/%s", prefix, name, postfix); +* Creating new manager events? +------------------------------ +If you create new AMI events, please read manager.txt. Do not re-use +existing headers for new purposes, but please re-use existing headers +for the same type of data. + +Manager events that signal a status are required to have one +event name, with a status header that shows the status. +The old style, with one event named "ThisEventOn" and another named +"ThisEventOff", is no longer approved. + +Check manager.txt for more information on manager and existing +headers. Please update this file if you add new headers. ----------------------------------------------- Welcome to the Asterisk development community! diff --git a/doc/manager.txt b/doc/manager.txt index 065d70a21..cee0c470a 100644 --- a/doc/manager.txt +++ b/doc/manager.txt @@ -296,3 +296,4 @@ Some standard AMI headers: ** Please try to re-use existing headers to simplify manager message parsing in clients. +Read the CODING-GUIDELINES if you develop new manager commands or events. |