diff options
author | mmichelson <mmichelson@f38db490-d61c-443f-a65b-d21fe96a405b> | 2009-02-17 21:40:09 +0000 |
---|---|---|
committer | mmichelson <mmichelson@f38db490-d61c-443f-a65b-d21fe96a405b> | 2009-02-17 21:40:09 +0000 |
commit | 509eed412d8799df9e4bcad9fa5299407219bc48 (patch) | |
tree | 6da358c2b50b3d6c2760f12d1375935507ca5c6b /include/asterisk/frame.h | |
parent | cf9f8256b92a61289b3e48304d3bd1c065836e17 (diff) |
Clear up documentation of AST_FRIENDLY_OFFSET in frame.h
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@176697 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'include/asterisk/frame.h')
-rw-r--r-- | include/asterisk/frame.h | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/include/asterisk/frame.h b/include/asterisk/frame.h index 4a18bdbac..bb547962c 100644 --- a/include/asterisk/frame.h +++ b/include/asterisk/frame.h @@ -194,9 +194,17 @@ struct ast_frame { for this purpose instead of having to declare one on the stack */ extern struct ast_frame ast_null_frame; -#define AST_FRIENDLY_OFFSET 64 /*! It's polite for a a new frame to - have this number of bytes for additional - headers. */ +/*! \brief Offset into a frame's data buffer. + * + * By providing some "empty" space prior to the actual data of an ast_frame, + * this gives any consumer of the frame ample space to prepend other necessary + * information without having to create a new buffer. + * + * As an example, RTP can use the data from an ast_frame and simply prepend the + * RTP header information into the space provided by AST_FRIENDLY_OFFSET instead + * of having to create a new buffer with the necessary space allocated. + */ +#define AST_FRIENDLY_OFFSET 64 #define AST_MIN_OFFSET 32 /*! Make sure we keep at least this much handy */ /*! Need the header be free'd? */ |