CSTADLL  2.5.0
Public Member Functions | List of all members
uaXMLed3 Class Reference
Inheritance diagram for uaXMLed3:
GenericXMLed3

Public Member Functions

virtual void Bye ()
 
virtual CSTAResponseInfo Invite (uaSIPInvite inviteObject)
 
sealed override CSTAResponseInfo StartSession (string applicationID)
 
sealed override CSTAResponseInfo StartSession ()
 
sealed override CSTAResponseInfo StopSession ()
 
 uaXMLed3 (string ua, int port)
 
 uaXMLed3 (PBXSession sessionObject)
 
- Public Member Functions inherited from GenericXMLed3
virtual CSTAResponseInfo AcceptCall (ConnectionID callToAccept)
 
virtual CSTAResponseInfo AnswerCall (ConnectionID callToAnswer)
 
virtual CSTAResponseInfo AnswerCall (ConnectionID callToAnswer, string deviceToLift)
 
virtual CSTAResponseInfo ClearConnection (ConnectionID connectionToClear)
 
virtual CSTAResponseInfo ClearDoNotDisturb (string targetDevice)
 
virtual CSTAResponseInfo ClearForwarding (string fromDevice, ForwardingType fwdType)
 
virtual CSTAResponseInfo ClearMessageWaiting (string targetDevice)
 
virtual CSTAResponseInfo ConferenceCall (ConnectionID heldCall, ConnectionID activeCall)
 
virtual CSTAResponseInfo ConsultationCall (ConnectionID existingCall, string targetDevice)
 
virtual CSTAResponseInfo ConsultationCall (ConnectionID existingCall, string targetDevice, ConsultOptions options)
 
virtual string EncodeInvokeID (string initialMessage)
 
 GenericXMLed3 (string pbxSystem, int port)
 
 GenericXMLed3 (PBXSession sessionObject)
 
virtual CSTAResponseInfo GetAgentState (string agentDevice)
 
virtual CSTAResponseInfo GetDoNotDisturb (string targetDevice)
 
virtual CSTAResponseInfo GetLogicalDevInfo (string targetDevice)
 
virtual CSTAResponseInfo GetPhysicalDevInfo (string targetDevice)
 
virtual CSTAResponseInfo GetSFDevices (ReqDeviceCategory deviceCategory)
 
virtual CSTAResponseInfo GetSFDevices ()
 
virtual CSTAResponseInfo HoldCall (ConnectionID callToHold)
 
virtual CSTAResponseInfo MakeCall (string callingDevice, string calledDevice)
 
virtual CSTAResponseInfo MakeCall (string callingDevice, string calledDevice, bool autoOriginate)
 
virtual CSTAResponseInfo MonitorStart (string deviceToMonitor)
 
virtual CSTAResponseInfo MonitorStart (ConnectionID callToMonitor)
 
virtual CSTAResponseInfo MonitorStop (string crossRefID)
 
virtual CSTAResponseInfo MonitorStopAtDevice (string monitoredDevice)
 
virtual CSTAResponseInfo RequestSystemStatus ()
 
virtual CSTAResponseInfo RetrieveCall (ConnectionID callToRetrieve)
 
virtual CSTAResponseInfo RingDevice (string targetDevice, string targetRinger, long ringPattern)
 
virtual CSTAResponseInfo SendData (IOCrossRefID xref, string text)
 
virtual CSTAResponseInfo SendStoredCDR (string cdrCrossRefID)
 
virtual CSTAResponseInfo SetAgentState (string agentDevice, ReqAgentState agentState, string agentID)
 
virtual CSTAResponseInfo SetAgentState (string agentDevice, ReqAgentState agentState)
 
virtual CSTAResponseInfo SetDisplay (string targetDevice, string text)
 
virtual CSTAResponseInfo SetDoNotDisturb (string targetDevice)
 
virtual CSTAResponseInfo SetForwarding (string fromDevice, ForwardingType fwdType, string toDevice)
 
virtual CSTAResponseInfo SetMessageWaiting (string targetDevice)
 
virtual CSTAResponseInfo SingleStepTransfer (ConnectionID callToTransfer, string transferToDevice)
 
virtual CSTAResponseInfo SnapshotCall (ConnectionID callToSnapshot)
 
virtual CSTAResponseInfo SnapshotDevice (string deviceToSnapshot)
 
virtual CSTAResponseInfo StartCDRTransmission (CDRTransferMode transferMode)
 
virtual CSTAResponseInfo StartDataPath (string targetDevice)
 
virtual CSTAResponseInfo StopCDRTransmission (string cdrCrossRefID)
 
virtual CSTAResponseInfo StopDataPath (IOCrossRefID xref)
 
virtual CSTAResponseInfo StopRing (string targetDevice, string targetRinger, long ringPattern)
 
virtual CSTAResponseInfo TransferCall (ConnectionID initiatedCall, ConnectionID originalCall)
 

Additional Inherited Members

- Protected Member Functions inherited from GenericXMLed3
virtual string EncodeAcceptCall (CSTAResponseInfo response, ConnectionID callToAccept)
 
