Session Initiation Protocol Library Functions
                                        sipenablecounters(3SIP)



NAME
     sipenablecounters,                   sipdisablecounters,
     sipgetcountervalue - counter operations

SYNOPSIS
     cc [ flag... ] file... -lsip [ library... ]
     #include 

     int sipenablecounters(int countergroup);


     int sipdisablecounters(int countergroup);


     int sipgetcountervalue(int group, int counter, void *counterval,
          sizet counterlen);


DESCRIPTION
     The sipenablecounters() function enables  the  measurement
     and counting of the selected counter group. The only allowed
     value for the countergroup is  SIPTRAFICOUNTERS,  which
     is  defined  in  . Once enabled, the SIP stack starts
     measuring end-to-end SIP traffic. The SIP stack keeps  track
     of:

         o    the number of SIP requests sent and received  (bro-
              ken down by methods),

         o    the number of SIP responses sent and received (bro-
              ken down by response codes), and

         o    the number of bytes sent and received.


     The following  counters  are  defined  in    for  the
     SIPTRAFICOUNTERS   group.   These   counter  values  are
     retrieved using the sipgetcountervalue() function.

       SIPTOTALBYTESRCVD
       SIPTOTALBYTESENT
       SIPTOTALREQRCVD
       SIPTOTALREQSENT
       SIPTOTALRESPRCVD
       SIPTOTALRESPSENT
       SIPACKREQRCVD
       SIPACKREQSENT
       SIPBYEREQRCVD
       SIPBYEREQSENT
       SIPCANCELREQRCVD
       SIPCANCELREQSENT



SunOS 5.11          Last change: 11 Jan 2008                    1






Session Initiation Protocol Library Functions
                                        sipenablecounters(3SIP)



       SIPINFOREQRCVD
       SIPINFOREQSENT
       SIPINVITEREQRCVD
       SIPINVITEREQSENT
       SIPNOTIFYREQRCVD
       SIPNOTIFYREQSENT
       SIPOPTIONSREQRCVD
       SIPOPTIONSREQSENT
       SIPRACKREQRCVD
       SIPRACKREQSENT
       SIPREFEREQRCVD
       SIPREFEREQSENT
       SIPREGISTEREQRCVD
       SIPREGISTEREQSENT
       SIPSUBSCRIBEREQRCVD
       SIPSUBSCRIBEREQSENT
       SIPUPDATEREQRCVD
       SIPUPDATEREQSENT
       SIP1XRESPRCVD
       SIP1XRESPSENT
       SIP2XRESPRCVD
       SIP2XRESPSENT
       SIP3XRESPRCVD
       SIP3XRESPSENT
       SIP4XRESPRCVD
       SIP4XRESPSENT
       SIP5XRESPRCVD
       SIP5XRESPSENT
       SIP6XRESPRCVD
       SIP6xxRESPSENT
       SIPCOUNTERSTARTIME  /* records time when counting was enabled */
       SIPCOUNTERSTOPTIME   /* records time when counting was disabled */



     All of the above counters are defined to be uint64t, except
     for  SIPCOUNTERSTARTIME and SIPCOUNTERSTOPTIME, which
     are defined to be timet.


     The sipdisablecounters() function disables measurement and
     counting for the specified countergroup. When disabled, the
     counter values are not reset  and  are  retained  until  the
     measurement  is enabled again. Calling sipenablecounters()
     again would reset all counter values to  zero  and  counting
     would start afresh.


     The sipgetcountervalue() function retrieves the value  of
     the  specified  counter  within the specified counter group.
     The value is copied to the user provided buffer, counterval,



SunOS 5.11          Last change: 11 Jan 2008                    2






Session Initiation Protocol Library Functions
                                        sipenablecounters(3SIP)



     of length counterlen. For example, after the following call,
     invitercvd would have the correct value.

       uint64t invitercvd;

       sipgetcountervalue(SIPTRAFICOUNTERS, SIPINVITEREQRCVD,
               &invitercvd, sizeof (uint64t));


RETURN VALUES
     Upon  successful   completion,   sipenablecounters()   and
     sipdisablecounters()  return 0. They will return EINVAL if
     an incorrect group is specified.


     Upon successful completion, sipgetcountervalue()  returns
     0.  It   returns  EINVAL  if  an  incorrect  counter name or
     counter size is specified, or if counterval is NUL.

ATRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:



     
           ATRIBUTE TYPE               ATRIBUTE VALUE       
    
     Interface Stability          Committed                   
    
     MT-Level                     MT-Safe                     
    


SEE ALSO
     attributes(5)


















SunOS 5.11          Last change: 11 Jan 2008                    3






Session Initiation Protocol Library Functions
                                        sipenablecounters(3SIP)






















































SunOS 5.11          Last change: 11 Jan 2008                    4