Session Initiation Protocol Library Functions
                                       sipgetdialogstate(3SIP)



NAME
     sipgetdialogstate,                 sipgetdialogcallid,
     sipgetdialoglocaltag,         sipgetdialogremotetag,
     sipgetdialoglocaluri,         sipgetdialogremoteuri,
     sipgetdialoglocalcontacturi,
     sipgetdialogremotetargeturi,  sipgetdialogrouteset,
     sipgetdialoglocalcseq,       sipgetdialogremotecseq,
     sipgetdialogtype,                  sipgetdialogmethod,
     sipisdialogsecure,  sipgetdialogmsgcnt  -  get  dialog
     attributes

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

     int sipgetdialogstate(sipdialogt dialog, int *error);


     const sipstrt *sipgetdialogcallid(sipdialogt dialog,
          int *error);


     const sipstrt *sipgetdialoglocaltag(sipdialogt dialog,
          int *error);


     const sipstrt *sipgetdialogremotetag(sipdialogt dialog,
          int *error);


     const struct sipuri *sipgetdialoglocaluri(sipdialogt dialog,
          int *error);


     const struct sipuri *sipgetdialogremoteuri(sipdialogt dialog,
          int *error);


     const struct sipuri *sipgetdialoglocalcontacturi(
          sipdialogt dialog, int *error);


     const struct sipuri *sipgetdialogremotetargeturi(
          sipdialogt dialog, int *error);


     const sipstrt *sipgetdialogrouteset(sipdialogt dialog,
          int *error);






SunOS 5.11          Last change: 11 Jan 2008                    1






Session Initiation Protocol Library Functions
                                       sipgetdialogstate(3SIP)



     booleant sipisdialogsecure(sipdialogt dialog,
          int *error);


     uint32t sipgetdialoglocalcseq(sipdialogt dialog,
          int *error);


     uint32t sipgetdialogremotecseq(sipdialogt dialog,
          int *error);


     int sipgetdialogtype(sipdialogt dialog,int *error);


     int sipgetdialogmethod(sipdialogt dialog,int *error);


     int sipgetdialogmsgcnt(sipdialogt dialog,int *error);


DESCRIPTION
     For functions that  return  a  pointer  of  type  sipstrt,
     sipstrt is supplied by:

       typedef struct sipstr {
            char *sipstrptr;
            int  sipstrlen;
       }sipstrt;



     The  sipstrptr  parameter  points  to  the  start  of  the
     returned  value  and  sipstrlen supplies the length of the
     returned value.


     The sipgetdialogstate() returns the state of the  dialog.
     A dialog can be in one of the following states:
       SIPDLGNEW
       SIPDLGEARLY
       SIPDLGCONFIRMED
       SIPDLGDESTROYED


     The sipgetdialogcallid() function  returns  the  call  ID
     value maintained in the dialog.


     The              sipgetdialoglocaltag()              and
     sipgetdialogremotetag()  functions  return the local and



SunOS 5.11          Last change: 11 Jan 2008                    2






Session Initiation Protocol Library Functions
                                       sipgetdialogstate(3SIP)



     remote tag values, maintained in the dialog.


     The sipgetdialoglocaluri(), sipgetdialogremoteuri(),
     sipgetdialoglocalcontacturi(),                      and
     sipgetdialogremotetargeturi()  functions   return   the
     local,  remote,  local contract, and the remote target URIs,
     maintained in the dialog.


     The sipgetdialogrouteset() function  returns  the  route
     set, if any, maintained in the dialog.


     The             sipgetdialoglocalcseq()              and
     sipgetdialogremotecseq()  functions return the local and
     remote CSEQ numbers maintained in the dialog.


     The sipgetdialogtype() function returns one of  the  fol-
     lowing  dialog  types, depending on whether it is created by
     the client or the server.

     SIPUACDIALOG    created by client


     SIPUASDIALOG    created by server



     The sipgetdialogmethod() function returns the SIP method,
     INVITE or SUBSCRIBE, of the request that created the dialog.


     The sipisdialogsecure() function returns  BTRUE  if  the
     dialog is secure and BFALSE otherwise.


     The sipgetdialogmsgcnt() function returns the  number  of
     SIP  messages  (requests  and  responses) that were sent and
     received within the context of the given dialog.

RETURN VALUES
     The   sipgetdialogstate(),   sipgetdialoglocalcseq(),
     sipgetdialogremotecseq(),         sipgetdialogtype(),
     sipgetdialogmethod(), and  sipgetdialogmsgcnt()  func-
     tions  return  the  required  value  on  success  and  -1 on
     failure.






SunOS 5.11          Last change: 11 Jan 2008                    3






Session Initiation Protocol Library Functions
                                       sipgetdialogstate(3SIP)



     The   sipgetdialogcallid(),   sipgetdialoglocaltag(),
     sipgetdialogremotetag(),     sipgetdialoglocaluri(),
     sipgetdialogremoteuri(),
     sipgetdialoglocalcontacturi(),
     sipgetdialogremotetargeturi(),                      and
     sipgetdialogrouteset()  functions  return  the  required
     value on success and NUL on failure.


     The value of errno is not changed  by  these  calls  in  the
     event of an error.

ERORS
     These functions take an error argument.


     If the error is non-null, one of  the  following  values  is
     set:

     EINVAL

         The dialog is NUL or the stack  is  not  configured  to
         manage dialogs.


     ENOTSUP

         The input SIP message cannot be modified.


     ENOMEM

         The memory allocation fails  when  the  request/response
         line or the headers in the ACK request are created.



     On success, the value of the location pointed to by error is
     set to 0.

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











SunOS 5.11          Last change: 11 Jan 2008                    4






Session Initiation Protocol Library Functions
                                       sipgetdialogstate(3SIP)




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


SEE ALSO
     libsip(3LIB)











































SunOS 5.11          Last change: 11 Jan 2008                    5






Session Initiation Protocol Library Functions
                                       sipgetdialogstate(3SIP)






















































SunOS 5.11          Last change: 11 Jan 2008                    6