virtual string EncodeAnswerCall (CSTAResponseInfo response, ConnectionID callToAnswer)
 
virtual string EncodeAnswerCall (CSTAResponseInfo response, ConnectionID callToAnswer, string deviceToLift)
 
virtual string EncodeClearConnection (CSTAResponseInfo response, ConnectionID connectionToClear)
 
virtual string EncodeConferenceCall (CSTAResponseInfo response, ConnectionID heldCall, ConnectionID activeCall)
 
virtual string EncodeConsultationCall (CSTAResponseInfo response, ConnectionID existingCall, string targetDevice, ConsultOptions options)
 
virtual string EncodeGetAgentState (CSTAResponseInfo response, string targetDevice)
 
virtual string EncodeGetDND (CSTAResponseInfo response, string targetDevice)
 
virtual string EncodeGetLogicalDevInfo (CSTAResponseInfo response, string targetDevice)
 
virtual string EncodeGetPhysicalDevInfo (CSTAResponseInfo response, string targetDevice)
 
virtual string EncodeGetSFDevices (CSTAResponseInfo response, ReqDeviceCategory category)
 
virtual string EncodeHoldCall (CSTAResponseInfo response, ConnectionID callToHold)
 
virtual string EncodeMakeCall (CSTAResponseInfo response, string callingDevice, string calledDevice, bool autoOriginate)
 
virtual string EncodeMonitorStart (CSTAResponseInfo response, string targetDevice)
 
virtual string EncodeMonitorStart (CSTAResponseInfo response, ConnectionID targetCall)
 
virtual string EncodeMonitorStop (CSTAResponseInfo response, string xref)
 
virtual string EncodeRequestSystemStatus (CSTAResponseInfo response)
 
virtual string EncodeRetrieveCall (CSTAResponseInfo response, ConnectionID callToRetrieve)
 
virtual string EncodeSendData (CSTAResponseInfo response, IOCrossRefID xref, string strText)
 
virtual string EncodeSendStoredCDR (CSTAResponseInfo response, string cdrCrossRefID)
 
virtual string EncodeSetAgentState (CSTAResponseInfo response, string agentDevice, ReqAgentState agentState, string agentID)
 
virtual string EncodeSetDisplay (CSTAResponseInfo response, string targetDevice, string text)
 
virtual string EncodeSetDND (CSTAResponseInfo response, string targetDevice, bool dndOn)
 
virtual string EncodeSetMsgWaiting (CSTAResponseInfo response, string targetDevice, bool indicatorOn)
 
virtual string EncodeSetOrClearFwdRequest (CSTAResponseInfo response, string fromDevice, bool fwdOn, ForwardingType fwdType, string toDevice)
 
virtual string EncodeSetRingerStatus (CSTAResponseInfo response, string targetDevice, string targetRinger, RingMode rm, long ringPattern)
 
virtual string EncodeSingleStepTransfer (CSTAResponseInfo response, ConnectionID callToTransfer, string transferToDevice)
 
virtual string EncodeSnapshotCall (CSTAResponseInfo response, ConnectionID callToSnapshot)
 
virtual string EncodeSnapshotDevice (CSTAResponseInfo response, string targetDevice)
 
virtual string EncodeStartCDRTrans (CSTAResponseInfo response, CDRTransferMode transferMode)
 
virtual string EncodeStartDataPath (CSTAResponseInfo response, string targetDevice)
 
virtual string EncodeStartSession (CSTAResponseInfo response, string applicationID)
 
virtual string EncodeStopCDRTrans (CSTAResponseInfo response, string cdrCrossRefID)
 
virtual string EncodeStopDataPath (CSTAResponseInfo response, IOCrossRefID xref)
 
virtual string EncodeStopSession (CSTAResponseInfo response)
 
virtual string EncodeTransferCall (CSTAResponseInfo response, ConnectionID initiatedCall, ConnectionID originalCall)
 
- Properties inherited from GenericXMLed3
PBXSession SessionObject [get]
 
CSTAContext ThreadContext [get]
 

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() [1/2]

uaXMLed3 ( string  ua,
int  port 
)

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

Parameters
uaWell-known name or IP address of the SIP user agent.
portPort on which the UA listens for uaCSTA messages.

◆ uaXMLed3() [2/2]

uaXMLed3 ( PBXSession  sessionObject)

Constructs an instance associated with the given PBXSession object.

Parameters
sessionObjectA PBXSession object.

Member Function Documentation

◆ Bye()

virtual void Bye ( )
virtual

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

◆ Invite()

virtual CSTAResponseInfo Invite ( uaSIPInvite  inviteObject)
virtual

Sends a SIP INVITE message to a User Agent.

Parameters
inviteObjectA uaSIPInvite object.
Returns
A CSTAResponseInfo object.

References SocketState.ReadBuffer, CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, SocketState.TotalLength, and CSTAResponseInfo.XMLResponseFromPBX.

◆ StartSession() [1/2]

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
applicationIDIgnored.
Returns
Nothing. An exception is thrown.

Reimplemented from GenericXMLed3.

◆ StartSession() [2/2]

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.

◆ StopSession()

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.