$treeview $search $mathjax $extrastylesheet
CSTADLL  2.3.4
$projectbrief
$projectbrief
 $searchbox

uaXMLed3 Class Reference

Inheritance diagram for uaXMLed3:
GenericXMLed3

List of all members.

Public Member Functions

virtual void Bye ()
virtual CSTAResponseInfo Invite (uaSIPInvite inviteObject)
sealed override CSTAResponseInfo StartSession ()
sealed override CSTAResponseInfo StartSession (string applicationID)
sealed override CSTAResponseInfo StopSession ()
 uaXMLed3 (PBXSession sessionObject)
 uaXMLed3 (string ua, int port)

Detailed Description

Implements uaCSTA phase 3 operations using XML edition 3. Note that most PBXes don't support all CSTA messages, so some methods in this class may result in an error status being returned by your PBX.

Constructor & Destructor Documentation

uaXMLed3 ( string  ua,
int  port 
)

Constructs an instance associated with the given UA identifier and port.

Parameters:
ua Well-known name or IP address of the SIP user agent.
port Port on which the UA listens for uaCSTA messages.
uaXMLed3 ( PBXSession  sessionObject  ) 

Constructs an instance associated with the given PBXSession object.

Parameters:
sessionObject A PBXSession object.

Member Function Documentation

virtual void Bye (  )  [virtual]

Sends a SIP BYE message to a UA and closes TCP/IP communication with the UA.

virtual CSTAResponseInfo Invite ( uaSIPInvite  inviteObject  )  [virtual]

Sends a SIP INVITE message to a User Agent.

Parameters:
inviteObject A uaSIPInvite object.
Returns:
A CSTAResponseInfo object.
sealed override CSTAResponseInfo StartSession (  )  [virtual]

For regular XML CSTA, the StartSession() method starts communication with a PBX. But for uaCSTA with SIP, its use is not valid. The Invite() method must be used instead. This method will throw an exception.

Returns:
Nothing. An exception is thrown.

Reimplemented from GenericXMLed3.

sealed override CSTAResponseInfo StartSession ( string  applicationID  )  [virtual]

For regular XML CSTA, the StartSession() method starts communication with a PBX. But for uaCSTA with SIP, its use is not valid. The Invite() method must be used instead. This method will throw an exception.

Parameters:
applicationID Ignored.
Returns:
Nothing. An exception is thrown.

Reimplemented from GenericXMLed3.

sealed override CSTAResponseInfo StopSession (  )  [virtual]

For regular XML CSTA, the Stp[Session() method stops communication with a PBX. But for uaCSTA with SIP, its use is not valid. The Bye() method must be used instead. This method will throw an exception.

Returns:

Reimplemented from GenericXMLed3.