CSTADLL  2.5.0
Public Member Functions | Protected Member Functions | List of all members
SamsungSCM Class Reference
Inheritance diagram for SamsungSCM:
IETF_CSTAp2 GenericCSTAp2

Public Member Functions

virtual CSTAResponseInfo LinkSetup (bool returnNumberPlan)
 
sealed override CSTAResponseInfo MakeACSEAssociation ()
 
 SamsungSCM (string pbxSystem, int port)
 
 SamsungSCM (PBXSession sessionObject)
 
- Public Member Functions inherited from IETF_CSTAp2
 IETF_CSTAp2 (string pbxSystem, int port)
 
 IETF_CSTAp2 (PBXSession sessionObject)
 
- Public Member Functions inherited from GenericCSTAp2
virtual CSTAResponseInfo AnswerCall (string deviceToLift)
 
virtual CSTAResponseInfo AnswerCall (ConnectionID callToAnswer)
 
virtual CSTAResponseInfo AnswerCall (ConnectionID callToAnswer, string deviceToLift)
 
virtual CSTAResponseInfo ClearConnection (ConnectionID connToClear)
 
virtual CSTAResponseInfo ClearDoNotDisturb (string targetDevice)
 
virtual CSTAResponseInfo ClearMessageWaiting (string targetDevice)
 
virtual CSTAResponseInfo ConferenceCall (ConnectionID heldCall, ConnectionID activeCall)
 
virtual CSTAResponseInfo ConsultationCall (ConnectionID existingCall, string targetDevice)
 
virtual CSTAResponseInfo DivertCall (string divertFrom, string divertTo)
 
int EncodeROSERequestHeader (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, Phase2Opcodes.Opcodes opcode)
 
 GenericCSTAp2 (string pbxSystem, int port)
 
 GenericCSTAp2 (PBXSession sessionObject)
 
virtual CSTAResponseInfo HoldCall (ConnectionID callToHold)
 
virtual CSTAResponseInfo MakeCall (string callingDevice, string calledDevice)
 
virtual CSTAResponseInfo MonitorStart (string deviceToMonitor)
 
virtual CSTAResponseInfo MonitorStart (ConnectionID callToMonitor)
 
virtual CSTAResponseInfo MonitorStop (MonitorCrossRefID crossRefID)
 
virtual CSTAResponseInfo MonitorStop (string monitoredDevice)
 
virtual CSTAResponseInfo MonitorStop (long monitoredDevice)
 
virtual CSTAResponseInfo QueryDevice (string deviceToQuery)
 
virtual CSTAResponseInfo ReleaseACSEAssociation ()
 
virtual CSTAResponseInfo RetrieveCall (ConnectionID callToRetrieve)
 
virtual CSTAResponseInfo SetAgentState (string targetDevice, AgentParameter agentParam)
 
virtual CSTAResponseInfo SetDoNotDisturb (string targetDevice)
 
virtual CSTAResponseInfo SetMessageWaiting (string targetDevice)
 
virtual CSTAResponseInfo SetOrClearForwarding (string fromDevice, ForwardingType fwdType, string toDevice)
 
virtual CSTAResponseInfo SnapshotDevice (string deviceToSnapshot)
 
virtual CSTAResponseInfo TransferCall (ConnectionID initiatedCall, ConnectionID originalCall)
 
virtual CSTAResponseInfo TransferCall (string heldDevice, string connectedDevice)
 

Protected Member Functions

virtual int EncodeLinkSetupRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, bool returnNumberPlan)
 
- Protected Member Functions inherited from GenericCSTAp2
virtual int EncodeACSEConnectionRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer)
 
virtual int EncodeACSEReleaseRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer)
 
virtual int EncodeAnswerCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string deviceToLift)
 
virtual int EncodeAnswerCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID callToAnswer)
 
virtual int EncodeAnswerCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID callToAnswer, string deviceToLift)
 
virtual int EncodeClearConnectionRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID connToClear)
 
virtual int EncodeConferenceCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID heldCall, ConnectionID activeCall)
 
virtual int EncodeConsultationCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID existingCall, string targetDevice)
 
virtual int EncodeDivertCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string divertFrom, string divertTo)
 
virtual int EncodeHoldCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID callToHold)
 
virtual int EncodeMakeCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string callingDevice, string calledDevice)
 
virtual int EncodeMonitorStartRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string deviceToMonitor)
 
virtual int EncodeMonitorStartRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID callToMonitor)
 
virtual int EncodeMonitorStopRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, MonitorCrossRefID crossRefObj)
 
virtual int EncodeQueryDeviceRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string deviceToQuery)
 
virtual int EncodeRetrieveCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID callToRetrieve)
 
virtual int EncodeSetAgentStateRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string targetDevice, AgentParameter agentParam)
 
virtual int EncodeSetOrClearDNDRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string targetDevice, bool dndOn)
 
virtual int EncodeSetOrClearFwdRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string fromDevice, ForwardingType fwdType, string toDevice)
 
virtual int EncodeSetOrClearMWRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string targetDevice, bool indicatorOn)
 
virtual int EncodeSnapshotDeviceRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string deviceToSnapshot)
 
virtual int EncodeTransferCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID initiatedCall, ConnectionID originalCall)
 
virtual int EncodeTransferCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string heldDevice, string connectedDevice)
 

Additional Inherited Members

- Properties inherited from GenericCSTAp2
PBXSession SessionObject [get]
 
CSTAContext ThreadContext [get]
 

Detailed Description

Implements CSTA phase 2 operations for the Samsung SCM PBX device.

Constructor & Destructor Documentation

◆ SamsungSCM() [1/2]

SamsungSCM ( string  pbxSystem,
int  port 
)

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

Parameters
pbxSystemWell-known name or IP address of the PBX.
portPort on which the PBX listens for CSTA messages.

◆ SamsungSCM() [2/2]

SamsungSCM ( PBXSession  sessionObject)

Constructs an instance associated with the given PBXSession object.

Parameters
sessionObjectA PBXSession object.

Member Function Documentation

◆ EncodeLinkSetupRequest()

virtual int EncodeLinkSetupRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
bool  returnNumberPlan 
)
protectedvirtual

Encodes the Samsung CSTA_LINK_SETUP message.

Parameters
responseA CSTAResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
returnNumberPlanIndicates whether the user number plan is included in the response message.
Returns
The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ LinkSetup()

virtual CSTAResponseInfo LinkSetup ( bool  returnNumberPlan)
virtual

Establishes initial communication with the Samsung SCM.

Parameters
returnNumberPlanIndicates whether the user number plan is included in the response message.
Returns
A CSTAResponseInfo object.

References PBXSession.DebugMode, GenericCSTAp2.EncodeROSERequestHeader(), PBXSession.MaxReceiveTimeout, SocketState.ReadBuffer, CSTAResponseInfo.ResponseFromPBX, CSTAResponseInfo.ResponsesFromPBX, CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and SocketState.TotalLength.

◆ MakeACSEAssociation()

sealed override CSTAResponseInfo MakeACSEAssociation ( )
virtual

Throws an exception since this PBX device doesn't do ACSE associations.

Returns
Nothing. An exception is thrown.

Reimplemented from GenericCSTAp2.