Home > Support > Documentation

GenericCSTAp1 Class Reference

Inheritance diagram for GenericCSTAp1:
SiemensHicom300 IETF_CSTAp1 AlcatelOXOp1 SiemensRealitis TadiranCoral

List of all members.

Public Member Functions

virtual CSTAResponseInfo AnswerCall (string deviceToLift)
virtual CSTAResponseInfo DivertCall (string divertFrom, string divertTo)
int EncodeROSERequestHeader (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, Phase1Opcodes.Opcodes opcode, out InvokeId savedInvokeId)
 GenericCSTAp1 ()
virtual CSTAResponseInfo MakeACSEAssociation ()
virtual CSTAResponseInfo MakeCall (string callingDevice, string calledDevice)
virtual CSTAResponseInfo MonitorStart (string deviceToMonitor)
virtual CSTAResponseInfo MonitorStop (MonitorCrossRefID crossRefId)
virtual CSTAResponseInfo MonitorStop (int crossRefId)
virtual CSTAResponseInfo QueryDevice (string deviceToQuery)
virtual CSTAResponseInfo TransferCall (string heldDevice, string connectedDevice)

Detailed Description

Implements CSTA phase 1 operations using BER.


Constructor & Destructor Documentation

GenericCSTAp1 (  ) 

Default constructor. Indicates that phase 1 is in effect.


Member Function Documentation

virtual CSTAResponseInfo AnswerCall ( string  deviceToLift  )  [virtual]

Answers a call.

Parameters:
deviceToLift The identification (e.g., phone number) of the device to answer.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo DivertCall ( string  divertFrom,
string  divertTo 
) [virtual]

Diverts a call from a source to a destination.

Parameters:
divertFrom Identifier (e.g., phone number) of the call to be diverted.
divertTo Identifier (e.g., phone number) of the location to which the call is to be diverted.
Returns:
A CSTAResponseInfo object.
int EncodeROSERequestHeader ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
Phase1Opcodes.Opcodes  opcode,
out InvokeId  savedInvokeId 
)

This method prepends a ROSE header to an already encoded phase 1 CSTA message.

Parameters:
response A CSTAResponseInfo object, used to communicate any exception information back to the caller.
encodeBuffer An Asn1BerEncodeBuffer instance containing the already encoded CSTA message.
opcode The opcode enumeration for the operation that the encoded CSTA message describes.
savedInvokeId An InvokeId object variable that will get populated with the reference to the InvokeId object that gets encoded into the ROSE header. This is used when the response is received to match the response with the request.
Returns:
The length of the encoded message, including both the CSTA message and the ROSE header, or -1 if the encoding fails.
virtual CSTAResponseInfo MakeACSEAssociation (  )  [virtual]

Establish an ACSE association with the PBX.

Returns:
A CSTAResponseInfo object.

Reimplemented in AlcatelOXOp1.

virtual CSTAResponseInfo MakeCall ( string  callingDevice,
string  calledDevice 
) [virtual]

Instruct the PBX to place a call.

Parameters:
callingDevice Identifier (e.g., phone number) of the device making the call.
calledDevice Identifier (e.g., phone number) of the device being called.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo MonitorStart ( string  deviceToMonitor  )  [virtual]

Issues a MonitorStart request to the PBX.

Parameters:
deviceToMonitor Identifier (e.g., telephone number) of the device to monitor.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo MonitorStop ( MonitorCrossRefID  crossRefId  )  [virtual]

Stop a previously started PBX monitor request.

Parameters:
crossRefId The cross reference id of the monitor request as a MonitorCrossRefID object.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo MonitorStop ( int  crossRefId  )  [virtual]

Stop a previously started PBX monitor request.

Parameters:
crossRefId The cross reference id of the monitor request as an integer.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo QueryDevice ( string  deviceToQuery  )  [virtual]

Queries a device.

Parameters:
deviceToQuery The identification (e.g., phone number) of the device to query.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo TransferCall ( string  heldDevice,
string  connectedDevice 
) [virtual]

Transfers a call from one device to another.

Parameters:
heldDevice Identifier (e.g., phone number) of the device from which the call is transferred.
connectedDevice Identifier (e.g., phone number) of the device to which the call is transferred.
Returns:
A CSTAResponseInfo object.