Changeset 556

Show
Ignore:
Timestamp:
04/01/01 23:18:50 (13 years ago)
Author:
ucacoxh
Message:

Added documentation for memory.[ch] and debug.[ch]

Changed rtp_get_userdata void* return type to uint8_t*.

Location:
common/trunk
Files:
15 modified

Legend:

Unmodified
Added
Removed
  • common/trunk/doc/html/book1.html

    r546 r556  
    7878>RTP</A 
    7979> &#8212; Real-Time Transport Protocol (RTP) Implementation.</DT 
     80><DT 
     81><A 
     82HREF="uclmmbase-debug.html" 
     83>Debug</A 
     84> &#8212; Functions for outputing diagnostics.</DT 
     85><DT 
     86><A 
     87HREF="uclmmbase-memory.html" 
     88>Memory</A 
     89> &#8212; Memory allocation and debugging functions.</DT 
    8090></DL 
    8191></DD 
  • common/trunk/doc/html/uclmmbase-rtp.html

    r555 r556  
    1414REL="PREVIOUS" 
    1515TITLE="NETUDP" 
    16 HREF="uclmmbase-net-udp.html"></HEAD 
     16HREF="uclmmbase-net-udp.html"><LINK 
     17REL="NEXT" 
     18TITLE="Debug" 
     19HREF="uclmmbase-debug.html"></HEAD 
    1720><BODY 
    1821CLASS="REFENTRY" 
     
    99102BGCOLOR="#C00000" 
    100103ALIGN="right" 
    101 >&nbsp;</TD 
     104><A 
     105HREF="uclmmbase-debug.html" 
     106><FONT 
     107COLOR="#FFFFFF" 
     108SIZE="3" 
     109><B 
     110>Next Page &#62;&#62;&#62;</B 
     111></FONT 
     112></A 
     113></TD 
    102114></TR 
    103115></TABLE 
     
    233245>rtp_callback</A 
    234246> callback, 
    235                                              void *userdata); 
     247                                             <GTKDOCLINK 
     248HREF="UINT8-T" 
     249>uint8_t</GTKDOCLINK 
     250> *userdata); 
    236251<GTKDOCLINK 
    237252HREF="RTP-T" 
     
    259274>rtp_callback</A 
    260275> callback, 
    261                                              void *userdata); 
     276                                             <GTKDOCLINK 
     277HREF="UINT8-T" 
     278>uint8_t</GTKDOCLINK 
     279> *userdata); 
    262280void        <A 
    263281HREF="uclmmbase-rtp.html#RTP-SEND-BYE" 
     
    513531>rtp</GTKDOCLINK 
    514532> *session); 
    515 void*       <A 
     533<GTKDOCLINK 
     534HREF="UINT8-T" 
     535>uint8_t</GTKDOCLINK 
     536>*    <A 
    516537HREF="uclmmbase-rtp.html#RTP-GET-USERDATA" 
    517538>rtp_get_userdata</A 
     
    527548CLASS="REFSECT1" 
    528549><A 
    529 NAME="AEN595" 
     550NAME="AEN598" 
    530551></A 
    531552><H2 
     
    538559CLASS="REFSECT1" 
    539560><A 
    540 NAME="AEN598" 
     561NAME="AEN601" 
    541562></A 
    542563><H2 
     
    545566CLASS="REFSECT2" 
    546567><A 
    547 NAME="AEN600" 
     568NAME="AEN603" 
    548569></A 
    549570><H3 
     
    571592CLASS="REFSECT2" 
    572593><A 
    573 NAME="AEN605" 
     594NAME="AEN608" 
    574595></A 
    575596><H3 
     
    597618CLASS="REFSECT2" 
    598619><A 
    599 NAME="AEN610" 
     620NAME="AEN613" 
    600621></A 
    601622><H3 
     
    666687CLASS="REFSECT2" 
    667688><A 
    668 NAME="AEN615" 
     689NAME="AEN618" 
    669690></A 
    670691><H3 
     
    697718CLASS="REFSECT2" 
    698719><A 
    699 NAME="AEN621" 
     720NAME="AEN624" 
    700721></A 
    701722><H3 
     
    730751CLASS="REFSECT2" 
    731752><A 
    732 NAME="AEN626" 
     753NAME="AEN629" 
    733754></A 
    734755><H3 
     
    769790CLASS="REFSECT2" 
    770791><A 
    771 NAME="AEN631" 
     792NAME="AEN634" 
    772793></A 
    773794><H3 
     
    817838CLASS="INFORMALTABLE" 
    818839><A 
    819 NAME="AEN639" 
     840NAME="AEN642" 
    820841></A 
    821842><P 
     
    9831004CLASS="REFSECT2" 
    9841005><A 
    985 NAME="AEN683" 
     1006NAME="AEN686" 
    9861007></A 
    9871008><H3 
     
    10131034CLASS="REFSECT2" 
    10141035><A 
    1015 NAME="AEN688" 
     1036NAME="AEN691" 
    10161037></A 
    10171038><H3 
     
    10541075CLASS="REFSECT2" 
    10551076><A 
    1056 NAME="AEN693" 
     1077NAME="AEN696" 
    10571078></A 
    10581079><H3 
     
    10911112CLASS="INFORMALTABLE" 
    10921113><A 
    1093 NAME="AEN701" 
     1114NAME="AEN704" 
    10941115></A 
    10951116><P 
     
    11861207CLASS="REFSECT2" 
    11871208><A 
    1188 NAME="AEN724" 
     1209NAME="AEN727" 
    11891210></A 
    11901211><H3 
     
    12281249CLASS="INFORMALTABLE" 
    12291250><A 
    1230 NAME="AEN730" 
     1251NAME="AEN733" 
    12311252></A 
    12321253><P 
     
    12591280>rtp_packet</A 
    12601281> containing the RTP data packet. 
    1261 The callback must free the rtp_packet when it's done with it.</TD 
     1282The callback must free the rtp_packet when it's done with it using the <A 
     1283HREF="uclmmbase-memory.html#XFREE" 
     1284>xfree</A 
     1285>() function.</TD 
    12621286></TR 
    12631287><TR 
     
    14671491CLASS="REFSECT2" 
    14681492><A 
    1469 NAME="AEN789" 
     1493NAME="AEN793" 
    14701494></A 
    14711495><H3 
     
    15101534CLASS="REFSECT2" 
    15111535><A 
    1512 NAME="AEN796" 
     1536NAME="AEN800" 
    15131537></A 
    15141538><H3 
     
    15501574CLASS="INFORMALTABLE" 
    15511575><A 
    1552 NAME="AEN805" 
     1576NAME="AEN809" 
    15531577></A 
    15541578><P 
     
    16091633CLASS="REFSECT2" 
    16101634><A 
    1611 NAME="AEN819" 
     1635NAME="AEN823" 
    16121636></A 
    16131637><H3 
     
    16391663CLASS="INFORMALTABLE" 
    16401664><A 
    1641 NAME="AEN824" 
     1665NAME="AEN828" 
    16421666></A 
    16431667><P 
     
    17131737CLASS="REFSECT2" 
    17141738><A 
    1715 NAME="AEN841" 
     1739NAME="AEN845" 
    17161740></A 
    17171741><H3 
     
    17501774>rtp_callback</A 
    17511775> callback, 
    1752                                              void *userdata);</PRE 
     1776                                             <GTKDOCLINK 
     1777HREF="UINT8-T" 
     1778>uint8_t</GTKDOCLINK 
     1779> *userdata);</PRE 
    17531780></TD 
    17541781></TR 
     
    17611788CLASS="INFORMALTABLE" 
    17621789><A 
    1763 NAME="AEN852" 
     1790NAME="AEN857" 
    17641791></A 
    17651792><P 
     
    19271954CLASS="REFSECT2" 
    19281955><A 
    1929 NAME="AEN891" 
     1956NAME="AEN896" 
    19301957></A 
    19311958><H3 
     
    19651992>rtp_callback</A 
    19661993> callback, 
    1967                                              void *userdata);</PRE 
     1994                                             <GTKDOCLINK 
     1995HREF="UINT8-T" 
     1996>uint8_t</GTKDOCLINK 
     1997> *userdata);</PRE 
    19681998></TD 
    19691999></TR 
     
    19762006CLASS="INFORMALTABLE" 
    19772007><A 
    1978 NAME="AEN902" 
     2008NAME="AEN908" 
    19792009></A 
    19802010><P 
     
    21622192CLASS="REFSECT2" 
    21632193><A 
    2164 NAME="AEN945" 
     2194NAME="AEN951" 
    21652195></A 
    21662196><H3 
     
    21952225CLASS="INFORMALTABLE" 
    21962226><A 
    2197 NAME="AEN952" 
     2227NAME="AEN958" 
    21982228></A 
    21992229><P 
     
    22332263CLASS="REFSECT2" 
    22342264><A 
    2235 NAME="AEN961" 
     2265NAME="AEN967" 
    22362266></A 
    22372267><H3 
     
    22682298CLASS="INFORMALTABLE" 
    22692299><A 
    2270 NAME="AEN969" 
     2300NAME="AEN975" 
    22712301></A 
    22722302><P 
     
    23062336CLASS="REFSECT2" 
    23072337><A 
    2308 NAME="AEN978" 
     2338NAME="AEN984" 
    23092339></A 
    23102340><H3 
     
    23452375CLASS="INFORMALTABLE" 
    23462376><A 
    2347 NAME="AEN987" 
     2377NAME="AEN993" 
    23482378></A 
    23492379><P 
     
    24352465CLASS="REFSECT2" 
    24362466><A 
    2437 NAME="AEN1009" 
     2467NAME="AEN1015" 
    24382468></A 
    24392469><H3 
     
    24742504CLASS="INFORMALTABLE" 
    24752505><A 
    2476 NAME="AEN1018" 
     2506NAME="AEN1024" 
    24772507></A 
    24782508><P 
     
    25642594CLASS="REFSECT2" 
    25652595><A 
    2566 NAME="AEN1040" 
     2596NAME="AEN1046" 
    25672597></A 
    25682598><H3 
     
    26022632CLASS="INFORMALTABLE" 
    26032633><A 
    2604 NAME="AEN1049" 
     2634NAME="AEN1055" 
    26052635></A 
    26062636><P 
     
    26962726CLASS="REFSECT2" 
    26972727><A 
    2698 NAME="AEN1072" 
     2728NAME="AEN1078" 
    26992729></A 
    27002730><H3 
     
    28132843CLASS="INFORMALTABLE" 
    28142844><A 
    2815 NAME="AEN1096" 
     2845NAME="AEN1102" 
    28162846></A 
    28172847><P 
     
    30493079CLASS="REFSECT2" 
    30503080><A 
    3051 NAME="AEN1152" 
     3081NAME="AEN1158" 
    30523082></A 
    30533083><H3 
     
    30923122CLASS="INFORMALTABLE" 
    30933123><A 
    3094 NAME="AEN1161" 
     3124NAME="AEN1167" 
    30953125></A 
    30963126><P 
     
    31673197CLASS="REFSECT2" 
    31683198><A 
    3169 NAME="AEN1179" 
     3199NAME="AEN1185" 
    31703200></A 
    31713201><H3 
     
    32013231CLASS="INFORMALTABLE" 
    32023232><A 
    3203 NAME="AEN1186" 
     3233NAME="AEN1192" 
    32043234></A 
    32053235><P 
     
    32423272CLASS="REFSECT2" 
    32433273><A 
    3244 NAME="AEN1196" 
     3274NAME="AEN1202" 
    32453275></A 
    32463276><H3 
     
    32753305CLASS="INFORMALTABLE" 
    32763306><A 
    3277 NAME="AEN1204" 
     3307NAME="AEN1210" 
    32783308></A 
    32793309><P 
     
    33313361CLASS="REFSECT2" 
    33323362><A 
    3333 NAME="AEN1217" 
     3363NAME="AEN1223" 
    33343364></A 
    33353365><H3 
     
    33713401CLASS="INFORMALTABLE" 
    33723402><A 
    3373 NAME="AEN1226" 
     3403NAME="AEN1232" 
    33743404></A 
    33753405><P 
     
    34443474CLASS="REFSECT2" 
    34453475><A 
    3446 NAME="AEN1244" 
     3476NAME="AEN1250" 
    34473477></A 
    34483478><H3 
     
    34843514CLASS="INFORMALTABLE" 
    34853515><A 
    3486 NAME="AEN1253" 
     3516NAME="AEN1259" 
    34873517></A 
    34883518><P 
     
    35623592CLASS="REFSECT2" 
    35633593><A 
    3564 NAME="AEN1272" 
     3594NAME="AEN1278" 
    35653595></A 
    35663596><H3 
     
    36173647CLASS="INFORMALTABLE" 
    36183648><A 
    3619 NAME="AEN1283" 
     3649NAME="AEN1289" 
    36203650></A 
    36213651><P 
     
    37463776CLASS="REFSECT2" 
    37473777><A 
    3748 NAME="AEN1314" 
     3778NAME="AEN1320" 
    37493779></A 
    37503780><H3 
     
    37963826CLASS="INFORMALTABLE" 
    37973827><A 
    3798 NAME="AEN1325" 
     3828NAME="AEN1331" 
    37993829></A 
    38003830><P 
     
    38873917CLASS="REFSECT2" 
    38883918><A 
    3889 NAME="AEN1347" 
     3919NAME="AEN1353" 
    38903920></A 
    38913921><H3 
     
    39293959CLASS="INFORMALTABLE" 
    39303960><A 
    3931 NAME="AEN1357" 
     3961NAME="AEN1363" 
    39323962></A 
    39333963><P 
     
    40034033CLASS="REFSECT2" 
    40044034><A 
    4005 NAME="AEN1375" 
     4035NAME="AEN1381" 
    40064036></A 
    40074037><H3 
     
    40554085CLASS="INFORMALTABLE" 
    40564086><A 
    4057 NAME="AEN1387" 
     4087NAME="AEN1393" 
    40584088></A 
    40594089><P 
     
    41464176CLASS="REFSECT2" 
    41474177><A 
    4148 NAME="AEN1409" 
     4178NAME="AEN1415" 
    41494179></A 
    41504180><H3 
     
    41924222CLASS="INFORMALTABLE" 
    41934223><A 
    4194 NAME="AEN1421" 
     4224NAME="AEN1427" 
    41954225></A 
    41964226><P 
     
    42624292CLASS="REFSECT2" 
    42634293><A 
    4264 NAME="AEN1438" 
     4294NAME="AEN1444" 
    42654295></A 
    42664296><H3 
     
    43004330CLASS="INFORMALTABLE" 
    43014331><A 
    4302 NAME="AEN1446" 
     4332NAME="AEN1452" 
    43034333></A 
    43044334><P 
     
    43704400CLASS="REFSECT2" 
    43714401><A 
    4372 NAME="AEN1463" 
     4402NAME="AEN1469" 
    43734403></A 
    43744404><H3 
     
    44004430CLASS="INFORMALTABLE" 
    44014431><A 
    4402 NAME="AEN1470" 
     4432NAME="AEN1476" 
    44034433></A 
    44044434><P 
     
    44604490CLASS="REFSECT2" 
    44614491><A 
    4462 NAME="AEN1485" 
     4492NAME="AEN1491" 
    44634493></A 
    44644494><H3 
     
    44934523CLASS="INFORMALTABLE" 
    44944524><A 
    4495 NAME="AEN1493" 
     4525NAME="AEN1499" 
    44964526></A 
    44974527><P 
     
    45534583CLASS="REFSECT2" 
    45544584><A 
    4555 NAME="AEN1508" 
     4585NAME="AEN1514" 
    45564586></A 
    45574587><H3 
     
    45864616CLASS="INFORMALTABLE" 
    45874617><A 
    4588 NAME="AEN1516" 
     4618NAME="AEN1522" 
    45894619></A 
    45904620><P 
     
    46464676CLASS="REFSECT2" 
    46474677><A 
    4648 NAME="AEN1531" 
     4678NAME="AEN1537" 
    46494679></A 
    46504680><H3 
     
    46764706CLASS="INFORMALTABLE" 
    46774707><A 
    4678 NAME="AEN1538" 
     4708NAME="AEN1544" 
    46794709></A 
    46804710><P 
     
    47364766CLASS="REFSECT2" 
    47374767><A 
    4738 NAME="AEN1553" 
     4768NAME="AEN1559" 
    47394769></A 
    47404770><H3 
     
    47524782><PRE 
    47534783CLASS="PROGRAMLISTING" 
    4754 >void*       rtp_get_userdata                (struct <GTKDOCLINK 
     4784><GTKDOCLINK 
     4785HREF="UINT8-T" 
     4786>uint8_t</GTKDOCLINK 
     4787>*    rtp_get_userdata                (struct <GTKDOCLINK 
    47554788HREF="RTP" 
    47564789>rtp</GTKDOCLINK 
     
    47674800HREF="uclmmbase-rtp.html#RTP-INIT-IF" 
    47684801>rtp_init_if</A 
    4769 >() function when creating this session. 
    4770 XXX (Note that gtkdoc thinks that it returns void, not void*, so 
    4771 ignores the "Returns:" block here)</P 
     4802>() function when creating this session.</P 
    47724803><P 
    47734804></P 
     
    47754806CLASS="INFORMALTABLE" 
    47764807><A 
    4777 NAME="AEN1562" 
     4808NAME="AEN1569" 
    47784809></A 
    47794810><P 
     
    48044835> The RTP session.</TD 
    48054836></TR 
     4837><TR 
     4838><TD 
     4839WIDTH="20%" 
     4840ALIGN="RIGHT" 
     4841VALIGN="TOP" 
     4842><I 
     4843CLASS="EMPHASIS" 
     4844>Returns</I 
     4845> :</TD 
     4846><TD 
     4847WIDTH="80%" 
     4848ALIGN="LEFT" 
     4849VALIGN="TOP" 
     4850> pointer to userdata.</TD 
     4851></TR 
    48064852></TBODY 
    48074853></TABLE 
     
    48144860CLASS="REFSECT1" 
    48154861><A 
    4816 NAME="AEN1571" 
     4862NAME="AEN1582" 
    48174863></A 
    48184864><H2 
     
    49154961BGCOLOR="#C00000" 
    49164962ALIGN="right" 
    4917 >&nbsp;</TD 
     4963><A 
     4964HREF="uclmmbase-debug.html" 
     4965><FONT 
     4966COLOR="#FFFFFF" 
     4967SIZE="3" 
     4968><B 
     4969>Next Page &#62;&#62;&#62;</B 
     4970></FONT 
     4971></A 
     4972></TD 
    49184973></TR 
    49194974><TR 
     
    49314986COLSPAN="2" 
    49324987ALIGN="right" 
    4933 >&nbsp;</TD 
     4988><FONT 
     4989COLOR="#FFFFFF" 
     4990SIZE="3" 
     4991><B 
     4992>Debug</B 
     4993></FONT 
     4994></TD 
    49344995></TR 
    49354996></TABLE 
  • common/trunk/doc/html/uclmmbase.html

    r546 r556  
    137137>RTP</A 
    138138> &#8212; Real-Time Transport Protocol (RTP) Implementation.</DT 
     139><DT 
     140><A 
     141HREF="uclmmbase-debug.html" 
     142>Debug</A 
     143> &#8212; Functions for outputing diagnostics.</DT 
     144><DT 
     145><A 
     146HREF="uclmmbase-memory.html" 
     147>Memory</A 
     148> &#8212; Memory allocation and debugging functions.</DT 
    139149></DL 
    140150></DIV 
    141151><P 
    142152> The UCL Common Multimedia Library provides a number of useful 
    143 features for multimedia applications.  The most notable feature of the 
    144 library is the RTP implementation.</P 
     153features for multimedia applications.  It includes several protocols 
     154and functions related to IETF multimedia applications.</P 
    145155></DIV 
    146156><DIV 
  • common/trunk/doc/tmpl/debug.sgml

    r543 r556  
    11<!-- ##### SECTION Title ##### --> 
    2 debug 
     2Debug 
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    55 
     6Functions for outputing diagnostics. 
    67 
    78<!-- ##### SECTION Long_Description ##### --> 
    89<para> 
     10 
     11These functions relate to outputing diagnostic messages and 
     12information. 
     13 
     14</para> 
     15 
     16<para> 
     17 
     18Use of these functions requires DEBUG to be defined at compilation 
     19time.  On Unix systems, the <filename>configure</filename> script has 
     20a command-line option <option>--enable-debug</option>.  On Win32 a 
     21debug configuration exists. 
    922 
    1023</para> 
     
    1831<para> 
    1932 
     33Available for use to prevent compiler warnings when a function 
     34argument is not used.  Sometimes this is unavoidable because function 
     35has to conform to an interface. 
     36 
    2037</para> 
    2138 
    22 @x:  
     39@x: unused function argument that generates compiler warning. 
    2340 
    2441 
    2542<!-- ##### MACRO debug_msg ##### --> 
    2643<para> 
     44 
     45When DEBUG is defined this will write a formatted message to the 
     46platform defined error stream.  The format of the message has the same 
     47semantics as standard C library call <function>printf()</function>.  The error 
     48message displayed is prepended by the process id, the file and the 
     49line number, where debug_msg() was called. 
     50 
     51On Unix the message is rendered on the standard error stream.  On 
     52Win32 a debug message is created using the Win32 API function 
     53<function>OutputDebugString()</function>. 
    2754 
    2855</para> 
  • common/trunk/doc/tmpl/memory.sgml

    r543 r556  
    11<!-- ##### SECTION Title ##### --> 
    2 memory 
     2Memory 
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    55 
     6Memory allocation and debugging functions. 
    67 
    78<!-- ##### SECTION Long_Description ##### --> 
    89<para> 
     10 
     11This set of functions is semantically similar functions to standard C 
     12library memory allocation routines.  When memory debugging is enabled 
     13these functions include support to detect buffer overruns.  When 
     14memory debugging is not enabled the allocation and free calls are 
     15wrappers around the standard C allocation routines, and checking 
     16routines are null ops. 
     17 
     18</para> 
     19 
     20<para> 
     21Memory debugging is enabled when DEBUG_MEM is defined at compilation 
     22time.  On Unix systems, the <filename>configure</filename> script has 
     23a command-line option <option>--enable-debug-mem</option>.  On Win32, 
     24a memory debugging is enabled in the debug configuration. 
    925 
    1026</para> 
     
    1531</para> 
    1632 
     33<!-- ##### MACRO xmalloc ##### --> 
     34<para> 
     35Allocates a block of memory.  Semantically equivalent to malloc(). 
     36</para> 
     37 
     38@x: size of allocation. 
     39 
     40 
    1741<!-- ##### MACRO xrealloc ##### --> 
    1842<para> 
    19  
     43Re-sizes a block of memory. Semantically equivalent to realloc(). 
    2044</para> 
    2145 
    22 @p:  
    23 @x:  
    24  
    25  
    26 <!-- ##### MACRO xmalloc ##### --> 
    27 <para> 
    28  
    29 </para> 
    30  
    31 @x:  
     46@p: Pointer to block to be re-dimensioned. 
     47@x: New size. 
    3248 
    3349 
    3450<!-- ##### MACRO xstrdup ##### --> 
    3551<para> 
    36  
     52xmalloc()'s sufficient memory to store @str, copies @str into it, and 
     53returns pointer to new string.  Semantically equivalent to strdup(). 
    3754</para> 
    3855 
    39 @x:  
     56@str:  
     57<!-- # Unused Parameters # --> 
     58@x: String to duplicate. 
    4059 
    4160 
     
    6685</para> 
    6786 
    68 @p:  
     87@addr:  
    6988@filen:  
    7089@line:  
     90<!-- # Unused Parameters # --> 
     91@p:  
    7192 
    7293 
     
    84105</para> 
    85106 
     107@p:  
     108<!-- # Unused Parameters # --> 
    86109@x:  
    87110 
  • common/trunk/doc/tmpl/rtp.sgml

    r551 r556  
    131131The ssrc field contains the RTP data packet's SSRC. 
    132132The data field points to a #rtp_packet containing the RTP data packet. 
    133 The callback must free the rtp_packet when it's done with it. 
     133The callback must free the rtp_packet when it's done with it using the xfree() function. 
    134134@RX_SR: An RTCP SR packet was received. 
    135135The ssrc field contains the SR packet's SSRC. 
     
    456456 
    457457@session:  
    458  
    459  
     458@Returns:  
     459 
     460 
  • common/trunk/doc/tmpl/uclconf.sgml

    r543 r556  
    9292 
    9393 
     94<!-- ##### MACRO DEBUG ##### --> 
     95<para> 
     96 
     97</para> 
     98 
     99 
     100 
     101<!-- ##### MACRO DEBUG_MEM ##### --> 
     102<para> 
     103 
     104</para> 
     105 
     106 
     107 
  • common/trunk/doc/tmpl/uclmmbase-unused.sgml

    r551 r556  
    3030 
    3131<!-- ##### SECTION ./tmpl/test_mbus_addr.sgml:Long_Description ##### --> 
    32 <para> 
    33  
    34 </para> 
    35  
    36  
    37 <!-- ##### MACRO DEBUG ##### --> 
    3832<para> 
    3933 
     
    6357<!-- ##### SECTION ./tmpl/test_net_udp.sgml:Short_Description ##### --> 
    6458 
    65  
    66  
    67 <!-- ##### MACRO DEBUG_MEM ##### --> 
    68 <para> 
    69  
    70 </para> 
    7159 
    7260 
  • common/trunk/doc/uclmmbase-driver.sgml

    r546 r556  
    44<!entity netudp SYSTEM "sgml/net_udp.sgml"> 
    55<!entity rtp SYSTEM "sgml/rtp.sgml"> 
     6<!entity debug SYSTEM "sgml/debug.sgml"> 
     7<!entity memory SYSTEM "sgml/memory.sgml"> 
    68]> 
    79 
     
    1517 
    1618<para> The UCL Common Multimedia Library provides a number of useful 
    17 features for multimedia applications.  The most notable feature of the 
    18 library is the RTP implementation.</para> 
     19features for multimedia applications.  It includes several protocols 
     20and functions related to IETF multimedia applications.</para> 
    1921 
    2022    &hmac; 
     
    2325    &rtp;  
    2426 
     27    &debug; 
     28    &memory; 
     29 
    2530</chapter> 
    2631 
  • common/trunk/doc/uclmmbase-sections.txt

    r551 r556  
    171171<SECTION> 
    172172<FILE>debug</FILE> 
     173<INCLUDE>debug.h</INCLUDE> 
    173174UNUSED 
    174175debug_msg 
     
    274275<SECTION> 
    275276<FILE>memory</FILE> 
     277<INCLUDE>memory.h</INCLUDE> 
     278xmalloc 
    276279xrealloc 
    277 xmalloc 
    278280xstrdup 
    279281xdoneinit 
     
    418420HAVE_SYS_FILIO_H 
    419421WORDS_SMALLENDIAN 
    420 </SECTION> 
    421  
     422DEBUG 
     423DEBUG_MEM 
     424</SECTION> 
     425 
  • common/trunk/src/debug.c

    r435 r556  
    6969} 
    7070 
     71/** 
     72 * debug_dump: 
     73 * @lp: pointer to memory region. 
     74 * @len: length of memory region in bytes. 
     75 *  
     76 * Writes a dump of a memory region to stdout.  The dump contains a 
     77 * hexadecimal and an ascii representation of the memory region. 
     78 *  
     79 **/ 
    7180void debug_dump(void*lp, long len) 
    7281{ 
     
    138147} 
    139148 
     149/** 
     150 * debug_set_core_dir: 
     151 * @argv0: the application path (usually argv[0] in main()). 
     152 *  
     153 * Creates a directory with the application name and makes it the 
     154 * current working directory.   
     155 *  
     156 * This function exists because some unix variants use the name 'core' 
     157 * for core dump files.  When an application uses multiple processes, 
     158 * this can be problematic if the failure of one process leads to the 
     159 * failure of another because the dependent process 'core' file will 
     160 * overwrite the core of the failing process. 
     161 **/ 
    140162void debug_set_core_dir(const char *argv0) 
    141163{ 
  • common/trunk/src/memory.c

    r545 r556  
    7777static int   naddr = 0; /* number of allocations */ 
    7878static int   tick  = 1; /* xmemchk assumes this is one, do not change without checking why */ 
     79 
    7980static int   init  = 0; 
     81 
     82/** 
     83 * xdoneinit: 
     84 * @void:  
     85 *  
     86 * Marks end of an applications initialization period.  For media 
     87 * applications with real-time data transfer it's sometimes helpful to 
     88 * distinguish between memory allocated during application 
     89 * initialization and when application is running. 
     90 **/ 
    8091 
    8192void xdoneinit(void)  
     
    130141} 
    131142 
     143/** 
     144 * xmemchk: 
     145 * @void:  
     146 *  
     147 * Check for bounds overruns in all memory allocated with xmalloc(), 
     148 * xrealloc(), and xstrdup().  Information on corrupted blocks is 
     149 * rendered on the standard error stream.  This includes where the 
     150 * block was allocated, the size of the block, and the number of 
     151 * allocations made since the block was created. 
     152 **/ 
    132153void xmemchk(void) 
    133154{ 
     
    228249} 
    229250 
     251/** 
     252 * xmemdmp: 
     253 * @void:  
     254 *  
     255 * Dumps the address, size, age, and point of allocation in code. 
     256 * 
     257 **/ 
    230258void  
    231259xmemdmp(void) 
     
    260288/* Because block_alloc recycles blocks we need to know which code 
    261289 * fragment takes over responsibility for the memory.  */ 
     290 
     291/** 
     292 * xclaim: 
     293 * @addr: address 
     294 * @filen: new filename 
     295 * @line: new allocation line 
     296 *  
     297 * Coerces information in allocation table about allocation file and 
     298 * line to be @filen and @line.  This is used by the evil 
     299 * block_alloc() and should probably not be used anywhere else ever. 
     300 **/ 
    262301void  
    263302xclaim(void *addr, const char *filen, int line) 
     
    286325} 
    287326 
     327/** 
     328 * xmemdist: 
     329 * @fp: file pointer 
     330 *  
     331 * Dumps information on existing memory allocations to file. 
     332 **/ 
    288333void  
    289334xmemdist(FILE *fp) 
     
    317362} 
    318363 
     364/** 
     365 * xfree: 
     366 * @p: pointer to block to freed. 
     367 *  
     368 * Free block of memory.  Semantically equivalent to free(), but 
     369 * checks for bounds overruns in @p and tidies up state associated 
     370 * additional functionality. 
     371 * 
     372 * Must be used to free memory allocated with xmalloc(), xrealloc(), 
     373 * and xstrdup(). 
     374 **/ 
    319375void  
    320376xfree(void *p) 
     
    492548void xmemdist (FILE *f) { UNUSED(f); } 
    493549 
    494 /** 
    495  * xfree: 
    496  * @x: pointer to memory block to be freed. 
    497  * 
    498  * This function is conceptually the same as the standard C library 
    499  * free() function call, but contains some extra debugging 
    500  * functionality when DEBUG_MEM is defined. 
    501  *   
    502  */ 
    503  
    504550void xfree    (void *x) { free(x); } 
    505551 
  • common/trunk/src/memory.h

    r360 r556  
    4141#define _RAT_MEMORY_H 
    4242 
     43#define xmalloc(x)      _xmalloc(x,__FILE__,__LINE__) 
    4344#define xrealloc(p,x)   _xrealloc(p, x,__FILE__,__LINE__) 
    44 #define xmalloc(x)      _xmalloc(x,__FILE__,__LINE__) 
    45 #define xstrdup(x)      _xstrdup(x,__FILE__,__LINE__) 
     45#define xstrdup(str)    _xstrdup(str,__FILE__,__LINE__) 
    4646 
    4747#if defined(__cplusplus) 
     
    5353void     xmemchk(void); 
    5454void     xmemdmp(void); 
    55 void     xclaim(void *p, const char *filen, int line); 
     55void     xclaim(void *addr, const char *filen, int line); 
    5656void     xmemdist(FILE *fp); 
    5757 
    5858/* Replacements for regular memory fn's */ 
    59 void     xfree(void *x); 
     59void     xfree(void *p); 
    6060void    *_xmalloc(unsigned size,const char *filen,int line); 
    6161void    *_xrealloc(void *p,unsigned size,const char *filen,int line); 
  • common/trunk/src/rtp.c

    r554 r556  
    203203        rtcp_rr_wrapper  rr[RTP_DB_SIZE][RTP_DB_SIZE];  /* Indexed by [hash(reporter)][hash(reportee)] */ 
    204204        options         *opt; 
    205         void            *userdata; 
     205        uint8_t         *userdata; 
    206206        int              invalid_rtp_count; 
    207207        int              invalid_rtcp_count; 
     
    919919                     int ttl, double rtcp_bw,  
    920920                     rtp_callback callback, 
    921                      void *userdata) 
     921                     uint8_t *userdata) 
    922922{ 
    923923        return rtp_init_if(addr, NULL, rx_port, tx_port, ttl, rtcp_bw, callback, userdata); 
     
    951951                        int ttl, double rtcp_bw,  
    952952                        rtp_callback callback, 
    953                         void *userdata) 
     953                        uint8_t *userdata) 
    954954{ 
    955955        struct rtp      *session; 
     
    11421142 * This function returns the userdata pointer that was passed to the 
    11431143 * rtp_init() or rtp_init_if() function when creating this session. 
    1144  * XXX (Note that gtkdoc thinks that it returns void, not void*, so 
    1145  * ignores the "Returns:" block here) 
    1146  * Returns: The userdata pointer that was passed to the rtp_init() or 
    1147  * rtp_init_if() function when creating this session. 
     1144 * 
     1145 * Returns: pointer to userdata. 
    11481146 */ 
    1149 void *rtp_get_userdata(struct rtp *session) 
     1147uint8_t *rtp_get_userdata(struct rtp *session) 
    11501148{ 
    11511149        check_database(session); 
  • common/trunk/src/rtp.h

    r551 r556  
    187187 
    188188rtp_t           rtp_init(const char *addr,  
    189                           uint16_t rx_port, uint16_t tx_port,  
    190                           int ttl, double rtcp_bw,  
    191                           rtp_callback callback, 
    192                           void *userdata); 
     189                         uint16_t rx_port, uint16_t tx_port,  
     190                         int ttl, double rtcp_bw,  
     191                         rtp_callback callback, 
     192                         uint8_t *userdata); 
    193193rtp_t           rtp_init_if(const char *addr, char *iface,  
    194                              uint16_t rx_port, uint16_t tx_port,  
    195                              int ttl, double rtcp_bw,  
    196                              rtp_callback callback, 
    197                              void *userdata); 
     194                            uint16_t rx_port, uint16_t tx_port,  
     195                            int ttl, double rtcp_bw,  
     196                            rtp_callback callback, 
     197                            uint8_t *userdata); 
    198198 
    199199void             rtp_send_bye(struct rtp *session); 
     
    232232uint16_t         rtp_get_tx_port(struct rtp *session); 
    233233int              rtp_get_ttl(struct rtp *session); 
    234 void            *rtp_get_userdata(struct rtp *session); 
     234uint8_t         *rtp_get_userdata(struct rtp *session); 
    235235 
    236236#endif /* __RTP_H__ */