reSIProcate
SIP stack, Dialog Usage Manager and related libraries
Loading...
Searching...
No Matches
resip::UserAuthInfo Class Reference

#include <UserAuthInfo.hxx>

Inheritance diagram for resip::UserAuthInfo:
[legend]

Public Types

enum  InfoMode {
  UserUnknown , RetrievedA1 , Stale , DigestAccepted ,
  DigestNotAccepted , Error
}
 

Public Member Functions

 UserAuthInfo (const resip::Data &user, const resip::Data &realm, InfoMode mode, const resip::Data &transactionId)
 
 UserAuthInfo (const resip::Data &user, const resip::Data &realm, const resip::Data &a1, const resip::Data &transactionId)
 
 UserAuthInfo (const resip::Data &user, const resip::Data &realm, const resip::Data &transactionId, resip::TransactionUser *transactionUser)
 
 ~UserAuthInfo ()
 
InfoMode getMode () const
 
const resip::Data & getA1 () const
 
const resip::Data & getRealm () const
 
const resip::Data & getUser () const
 
const void getErrorInfo (int32_t &errorCode, resip::Data &errorStatusText) const
 
void setMode (InfoMode mode, int32_t errorCode=0, const resip::Data &statusText=resip::Data::Empty)
 
void setA1 (const resip::Data &a1)
 
virtual resip::Message * clone () const
 
virtual EncodeStream & encode (EncodeStream &strm) const
 output the entire message to stream
 
virtual EncodeStream & encodeBrief (EncodeStream &strm) const
 output a brief description to stream
 
- Public Member Functions inherited from resip::DumFeatureMessage
 DumFeatureMessage (const Data &tid)
 
 DumFeatureMessage (const DumFeatureMessage &)
 
 ~DumFeatureMessage ()
 
virtual const Data & getTransactionId () const
 
- Public Member Functions inherited from resip::ApplicationMessage
 ApplicationMessage ()
 
virtual ~ApplicationMessage ()
 
- Public Member Functions inherited from resip::Message
 Message ()
 
virtual ~Message ()
 
virtual Brief brief () const
 return a facet for brief encoding of message
 

Additional Inherited Members

- Protected Member Functions inherited from resip::Message
bool hasTransactionUser () const
 
void setTransactionUser (TransactionUser *t)
 
TransactionUser * getTransactionUser ()
 
- Protected Attributes inherited from resip::Message
TransactionUser * mTu
 

Detailed Description

Definition at line 11 of file UserAuthInfo.hxx.

Member Enumeration Documentation

◆ InfoMode

Enumerator
UserUnknown 
RetrievedA1 
Stale 
DigestAccepted 
DigestNotAccepted 
Error 

Definition at line 15 of file UserAuthInfo.hxx.

Constructor & Destructor Documentation

◆ UserAuthInfo() [1/3]

UserAuthInfo::UserAuthInfo ( const resip::Data &  user,
const resip::Data &  realm,
InfoMode  mode,
const resip::Data &  transactionId 
)

Definition at line 15 of file UserAuthInfo.cxx.

◆ UserAuthInfo() [2/3]

UserAuthInfo::UserAuthInfo ( const resip::Data &  user,
const resip::Data &  realm,
const resip::Data &  a1,
const resip::Data &  transactionId 
)

Definition at line 28 of file UserAuthInfo.cxx.

◆ UserAuthInfo() [3/3]

UserAuthInfo::UserAuthInfo ( const resip::Data &  user,
const resip::Data &  realm,
const resip::Data &  transactionId,
resip::TransactionUser *  transactionUser 
)

Definition at line 42 of file UserAuthInfo.cxx.

◆ ~UserAuthInfo()

UserAuthInfo::~UserAuthInfo ( )

Definition at line 56 of file UserAuthInfo.cxx.

Member Function Documentation

◆ clone()

resip::Message * UserAuthInfo::clone ( ) const
virtual

Reimplemented from resip::DumFeatureMessage.

Definition at line 112 of file UserAuthInfo.cxx.

◆ encode()

EncodeStream & UserAuthInfo::encode ( EncodeStream &  strm) const
virtual

output the entire message to stream

Reimplemented from resip::DumFeatureMessage.

Definition at line 118 of file UserAuthInfo.cxx.

◆ encodeBrief()

EncodeStream & UserAuthInfo::encodeBrief ( EncodeStream &  str) const
virtual

output a brief description to stream

Reimplemented from resip::DumFeatureMessage.

Definition at line 125 of file UserAuthInfo.cxx.

◆ getA1()

const Data & UserAuthInfo::getA1 ( ) const

Definition at line 67 of file UserAuthInfo.cxx.

◆ getErrorInfo()

const void UserAuthInfo::getErrorInfo ( int32_t &  errorCode,
resip::Data &  errorStatusText 
) const

Definition at line 84 of file UserAuthInfo.cxx.

◆ getMode()

UserAuthInfo::InfoMode UserAuthInfo::getMode ( ) const

Definition at line 61 of file UserAuthInfo.cxx.

◆ getRealm()

const Data & UserAuthInfo::getRealm ( ) const

Definition at line 73 of file UserAuthInfo.cxx.

◆ getUser()

const Data & UserAuthInfo::getUser ( ) const

Definition at line 79 of file UserAuthInfo.cxx.

◆ setA1()

void UserAuthInfo::setA1 ( const resip::Data &  a1)

Definition at line 106 of file UserAuthInfo.cxx.

◆ setMode()

void UserAuthInfo::setMode ( InfoMode  mode,
int32_t  errorCode = 0,
const resip::Data &  statusText = resip::Data::Empty 
)

Definition at line 91 of file UserAuthInfo.cxx.


The documentation for this class was generated from the following files: