Session Initiation Protocol Library Functions
                                       sipgettransmethod(3SIP)



NAME
     sipgettransmethod,                   sipgettransstate,
     sipgettransorigmsg,              sipgettransconnobj,
     sipgettransrespmsg, sipgettransbranchid -  get  tran-
     saction attributes

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

     sipmethodt sipgettransmethod(siptransactiont siptrans,
          int *error);


     int sipgettransstate(siptransactiont trans, int *error);


     const struct sipmessage *sipgettransorigmsg
          (siptransactiont siptrans, int *error);


     const struct sipmessage *sipgettransrespmsg
          (siptransactiont siptrans, int *error);


     const struct sipconnobject *sipgettransconnobj
          (siptransactiont siptrans, int *error);


     char *sipgettransbranchid(siptransactiont trans, int *error);


DESCRIPTION
     The sipgettransmethod() function returns the  method  the
     SIP message that created the transaction siptrans.


     The sipgettransstate() function returns the state of  the
     transaction siptrans.


     A newly created transaction is in the state:
       SIPNEWTRANSACTION


     A client transaction  could  be  in  one  of  the  following
     states:
       SIPCLNTCALING
       SIPCLNTINVPROCEDING
       SIPCLNTINVTERMINATED
       SIPCLNTINVCOMPLETED



SunOS 5.11          Last change: 10 Feb 2007                    1






Session Initiation Protocol Library Functions
                                       sipgettransmethod(3SIP)



       SIPCLNTRYING
       SIPCLNTNONINVPROCEDING
       SIPCLNTNONINVTERMINATED
       SIPCLNTNONINVCOMPLETED


     A server transaction  could  be  in  one  of  the  following
     states:
       SIPSRVINVPROCEDING
       SIPSRVINVCOMPLETED
       SIPSRVCONFIRMED
       SIPSRVINVTERMINATED
       SIPSRVTRYING
       SIPSRVNONINVPROCEDING
       SIPSRVNONINVCOMPLETED
       SIPSRVNONINVTERMINATED


     The sipgettransorigmsg() function  returns  the  message
     that  created  the  transaction  siptrans.  This could be a
     request on the client or a response on the server.


     The  sipgettransrespmsg()  function  returns  the   last
     response  that  was sent on the transaction siptrans. Typi-
     cally, this response is used by the  transaction  layer  for
     retransmissions  for unreliable transports or for responding
     to retransmitted requests.  A  response  that  terminates  a
     transaction is not returned.


     The sipgettransconnobj()  function  returns  the  cached
     connection object, if any, in the transactionsiptrans.


     The sipgettransbranchid() function returns the branch  ID
     for  the  message that created the transactionsiptrans. The
     caller is responsible for freeing the returned string.

RETURN VALUES
     The   sipgettransorigmsg(),    sipgettransrespmsg(),
     sipgettransconnobj(), and sipgettransbranchid() func-
     tions return the  required  value  on  success  or  NUL  on
     failure.


     The sipgettransstate() and  sipgettransmethod()  func-
     tions  return  the  required  value  on  success  and  -1 on
     failure.





SunOS 5.11          Last change: 10 Feb 2007                    2






Session Initiation Protocol Library Functions
                                       sipgettransmethod(3SIP)



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

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

     EINVAL    The input transaction siptrans is NUL.


     ENOMEM    For sipgettransbranchid() there  is  an   error
               allocating memory for the branch ID string.



     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:



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


SEE ALSO
     libsip(3LIB)



















SunOS 5.11          Last change: 10 Feb 2007                    3






Session Initiation Protocol Library Functions
                                       sipgettransmethod(3SIP)






















































SunOS 5.11          Last change: 10 Feb 2007                    4