h323plus: H323Connection Class Reference

Enumerator:

FastStartOptionDisable
FastStartOptionEnable
FastStartOptionMask
H245TunnelingOptionDisable
H245TunnelingOptionEnable
H245TunnelingOptionMask
H245inSetupOptionDisable
H245inSetupOptionEnable
H245inSetupOptionMask
DetectInBandDTMFOptionDisable
DetectInBandDTMFOptionEnable
DetectInBandDTMFOptionMask

Definition at line 591 of file h323con.h.

enum H323Connection::CallEndReason

Call clearance reasons. NOTE: if anything is added to this, you also need to add the field to the tables in h323.cxx and h323pdu.cxx.

Enumerator:

EndedByLocalUser	Local endpoint application cleared call.
EndedByNoAccept	Local endpoint did not accept call OnIncomingCall()=FALSE.
EndedByAnswerDenied	Local endpoint declined to answer call.
EndedByRemoteUser	Remote endpoint application cleared call.
EndedByRefusal	Remote endpoint refused call.
EndedByNoAnswer	Remote endpoint did not answer in required time.
EndedByCallerAbort	Remote endpoint stopped calling.
EndedByTransportFail	Transport error cleared call.
EndedByConnectFail	Transport connection failed to establish call.
EndedByGatekeeper	Gatekeeper has cleared call.
EndedByNoUser	Call failed as could not find user (in GK).
EndedByNoBandwidth	Call failed as could not get enough bandwidth.
EndedByCapabilityExchange	Could not find common capabilities.
EndedByCallForwarded	Call was forwarded using FACILITY message.
EndedBySecurityDenial	Call failed a security check and was ended.
EndedByLocalBusy	Local endpoint busy.
EndedByLocalCongestion	Local endpoint congested.
EndedByRemoteBusy	Remote endpoint busy.
EndedByRemoteCongestion	Remote endpoint congested.
EndedByUnreachable	Could not reach the remote party.
EndedByNoEndPoint	The remote party is not running an endpoint.
EndedByHostOffline	The remote party host off line.
EndedByTemporaryFailure	The remote failed temporarily app may retry.
EndedByQ931Cause	The remote ended the call with unmapped Q.931 cause code.
EndedByDurationLimit	Call cleared due to an enforced duration limit.
EndedByInvalidConferenceID	Call cleared due to invalid conference ID.
EndedByOSPRefusal	Call cleared as OSP server unable or unwilling to route.
EndedByInvalidNumberFormat	Call cleared as number was invalid format.
EndedByUnspecifiedProtocolError	Call cleared due to unspecified protocol error.
EndedByNoFeatureSupport	Call ended due to Feature not being present.
NumCallEndReasons

Definition at line 741 of file h323con.h.

enum H323Connection::AnswerCallResponse

Enumerator:

AnswerCallNow	Answer the call continuing with the connection.
AnswerCallDenied	Refuse the call sending a release complete.
AnswerCallPending	Send an Alerting PDU and wait for AnsweringCall().
AnswerCallDeferred	As for AnswerCallPending but does not send Alerting PDU.
AnswerCallAlertWithMedia	As for AnswerCallPending but starts media channels.
AnswerCallDeferredWithMedia	As for AnswerCallDeferred but starts media channels.
AnswerCallDeniedByInvalidCID	As for AnswerCallDenied but returns e_invalidCID.
NumAnswerCallResponses

Definition at line 1278 of file h323con.h.

enum H323Connection::ControlProtocolErrors

Error discriminator for the OnControlProtocolError() function.

Enumerator:

e_MasterSlaveDetermination
e_CapabilityExchange
e_LogicalChannel
e_ModeRequest
e_RoundTripDelay

Definition at line 1631 of file h323con.h.

enum H323Connection::SendUserInputModes

Enumerator:

SendUserInputAsQ931
SendUserInputAsString
SendUserInputAsTone
SendUserInputAsInlineRFC2833
SendUserInputAsSeparateRFC2833
SendUserInputAsNavigation
SendUserInputAsSoftkey
SendUserInputAsPointDevice
SendUserInputAsModal
NumSendUserInputModes

Definition at line 2090 of file h323con.h.

enum H323Connection::ReleaseSequence

Enumerator:

ReleaseSequenceUnknown
ReleaseSequence_Local
ReleaseSequence_Remote

Definition at line 2918 of file h323con.h.

enum H323Connection::h245MessageType

Enumerator:

h245request
h245response
h245command
h245indication

Definition at line 2939 of file h323con.h.

enum H323Connection::ConnectionStates [protected]

Enumerator:

NoConnectionActive
AwaitingGatekeeperAdmission
AwaitingTransportConnect
AwaitingSignalConnect
AwaitingLocalAnswer
HasExecutedSignalConnect
EstablishedConnection
ShuttingDownConnection
NumConnectionStates

Definition at line 3016 of file h323con.h.

enum H323Connection::FastStartStates [protected]

Enumerator:

FastStartDisabled
FastStartInitiate
FastStartResponse
FastStartAcknowledged
NumFastStartStates

Definition at line 3079 of file h323con.h.

H323Connection::H323Connection	(	H323EndPoint &	endpoint,
		unsigned	callReference,
		unsigned	options = `0`
	)

Create a new connection.

Parameters:

endpoint	H323 End Point object
callReference	Call reference
options	Connection option bits

Definition at line 599 of file h323.cxx.

References addAccessTokenToSetup, alertingPDU, AuthenticationFailed, bandwidthAvailable, callAnswered, callEndReason, callIntrusionProtectionLevel, callReference, capabilityExchangeProcedure, connectPDU, controlChannel, detectInBandDTMF, H323EndPoint::DetectInBandDTMFDisabled(), DetectInBandDTMFOptionDisable, DetectInBandDTMFOptionEnable, DetectInBandDTMFOptionMask, disableH460, distinctiveRing, doH245inSETUP, earlyStart, endpoint, endSessionNeeded, endSessionSent, endSync, Q931::ErrorInCauseIE, FastStartDisabled, FastStartInitiate, FastStartOptionDisable, FastStartOptionEnable, FastStartOptionMask, fastStartState, features, H323EndPoint::FeatureSetDisabled(), H460_Feature::FeatureSignal, gatekeeperRouted, H323EndPoint::GetCallIntrusionProtectionLevel(), H323EndPoint::GetInitialBandwidth(), H323EndPoint::GetMaxAudioJitterDelay(), H323EndPoint::GetMinAudioJitterDelay(), H323EndPoint::GetSendUserInputMode(), h224handler, h225version, H245inSetupOptionDisable, H245inSetupOptionEnable, H245inSetupOptionMask, h245Tunneling, H245TunnelingOptionDisable, H245TunnelingOptionEnable, H245TunnelingOptionMask, h245TunnelRxPDU, h245TunnelTxPDU, h245version, h245versionSet, h281handler, h45011handler, h4502handler, h4503handler, h4504handler, h4506handler, h450dispatcher, hasAuthentication, holdAudioMediaChannel, holdVideoMediaChannel, isCallIntrusion, isConsultationTransfer, H323EndPoint::IsFastStartDisabled(), H323EndPoint::IsH245inSetupDisabled(), H323EndPoint::IsH245TunnelingDisabled(), IsNonCallConnection, lastPDUWasH245inSETUP, H460_FeatureSet::LoadFeatureSet(), localAliasNames, logicalChannels, masterSlaveDeterminationProcedure, maxAudioJitterDelay, mediaWaitForConnect, minAudioJitterDelay, mustSendDRQ, NATsupport, NoConnectionActive, NumCallEndReasons, q931Cause, remoteCallWaiting, remoteIsNAT, remoteMaxAudioDelayJitter, requestModeProcedure, rfc2833handler, roundTripDelayProcedure, sameNAT, sendUserInputMode, signallingChannel, startH224, startT120, t120handler, t38handler, transmitterSidePaused, and uuiesRequested.

H323Connection::~H323Connection ( )

Destroy the connection

Definition at line 801 of file h323.cxx.

References alertingPDU, callToken, capabilityExchangeProcedure, connectPDU, controlChannel, endSync, h224handler, h281handler, h450dispatcher, holdAudioMediaChannel, holdVideoMediaChannel, logicalChannels, masterSlaveDeterminationProcedure, requestModeProcedure, rfc2833handler, roundTripDelayProcedure, signallingChannel, t120handler, and t38handler.

BOOL H323Connection::Lock ( )

Lock connection. When any thread wants exclusive use of the connection, it must use this function to gain the mutex. Note this is not a simple mutex to allow for the rather complicated mechanism for preventing deadlocks in associated threads to the connection (eg Q.931 reader thread).

Returns FALSE if the lock was not obtainable due to the connection being shut down.

Definition at line 839 of file h323.cxx.

References ShuttingDownConnection.

Referenced by AnsweringCall(), H45011Handler::GetRemoteCallIntrusionProtectionLevel(), H323Transport::HandleFirstSignallingChannelPDU(), HandleReceivedControlPDU(), HandleSignalPDU(), H323EndPoint::InternalMakeCall(), H225CallThread::Main(), MonitorCallStatus(), H45011Handler::OnReceivedCIGetCIPLResult(), H4502Handler::OnReceivedIdentifyReturnError(), SendSignalSetup(), and StartRoundTripDelay().

int H323Connection::TryLock ( )

Try to lock connection. When the H323EndPoint::FindConnectionWithLock() function is used to gain access to a connection object, this is called to prevent it from being closed and deleted by the background threads.

Note this is an internal function and it is not expected an application would use it.

Returns 0 if the lock was not obtainable due to the connection being shut down, -1 if it was not available, and +1 if lock is obtained.

Definition at line 856 of file h323.cxx.

References ShuttingDownConnection.

Referenced by H323EndPoint::FindConnectionWithLock().

void H323Connection::Unlock ( )

Unlock connection. If the H323EndPoint::FindConnectionWithLock() function is used to gain access to a connection object, this MUST be called to allow it to subsequently be closed and disposed of.

Definition at line 871 of file h323.cxx.

Referenced by AnsweringCall(), H323EndPoint::ForwardConnection(), H45011Handler::GetRemoteCallIntrusionProtectionLevel(), H323Transport::HandleFirstSignallingChannelPDU(), HandleReceivedControlPDU(), HandleSignalPDU(), H323EndPoint::IsConnectionEstablished(), H225CallThread::Main(), H323EndPoint::MakeCall(), MonitorCallStatus(), H323Gatekeeper::OnReceiveBandwidthRequest(), H4502Handler::onReceivedAdmissionReject(), H45011Handler::OnReceivedCIGetCIPLResult(), H4502Handler::OnReceivedIdentifyReturnError(), H4502Handler::OnReceivedIdentifyReturnResult(), H4502Handler::OnReceivedInitiateReturnError(), H323Gatekeeper::OnReceiveDisengageRequest(), H4502Handler::OnReceivedSetupReturnError(), H323Gatekeeper::OnReceiveInfoRequest(), SendSignalSetup(), and StartRoundTripDelay().

void H323Connection::OnSendARQ ( H225_AdmissionRequest & arq ) [virtual]

called when an ARQ needs to be sent to a gatekeeper. This allows the connection to change or check fields in the ARQ before it is sent.

By default, this calls the matching function on the endpoint

Definition at line 5118 of file h323.cxx.

References H460_MessageType::e_admissionRequest, H225_AdmissionRequest::e_genericData, endpoint, H225_AdmissionRequest::m_genericData, H225_FeatureSet::m_supportedFeatures, H323EndPoint::OnSendARQ(), and OnSendFeatureSet().

Referenced by H323Gatekeeper::AdmissionRequest().

void H323Connection::OnReceivedACF ( const H225_AdmissionConfirm & acf ) [virtual]

called when an ACF is received from a gatekeeper.

By default, this calls the matching function on the endpoint

Definition at line 5140 of file h323.cxx.

References H460_MessageType::e_admissionConfirm, H225_AdmissionConfirm::e_genericData, endpoint, H225_AdmissionConfirm::m_genericData, H225_FeatureSet::m_supportedFeatures, H323EndPoint::OnReceivedACF(), and OnReceiveFeatureSet().

void H323Connection::OnReceivedARJ ( const H225_AdmissionReject & arj ) [virtual]

called when an ARJ is received from a gatekeeper.

By default, this calls the matching function on the endpoint

Definition at line 5161 of file h323.cxx.

References H460_MessageType::e_admissionReject, H225_AdmissionReject::e_genericData, endpoint, H225_AdmissionReject::m_genericData, H225_FeatureSet::m_supportedFeatures, H323EndPoint::OnReceivedARJ(), and OnReceiveFeatureSet().

Referenced by H323Gatekeeper::OnReceiveAdmissionReject().

void H323Connection::OnSendIRR ( H225_InfoRequestResponse & irr ) const [virtual]

called when an IRR needs to be sent to a gatekeeper. This allows the connection to change or check fields in the IRR before it is sent.

By default, this does nothing

Definition at line 5182 of file h323.cxx.

References H225_InfoRequestResponse::e_genericData, H460_MessageType::e_inforequestresponse, H225_InfoRequestResponse::m_genericData, H225_FeatureSet::m_supportedFeatures, and OnSendFeatureSet().

Referenced by H323Gatekeeper::InfoRequestResponse().

void H323Connection::OnSendDRQ ( H225_DisengageRequest & drq ) const [virtual]

called when an DRQ needs to be sent to a gatekeeper. This allows the connection to change or check fields in the DRQ before it is sent.

By default, this does nothing

Definition at line 5203 of file h323.cxx.

References H460_MessageType::e_disengagerequest, H225_DisengageRequest::e_genericData, H225_DisengageRequest::m_genericData, H225_FeatureSet::m_supportedFeatures, and OnSendFeatureSet().

Referenced by H323Gatekeeper::DisengageRequest().

void H323Connection::OnEstablished ( ) [virtual]

Called when a connection is established. Default behaviour is to call H323EndPoint::OnConnectionEstablished

Definition at line 1375 of file h323.cxx.

References callToken, endpoint, and H323EndPoint::OnConnectionEstablished().

Referenced by InternalEstablishedConnectionCheck().

void H323Connection::OnCleared ( ) [virtual]

Called when a connection is cleared, just after CleanUpOnCallEnd() Default behaviour is to call H323EndPoint::OnConnectionCleared

Definition at line 1380 of file h323.cxx.

References callToken, endpoint, and H323EndPoint::OnConnectionCleared().

Referenced by H323EndPoint::CleanUpConnections().

BOOL H323Connection::IsConnected ( ) const [inline]

Determine if the call has been connected. This indicates that Q.931 CONNECT has occurred. This usually means in PSTN gateway environments that a charge will be made for the call. This is not quite the same as IsEstablished() as that indicates the call is connected AND there is media open.

Definition at line 728 of file h323con.h.

References EstablishedConnection, and HasExecutedSignalConnect.

Referenced by H323TransportTCP::AcceptControlChannel().

BOOL H323Connection::IsEstablished ( ) const [inline]

Determine if the call has been established. This can be used in combination with the GetCallEndReason() function to determine the three main phases of a call, call setup, call established and call cleared.

Definition at line 735 of file h323con.h.

References EstablishedConnection.

Referenced by H323EndPoint::IsConnectionEstablished().

CallEndReason H323Connection::GetCallEndReason ( ) const [inline]

Get the call clearand reason for this connection shutting down. Note that this function is only generally useful in the H323EndPoint::OnConnectionCleared() function. This is due to the connection not being cleared before that, and the object not even exiting after that.

If the call is still active then this will return NumCallEndReasons.

Definition at line 786 of file h323con.h.

References callEndReason.

void H323Connection::SetCallEndReason	(	CallEndReason	reason,
		PSyncPoint *	sync = `NULL`
	)			`[virtual]`

Set the call clearance reason. An application should have no cause to use this function. It is present for the H323EndPoint::ClearCall() function to set the clearance reason.

Parameters:

reason	Reason for clearance of connection.
sync	syncpoint to use for synchronous destruction

Definition at line 878 of file h323.cxx.

References H450xDispatcher::AttachToReleaseComplete(), H323ControlPDU::BuildEndSessionCommand(), H323SignalPDU::BuildReleaseComplete(), callEndReason, callEndTime, callReference, callToken, H245_EndSessionCommand::e_disconnect, endSessionNeeded, endSessionSent, endSync, h245TunnelTxPDU, h450dispatcher, NumCallEndReasons, OnSendReleaseComplete(), releaseSequence, ReleaseSequence_Local, ReleaseSequenceUnknown, WriteControlPDU(), and WriteSignalPDU().

Referenced by H323EndPoint::ClearAllCalls(), H323EndPoint::ClearCallSynchronous(), and H323EndPoint::ForwardConnection().

BOOL H323Connection::ClearCall ( CallEndReason reason = EndedByLocalUser ) [virtual]

Clear a current connection. This hangs up the connection to a remote endpoint. It actually just calls the endpoint version of the ClearCall() function to avoid possible multithreading race conditions.

Parameters:

reason

Reason for call clearing

Definition at line 929 of file h323.cxx.

References callToken, H323EndPoint::ClearCall(), and endpoint.

Referenced by H323TransportTCP::AcceptControlChannel(), AnsweringCall(), H323TransportTCP::CreateControlChannel(), H323Transport::HandleFirstSignallingChannelPDU(), H245NegTerminalCapabilitySet::HandleIncoming(), HandleReceivedControlPDU(), HandleReceivedSignalPDU(), H225CallThread::Main(), MonitorCallStatus(), OnH245Command(), H45011Handler::OnReceivedCallIntrusionForcedRelease(), OnReceivedFacility(), H323Gatekeeper::OnReceiveDisengageRequest(), OnReceivedReleaseComplete(), OnReceivedSignalConnect(), OnReceivedSignalSetup(), SendMoreDigits(), SendUserInputIndicationQ931(), StartControlChannel(), StartRoundTripDelay(), and WriteSignalPDU().

BOOL H323Connection::ClearCallSynchronous	(	PSyncPoint *	sync,
		CallEndReason	reason = `EndedByLocalUser`
	)			`[virtual]`

Clear a current connection, synchronously

Parameters:

reason

Reason for call clearing

Definition at line 934 of file h323.cxx.

References callToken, H323EndPoint::ClearCallSynchronous(), and endpoint.

void H323Connection::CleanUpOnCallEnd ( ) [virtual]

Clean up the call clearance of the connection. This function will do any internal cleaning up and waiting on background threads that may be using the connection object. After this returns it is then safe to delete the object.

An application will not typically use this function as it is used by the H323EndPoint during a clear call.

Definition at line 940 of file h323.cxx.

References callEndTime, callToken, capabilityExchangeProcedure, H323Transport::CleanUpOnTermination(), controlChannel, digitsWaitFlag, H323Gatekeeper::DisengageRequest(), H225_DisengageReason::e_normalDrop, endpoint, endSessionNeeded, endSessionReceived, fastStartChannels, H323EndPoint::GetEndSessionTimeout(), H323EndPoint::GetGatekeeper(), logicalChannels, masterSlaveDeterminationProcedure, mustSendDRQ, H245NegLogicalChannels::RemoveAll(), ShuttingDownConnection, signallingChannel, H245NegTerminalCapabilitySet::Stop(), and H245NegMasterSlaveDetermination::Stop().

Referenced by H323EndPoint::CleanUpConnections().

void H323Connection::AttachSignalChannel	(	const PString &	token,
		H323Transport *	channel,
		BOOL	answeringCall
	)			`[virtual]`

Attach a transport to this connection as the signalling channel.

Parameters:

token	New token to use to identify connection
channel	Transport for the PDU's
answeringCall	Flag for if incoming/outgoing call.

Definition at line 1019 of file h323.cxx.

References callAnswered, callToken, SetAuthenticationConnection(), and signallingChannel.

Referenced by H323EndPoint::InternalMakeCall(), and H323EndPoint::OnIncomingConnection().

BOOL H323Connection::WriteSignalPDU ( H323SignalPDU & pdu )

Write a PDU to the signalling channel.

Parameters:

pdu

PDU to write.

Definition at line 1042 of file h323.cxx.

References ClearCall(), EndedByTransportFail, endpoint, H323EndPoint::GetGatekeeper(), h245Tunneling, H323Gatekeeper::InfoRequestResponse(), lastPDUWasH245inSETUP, H225_H323_UU_PDU::m_h245Tunneling, H225_H323_UserInformation::m_h323_uu_pdu, signallingChannel, and H323SignalPDU::Write().

Referenced by AnsweringCall(), ForwardCall(), HandleTunnelPDU(), OnReceivedSignalConnect(), OnReceivedSignalSetup(), SendMoreDigits(), SendSignalSetup(), SendUserInputIndicationQ931(), SetCallEndReason(), WriteControlPDU(), and H450ServiceAPDU::WriteFacilityPDU().

void H323Connection::HandleSignallingChannel ( ) [virtual]

Handle reading PDU's from the signalling channel. This is an internal function and is unlikely to be used by applications.

Definition at line 1063 of file h323.cxx.

References callReference, controlChannel, endSessionReceived, HandleReceivedSignalPDU(), and signallingChannel.

Referenced by H323Transport::HandleFirstSignallingChannelPDU(), and H225CallThread::Main().

BOOL H323Connection::HandleReceivedSignalPDU	(	BOOL	readStatus,
		H323SignalPDU &	pdu
	)			`[virtual]`

Handle a single received PDU from the signalling channel. This is an internal function and is unlikely to be used by applications.

Definition at line 1084 of file h323.cxx.

References AuthenticationFailed, AwaitingSignalConnect, ClearCall(), H323Transport::Close(), controlChannel, EndedByCapabilityExchange, EndedByNoAnswer, EndedBySecurityDenial, EndedByTransportFail, EstablishedConnection, HandleSignalPDU(), HasExecutedSignalConnect, MonitorCallStatus(), and signallingChannel.

Referenced by HandleSignallingChannel().

BOOL H323Connection::HandleReceivedControlPDU	(	BOOL	readStatus,
		PPER_Stream &	strm
	)			`[virtual]`

Handle a single received PDU from the control channel. This is an internal function and is unlikely to be used by applications.

Definition at line 2959 of file h323.cxx.

References ClearCall(), controlChannel, EndedByTransportFail, endSessionSent, HandleControlData(), InternalEndSessionCheck(), Lock(), and Unlock().

Referenced by HandleControlChannel().

BOOL H323Connection::HandleSignalPDU ( H323SignalPDU & pdu ) [virtual]

Handle PDU from the signalling channel. This is an internal function and is unlikely to be used by applications.

Parameters:

pdu

PDU to handle.

Definition at line 1134 of file h323.cxx.

References Q931::AlertingMsg, Q931::CallProceedingMsg, capabilityExchangeProcedure, connectedTime, Q931::ConnectMsg, H225_NonStandardIdentifier::e_h221NonStandard, H225_H323_UU_PDU::e_h4501SupplementaryService, H225_H323_UU_PDU::e_nonStandardControl, endpoint, endSessionReceived, Q931::FacilityMsg, Q931::GetCallReference(), H323EndPoint::GetGatekeeper(), Q931::GetKeypad(), Q931::GetMessageType(), Q931::GetMessageTypeName(), H323SignalPDU::GetQ931(), h245Tunneling, h245TunnelRxPDU, h450dispatcher, H450xDispatcher::HandlePDU(), HandleTunnelPDU(), H323Gatekeeper::InfoRequestResponse(), Q931::InformationMsg, InternalEndSessionCheck(), InternalEstablishedConnectionCheck(), Lock(), H225_H323_UU_PDU::m_h245Control, H225_H323_UU_PDU::m_h245Tunneling, H225_H323_UserInformation::m_h323_uu_pdu, H225_H221NonStandard::m_manufacturerCode, H225_H323_UU_PDU::m_nonStandardControl, H225_H221NonStandard::m_t35CountryCode, H225_H221NonStandard::m_t35Extension, masterSlaveDeterminationProcedure, Q931::NotifyMsg, OnReceivedAlerting(), OnReceivedCallProceeding(), OnReceivedFacility(), OnReceivedProgress(), OnReceivedReleaseComplete(), OnReceivedSignalConnect(), OnReceivedSignalInformation(), OnReceivedSignalNotify(), OnReceivedSignalSetup(), OnReceivedSignalSetupAck(), OnReceivedSignalStatus(), OnReceivedStatusEnquiry(), OnUnknownSignalPDU(), OnUserInputString(), Q931::ProgressMsg, Q931::ReleaseCompleteMsg, releaseSequence, ReleaseSequence_Remote, ReleaseSequenceUnknown, remoteApplication, Q931::SetupAckMsg, Q931::SetupMsg, setupTime, Q931::StatusEnquiryMsg, Q931::StatusMsg, H245NegTerminalCapabilitySet::Stop(), H245NegMasterSlaveDetermination::Stop(), and Unlock().

Referenced by H323Transport::HandleFirstSignallingChannelPDU(), and HandleReceivedSignalPDU().

void H323Connection::HandleTunnelPDU ( H323SignalPDU * txPDU ) [virtual]

Handle Control PDU tunnelled in the signalling channel. This is an internal function and is unlikely to be used by applications.

Parameters:

txPDU

PDU tunnel response into.

Definition at line 1280 of file h323.cxx.

References H323SignalPDU::BuildFacility(), Q931::CallProceedingMsg, capabilityExchangeProcedure, H225_Setup_UUIE::e_parallelH245Control, H225_H323_UU_PDU_h323_message_body::e_setup, Q931::GetMessageType(), H323SignalPDU::GetQ931(), h245Tunneling, h245TunnelRxPDU, h245TunnelTxPDU, HandleControlData(), lastPDUWasH245inSETUP, H225_H323_UU_PDU::m_h245Control, H225_H323_UU_PDU::m_h245Tunneling, H225_H323_UU_PDU::m_h323_message_body, H225_H323_UserInformation::m_h323_uu_pdu, masterSlaveDeterminationProcedure, remoteApplication, H245NegTerminalCapabilitySet::Stop(), H245NegMasterSlaveDetermination::Stop(), and WriteSignalPDU().

Referenced by AnsweringCall(), and HandleSignalPDU().

BOOL H323Connection::OnReceivedSignalSetup ( const H323SignalPDU & pdu ) [virtual]

Handle an incoming Q931 setup PDU. The default behaviour is to do the handshaking operation calling a few virtuals at certain moments in the sequence.

If FALSE is returned the connection is aborted and a Release Complete PDU is sent.

Do Authentication of Incoming Call before anything else

Here is a spot where we should wait in case of Call Intrusion for CIPL from other endpoints if (isCallIntrusion) return TRUE;

If we have a case of incoming call intrusion we should not Clear the Call

Parameters:

pdu

Received setup PDU

Definition at line 1461 of file h323.cxx.

Referenced by HandleSignalPDU().

BOOL H323Connection::OnReceivedSignalSetupAck ( const H323SignalPDU & pdu ) [virtual]

Handle an incoming Q931 setup acknowledge PDU. If FALSE is returned the connection is aborted and a Release Complete PDU is sent.

The default behaviour does nothing.

Parameters:

pdu

Received setup PDU

Definition at line 1716 of file h323.cxx.

References OnInsufficientDigits().

Referenced by HandleSignalPDU().

BOOL H323Connection::OnReceivedSignalInformation ( const H323SignalPDU & pdu ) [virtual]

Handle an incoming Q931 information PDU. If FALSE is returned the connection is aborted and a Release Complete PDU is sent.

The default behaviour does nothing.

Parameters:

pdu

Received setup PDU

Definition at line 1723 of file h323.cxx.

Referenced by HandleSignalPDU().

BOOL H323Connection::OnReceivedCallProceeding ( const H323SignalPDU & pdu ) [virtual]

Handle an incoming Q931 call proceeding PDU. If FALSE is returned the connection is aborted and a Release Complete PDU is sent.

The default behaviour checks for hH245Address field and if present starts the separate H245 channel, if successful or not present it returns TRUE.

Parameters:

pdu

Received call proceeding PDU

Definition at line 1729 of file h323.cxx.

References H460_MessageType::e_callProceeding, H225_H323_UU_PDU_h323_message_body::e_callProceeding, H225_CallProceeding_UUIE::e_fastStart, H225_CallProceeding_UUIE::e_h245Address, HandleFastStartAcknowledge(), H225_CallProceeding_UUIE::m_destinationInfo, H225_CallProceeding_UUIE::m_fastStart, H225_CallProceeding_UUIE::m_h245Address, H225_H323_UU_PDU::m_h323_message_body, H225_H323_UserInformation::m_h323_uu_pdu, H225_CallProceeding_UUIE::m_protocolIdentifier, SetRemoteApplication(), SetRemotePartyInfo(), SetRemoteVersions(), and StartControlChannel().

Referenced by HandleSignalPDU().

BOOL H323Connection::OnReceivedProgress ( const H323SignalPDU & pdu ) [virtual]

Handle an incoming Q931 progress PDU. If FALSE is returned the connection is aborted and a Release Complete PDU is sent.

The default behaviour checks for hH245Address field and if present starts the separate H245 channel, if successful or not present it returns TRUE.

Parameters:

pdu

Received call proceeding PDU

Definition at line 1762 of file h323.cxx.

References H225_Progress_UUIE::e_fastStart, H225_Progress_UUIE::e_h245Address, H225_H323_UU_PDU_h323_message_body::e_progress, HandleFastStartAcknowledge(), H225_Progress_UUIE::m_destinationInfo, H225_Progress_UUIE::m_fastStart, H225_Progress_UUIE::m_h245Address, H225_H323_UU_PDU::m_h323_message_body, H225_H323_UserInformation::m_h323_uu_pdu, H225_Progress_UUIE::m_protocolIdentifier, SetRemoteApplication(), SetRemotePartyInfo(), SetRemoteVersions(), and StartControlChannel().

Referenced by HandleSignalPDU().

BOOL H323Connection::OnReceivedAlerting ( const H323SignalPDU & pdu ) [virtual]

Handle an incoming Q931 alerting PDU. If FALSE is returned the connection is aborted and a Release Complete PDU is sent.

The default behaviour obtains the display name and calls OnAlerting().

Parameters:

pdu

Received Alerting PDU

Definition at line 1784 of file h323.cxx.

Referenced by HandleSignalPDU().

BOOL H323Connection::OnReceivedSignalConnect ( const H323SignalPDU & pdu ) [virtual]

Handle an incoming Q931 connect PDU. If FALSE is returned the connection is aborted and a Release Complete PDU is sent.

The default behaviour checks for hH245Address field and if present starts the separate H245 channel, if successful it returns TRUE. If not present and there is no H245Tunneling then it returns FALSE.

Parameters:

pdu

Received connect PDU

Definition at line 1824 of file h323.cxx.

References H323SignalPDU::BuildFacility(), ClearCall(), connectedTime, controlChannel, H460_MessageType::e_connect, H225_H323_UU_PDU_h323_message_body::e_connect, H4502Handler::e_ctAwaitSetupResponse, H225_Connect_UUIE::e_fastStart, H225_Facility_UUIE::e_h245Address, H225_Connect_UUIE::e_h245Address, H225_FacilityReason::e_startH245, EndedByNoAccept, EstablishedConnection, FastStartAcknowledged, fastStartChannels, FastStartDisabled, fastStartState, H4502Handler::GetState(), h245Tunneling, h4502handler, HandleFastStartAcknowledge(), HasExecutedSignalConnect, H4502Handler::IsctTimerRunning(), IsNonCallConnection, H225_Connect_UUIE::m_destinationInfo, H225_Connect_UUIE::m_fastStart, H225_Facility_UUIE::m_h245Address, H225_Connect_UUIE::m_h245Address, H225_H323_UU_PDU::m_h323_message_body, H225_H323_UserInformation::m_h323_uu_pdu, H225_Connect_UUIE::m_protocolIdentifier, OnOutgoingCall(), H4502Handler::OnReceivedSetupReturnResult(), SetRemoteApplication(), SetRemotePartyInfo(), SetRemoteVersions(), H323Transport::SetUpTransportPDU(), ShuttingDownConnection, signallingChannel, StartControlChannel(), StartControlNegotiations(), and WriteSignalPDU().

Referenced by HandleSignalPDU().

BOOL H323Connection::OnReceivedFacility ( const H323SignalPDU & pdu ) [virtual]

Handle an incoming Q931 facility PDU. If FALSE is returned the connection is aborted and a Release Complete PDU is sent.

The default behaviour checks for hH245Address field and if present starts the separate H245 channel, if successful or not present it returns TRUE.

Parameters:

pdu

Received Facility PDU

Definition at line 1919 of file h323.cxx.

Referenced by HandleSignalPDU().

BOOL H323Connection::OnReceivedSignalNotify ( const H323SignalPDU & pdu ) [virtual]

Handle an incoming Q931 Notify PDU. If FALSE is returned the connection is aborted and a Release Complete PDU is sent.

The default behaviour simply returns TRUE.

Parameters:

pdu

Received Notify PDU

Definition at line 2015 of file h323.cxx.

References H225_H323_UU_PDU_h323_message_body::e_notify, H225_H323_UU_PDU::m_h323_message_body, H225_H323_UserInformation::m_h323_uu_pdu, and SetRemoteVersions().

Referenced by HandleSignalPDU().

BOOL H323Connection::OnReceivedSignalStatus ( const H323SignalPDU & pdu ) [virtual]

Handle an incoming Q931 Status PDU. If FALSE is returned the connection is aborted and a Release Complete PDU is sent.

The default behaviour simply returns TRUE.

Parameters:

pdu

Received Status PDU

Definition at line 2025 of file h323.cxx.

References H225_H323_UU_PDU_h323_message_body::e_status, H225_H323_UU_PDU::m_h323_message_body, H225_H323_UserInformation::m_h323_uu_pdu, and SetRemoteVersions().

Referenced by HandleSignalPDU().

BOOL H323Connection::OnReceivedStatusEnquiry ( const H323SignalPDU & pdu ) [virtual]

Handle an incoming Q931 Status Enquiry PDU. If FALSE is returned the connection is aborted and a Release Complete PDU is sent.

The default behaviour sends a Q931 Status PDU back.

Parameters:

pdu

Received Status Enquiry PDU

Definition at line 2035 of file h323.cxx.

References H323SignalPDU::BuildStatus(), H225_H323_UU_PDU_h323_message_body::e_statusInquiry, H225_H323_UU_PDU::m_h323_message_body, H225_H323_UserInformation::m_h323_uu_pdu, SetRemoteVersions(), signallingChannel, and H323SignalPDU::Write().

Referenced by HandleSignalPDU().

void H323Connection::OnReceivedReleaseComplete ( const H323SignalPDU & pdu ) [virtual]

Handle an incoming Q931 Release Complete PDU. The default behaviour calls Clear() using reason code based on the Release Complete Cause field and the current connection state.

Parameters:

pdu

Received Release Complete PDU

Definition at line 2048 of file h323.cxx.

References AwaitingLocalAnswer, callEndReason, callEndTime, ClearCall(), H4502Handler::e_ctAwaitSetupResponse, H225_ReleaseCompleteReason::e_facilityCallDeflection, H4501_GeneralErrorList::e_notAvailable, H225_H323_UU_PDU_h323_message_body::e_releaseComplete, H460_MessageType::e_releaseComplete, EndedByCallerAbort, EndedByCallForwarded, EndedByRefusal, EndedByRemoteUser, endSessionReceived, Q931::ErrorInCauseIE, EstablishedConnection, Q931::GetCause(), H323SignalPDU::GetQ931(), H4502Handler::GetState(), h4502handler, H4502Handler::IsctTimerRunning(), H225_H323_UU_PDU::m_h323_message_body, H225_H323_UserInformation::m_h323_uu_pdu, H225_ReleaseComplete_UUIE::m_protocolIdentifier, H225_ReleaseComplete_UUIE::m_reason, NumCallEndReasons, H4502Handler::OnReceivedSetupReturnError(), q931Cause, and SetRemoteVersions().

Referenced by HandleSignalPDU().

virtual BOOL H323Connection::OnUnknownSignalPDU ( const H323SignalPDU & pdu ) [virtual]

This function is called from the HandleSignallingChannel() function for unhandled PDU types.

If FALSE is returned the connection is aborted and a Release Complete PDU is sent. The default behaviour returns TRUE.

Parameters:

pdu

Received PDU

Referenced by HandleSignalPDU().

BOOL H323Connection::OnIncomingCall	(	const H323SignalPDU &	setupPDU,
		H323SignalPDU &	alertingPDU
	)			`[virtual]`

Call back for incoming call. This function is called from the OnReceivedSignalSetup() function before it sends the Alerting PDU. It gives an opportunity for an application to alter the reply before transmission to the other endpoint.

If FALSE is returned the connection is aborted and a Release Complete PDU is sent.

The default behaviour calls the endpoint function of the same name.

Parameters:

setupPDU	Received setup PDU
alertingPDU	Alerting PDU to send

Definition at line 2109 of file h323.cxx.

References alertingPDU, endpoint, and H323EndPoint::OnIncomingCall().

Referenced by H323EndPoint::OnIncomingCall(), and OnReceivedSignalSetup().

BOOL H323Connection::OnIncomingCall	(	const H323SignalPDU &	setupPDU,
		H323SignalPDU &	alertingPDU,
		CallEndReason &	reason
	)			`[virtual]`

Parameters:

setupPDU	Received setup PDU
alertingPDU	Alerting PDU to send
reason	reason for call refusal, if returned false

Definition at line 2102 of file h323.cxx.

References alertingPDU, endpoint, and H323EndPoint::OnIncomingCall().

BOOL H323Connection::ForwardCall ( const PString & forwardParty ) [virtual]

Forward incoming call to specified address. This would typically be called from within the OnIncomingCall() function when an application wishes to redirct an unwanted incoming call.

The return value is TRUE if the call is to be forwarded, FALSE otherwise. Note that if the call is forwarded the current connection is cleared with the ended call code of EndedByCallForwarded.

Parameters:

forwardParty

Party to forward call to.

Definition at line 2116 of file h323.cxx.

References H323SignalPDU::BuildFacility(), H225_Facility_UUIE::e_alternativeAddress, H225_Facility_UUIE::e_alternativeAliasAddress, H225_FacilityReason::e_callForwarded, endpoint, H225_Facility_UUIE::m_alternativeAddress, H225_Facility_UUIE::m_alternativeAliasAddress, H323EndPoint::ParsePartyName(), H323EndPoint::ResolveCallParty(), H323TransportAddress::SetPDU(), and WriteSignalPDU().

void H323Connection::TransferCall	(	const PString &	remoteParty,
		const PString &	callIdentity = `PString::Empty()`
	)

Initiate the transfer of an existing call (connection) to a new remote party using H.450.2. This sends a Call Transfer Initiate Invoke message from the A-Party (transferring endpoint) to the B-Party (transferred endpoint).

Parameters:

remoteParty	Remote party to transfer the existing call to
callIdentity	Call Identity of secondary call if present

void H323Connection::ConsultationTransfer ( const PString & primaryCallToken )

Transfer the call through consultation so the remote party in the primary call is connected to the called party in the second call using H.450.2. This sends a Call Transfer Identify Invoke message from the A-Party (transferring endpoint) to the C-Party (transferred-to endpoint).

Parameters:

primaryCallToken

Primary call

virtual void H323Connection::OnReceivedInitiateReturnError ( ) [virtual]

Called from H.450 OnReceivedInitiateReturnError Error in Transfer

Referenced by H4502Handler::OnReceivedInitiateReturnError().

virtual void H323Connection::HandleConsultationTransfer	(	const PString &	callIdentity,
		H323Connection &	incoming
	)			`[virtual]`

Handle the reception of a callTransferSetupInvoke APDU whilst a secondary call exists. This method checks whether the secondary call is still waiting for a callTransferSetupInvoke APDU and proceeds to clear the call if the call identies match. This is an internal function and it is not expected the user will call it directly.

Parameters:

incoming

Call Identity of secondary call received in SETUP Message. Connection upon which SETUP PDU was received.

Referenced by H4502Handler::OnReceivedCallTransferSetup().

BOOL H323Connection::IsTransferringCall ( ) const

Determine whether this connection is being transferred.

BOOL H323Connection::IsTransferredCall ( ) const

Determine whether this connection is the result of a transferred call.

virtual void H323Connection::HandleTransferCall	(	const PString &	token,
		const PString &	identity
	)			`[virtual]`

Handle the transfer of an existing connection to a new remote. This is an internal function and it is not expected the user will call it directly.

Referenced by H323EndPoint::InternalMakeCall().

int H323Connection::GetCallTransferInvokeId ( )

Get transfer invoke ID dureing trasfer. This is an internal function and it is not expected the user will call it directly.

virtual void H323Connection::HandleCallTransferFailure ( const int returnError ) [virtual]

Handle the failure of a call transfer operation at the Transferred Endpoint. This method is used to handle the following transfer failure cases that can occur at the Transferred Endpoint. The cases are: Reception of an Admission Reject Reception of a callTransferSetup return error APDU. Expiry of Call Transfer timer CT-T4.

Parameters:

returnError

Failure reason code

Referenced by H4502Handler::onReceivedAdmissionReject(), and H4502Handler::OnReceivedSetupReturnError().

void H323Connection::SetAssociatedCallToken ( const PString & token )

Store the passed token on the current connection's H4502Handler. This is an internal function and it is not expected the user will call it directly.

Parameters:

token

Associated token

Referenced by H4502Handler::OnReceivedIdentifyReturnResult().

virtual void H323Connection::OnConsultationTransferSuccess ( H323Connection & secondaryCall ) [virtual]

Callback to indicate a successful transfer through consultation. The paramter passed is a reference to the existing connection between the Transferring endpoint and Transferred-to endpoint.

Parameters:

secondaryCall

Secondary call for consultation

Referenced by H4502Handler::HandleConsultationTransfer().

virtual void H323Connection::SetCallLinkage ( H225_AdmissionRequest & arq ) [virtual]

Set the call linkage associated with the current call. This is used to include the callToken which is requesting this connection. ie. Call Transfer. This information can be used for billing systems to correctly charge the correct party for Transferred or forwarded calls.

Parameters:

arq

Admission Request PDU

Referenced by H323Gatekeeper::AdmissionRequest().

virtual void H323Connection::GetCallLinkage ( const H225_AdmissionRequest & arq ) [virtual]

Set the call linkage associated with the current call. This is used to detect the callToken which has requesting this connection. ie. Call Transfer. This information can be used for billing systems to correctly charge the correct party for Transferred or forwarded calls.

Parameters:

arq

Admission Request PDU

BOOL H323Connection::GetRedirectingNumber	(	PString &	originalCalledNr,
		PString &	lastDivertingNr,
		int &	divCounter,
		int &	originaldivReason,
		int &	divReason
	)

Retrieves the redirecting number(s) and additional call diversion information (div. counter and div. reason) as of an incoming redirected call, currently only according to H.450.3 call diversion supplementary service

void H323Connection::HoldCall ( BOOL localHold )

Place the call on hold, suspending all media channels (H.450.4). Note it is the responsibility of the application layer to delete the MOH Channel if music on hold is provided to the remote endpoint. So far only Local Hold has been implemented.

Parameters:

localHold

true for Local Hold, false for Remote Hold

void H323Connection::RetrieveCall ( )

Retrieve the call from hold, activating all media channels (H.450.4). This method examines the call hold state and performs the necessary actions required to retrieve a Near-end or Remote-end call on hold. NOTE: Only Local Hold is implemented so far.

void H323Connection::SetHoldMedia ( PChannel * audioChannel )

Set the alternative Audio media channel. This channel can be used to provide Media On Hold (MOH) for a near end call hold operation or to provide Recorded Voice Anouncements (RVAs). If this method is not called before a call hold operation is attempted, no Audio media on hold will be provided for the held endpoint.

void H323Connection::SetVideoHoldMedia ( PChannel * videoChannel )

Set the alternative Video media channel. This channel can be used to provide Video On Hold (VOH) for a near end call hold operation or to provide a fake or onhold video. If this method is not called before a call hold operation is attempted, no Video media on hold will be provided for the held endpoint.

virtual PChannel* H323Connection::OnCallHold	(	BOOL	IsEncoder,
		unsigned	sessionId,
		unsigned	bufferSize,
		PChannel *	channel
	)			`[virtual]`

CallBack when Call is put on hold. This allows the device to release the Local Input device to be used for another active connection

Parameters:

sessionId	* Direction
bufferSize	* Session Id
channel	* Size of each sound buffer (Audio)

virtual PChannel* H323Connection::OnCallRetrieve	(	BOOL	IsEncoder,
		unsigned	sessionId,
		unsigned	bufferSize,
		PChannel *	channel
	)			`[virtual]`

* Channel being Held

CallBack when call is about to be retrieved. This allows the Local Input device to be reattached to the Held Channel.

Parameters:

sessionId	* Direction
bufferSize	* Session Id
channel	* Size of each sound buffer (Audio)

BOOL H323Connection::IsMediaOnHold ( ) const

* Channel being Held

Determine if Meadia On Hold is enabled.

BOOL H323Connection::IsLocalHold ( ) const

Determine if held.

BOOL H323Connection::IsRemoteHold ( ) const

Determine if held.

BOOL H323Connection::IsCallOnHold ( ) const

Determine if the current call is held or in the process of being held.

virtual void H323Connection::IntrudeCall ( unsigned capabilityLevel ) [virtual]

Begin a call intrusion request. Calls h45011handler->IntrudeCall where SS pdu is added to Call Setup message.

Referenced by H323EndPoint::InternalMakeCall().

virtual void H323Connection::HandleIntrudeCall	(	const PString &	token,
		const PString &	identity
	)			`[virtual]`

Handle an incoming call instrusion request. Calls h45011handler->AwaitSetupResponse where we set Handler state to CI-Wait-Ack

Referenced by H323EndPoint::InternalMakeCall().

void H323Connection::SetCallIntrusion ( ) [inline]

Set flag indicating call intrusion. Used to set a flag when intrusion occurs and to determine if connection is created for Call Intrusion. This flag is used when we should decide whether to Answer the call or to Close it.

Definition at line 1244 of file h323con.h.

References isCallIntrusion.

Referenced by H45011Handler::OnReceivedCallIntrusionForcedRelease().

unsigned H323Connection::GetLocalCallIntrusionProtectionLevel ( ) [inline]

Get Call Intrusion Protection Level of the local endpoint.

Definition at line 1250 of file h323con.h.

References callIntrusionProtectionLevel.

virtual BOOL H323Connection::GetRemoteCallIntrusionProtectionLevel	(	const PString &	callToken,
		unsigned	callIntrusionProtectionLevel
	)			`[virtual]`

Get Call Intrusion Protection Level of other endpoints that we are in connection with.

void H323Connection::SendCallWaitingIndication ( const unsigned nbOfAddWaitingCalls = 0 )

Send a Call Waiting indication message to the remote endpoint using H.450.6. The second paramter is used to indicate to the calling user how many additional users are "camped on" the called user. A value of zero indicates to the calling user that he/she is the only user attempting to reach the busy called user.

Parameters:

nbOfAddWaitingCalls

number of additional waiting calls at the served user

H323Connection::AnswerCallResponse H323Connection::OnAnswerCall	(	const PString &	callerName,
		const H323SignalPDU &	setupPDU,
		H323SignalPDU &	connectPDU
	)			`[virtual]`

Call back for answering an incoming call. This function is used for an application to control the answering of incoming calls. It is usually used to indicate the immediate action to be taken in answering the call.

It is called from the OnReceivedSignalSetup() function before it sends the Alerting or Connect PDUs. It also gives an opportunity for an application to alter the Connect PDU reply before transmission to the remote endpoint.

If AnswerCallNow is returned then the H.323 protocol proceeds with the connection. If AnswerCallDenied is returned the connection is aborted and a Release Complete PDU is sent. If AnswerCallPending is returned then the Alerting PDU is sent and the protocol negotiations are paused until the AnsweringCall() function is called. Finally, if AnswerCallDeferred is returned then no Alerting PDU is sent, but the system still waits as in the AnswerCallPending response.

Note this function should not block for any length of time. If the decision to answer the call may take some time eg waiting for a user to pick up the phone, then AnswerCallPending or AnswerCallDeferred should be returned.

The default behaviour calls the endpoint function of the same name which in turn will return AnswerCallNow.

Parameters:

callerName	Name of caller
setupPDU	Received setup PDU
connectPDU	Connect PDU to send.

Definition at line 2152 of file h323.cxx.

References connectPDU, endpoint, and H323EndPoint::OnAnswerCall().

Referenced by OnReceivedSignalSetup().

void H323Connection::AnsweringCall ( AnswerCallResponse response )

Indicate the result of answering an incoming call. This should only be called if the OnAnswerCall() callback function has returned a AnswerCallPending or AnswerCallDeferred response.

Note sending further AnswerCallPending responses via this function will have the result of an Alerting PDU being sent to the remote endpoint. In this way multiple Alerting PDUs may be sent.

Sending a AnswerCallDeferred response would have no effect.

Parameters:

response

Answer response to incoming call

Definition at line 2160 of file h323.cxx.

References alertingPDU, alertingTime, AnswerCallAlertWithMedia, AnswerCallDeferredWithMedia, AnswerCallDenied, AnswerCallDeniedByInvalidCID, AnswerCallNow, AnswerCallPending, H450xDispatcher::AttachToAlerting(), H450xDispatcher::AttachToConnect(), H323SignalPDU::BuildFacility(), H323SignalPDU::BuildProgress(), ClearCall(), connectedTime, connectPDU, controlChannel, H225_Connect_UUIE::e_fastConnectRefused, H225_Alerting_UUIE::e_fastConnectRefused, H225_Connect_UUIE::e_fastStart, H225_Alerting_UUIE::e_fastStart, H225_Progress_UUIE::e_fastStart, H225_Connect_UUIE::e_h245Address, H225_Alerting_UUIE::e_h245Address, H225_Facility_UUIE::e_h245Address, H225_FacilityReason::e_startH245, earlyStart, EndedByAnswerDenied, EndedByInvalidConferenceID, FastStartDisabled, fastStartState, h245Tunneling, h245TunnelTxPDU, h450dispatcher, HandleTunnelPDU(), HasExecutedSignalConnect, InternalEstablishedConnectionCheck(), Lock(), H225_Connect_UUIE::m_fastStart, H225_Alerting_UUIE::m_fastStart, H225_Progress_UUIE::m_fastStart, H225_Connect_UUIE::m_h245Address, H225_Alerting_UUIE::m_h245Address, H225_Facility_UUIE::m_h245Address, H225_H323_UU_PDU::m_h323_message_body, H225_H323_UserInformation::m_h323_uu_pdu, mediaWaitForConnect, SendFastStartAcknowledge(), H323Transport::SetUpTransportPDU(), ShuttingDownConnection, StartControlChannel(), StartControlNegotiations(), Unlock(), and WriteSignalPDU().

Referenced by H45011Handler::OnReceivedCIGetCIPLResult(), and OnReceivedSignalSetup().

H323Connection::CallEndReason H323Connection::SendSignalSetup	(	const PString &	alias,
		const H323TransportAddress &	address
	)			`[virtual]`

Send first PDU in signalling channel. This function does the signalling handshaking for establishing a connection to a remote endpoint. The transport (TCP/IP) for the signalling channel is assumed to be already created. This function will then do the SetRemoteAddress() and Connect() calls o establish the transport.

Returns the error code for the call failure reason or NumCallEndReasons if the call was successful to that point in the protocol.

Parameters:

alias	Name of remote party
address	Address of destination

Definition at line 2336 of file h323.cxx.

References H323Gatekeeper::AdmissionResponse::accessTokenData, addAccessTokenToSetup, H323Gatekeeper::AdmissionRequest(), H323Gatekeeper::AdmissionResponse::aliasAddresses, H450xDispatcher::AttachToSetup(), AwaitingGatekeeperAdmission, AwaitingSignalConnect, AwaitingTransportConnect, H323SignalPDU::BuildSetup(), H323Transport::Connect(), digitsWaitFlag, doH245inSETUP, H323Capability::e_Audio, H225_AdmissionRejectReason::e_calledPartyNotRegistered, H225_Setup_UUIE_conferenceGoal::e_create, H225_Setup_UUIE::e_destCallSignalAddress, H225_Setup_UUIE::e_destinationAddress, H225_Setup_UUIE::e_endpointIdentifier, H225_Setup_UUIE::e_fastStart, H225_H323_UU_PDU::e_h245Control, H225_AdmissionRejectReason::e_incompleteAddress, H225_AdmissionRejectReason::e_invalidPermission, H235_ClearToken::e_nonStandard, H4501_GeneralErrorList::e_notAvailable, H225_Setup_UUIE::e_parallelH245Control, H225_AdmissionRejectReason::e_requestDenied, H225_AdmissionRejectReason::e_resourceUnavailable, H225_AdmissionRejectReason::e_securityDenial, H225_Setup_UUIE::e_sourceCallSignalAddress, H225_Setup_UUIE::e_tokens, H323Capability::e_UserInput, EndedByCallerAbort, EndedByConnectFail, EndedByGatekeeper, EndedByHostOffline, EndedByNoAccept, EndedByNoBandwidth, EndedByNoEndPoint, EndedByNoUser, EndedByRemoteBusy, EndedBySecurityDenial, EndedByTransportFail, EndedByUnreachable, endpoint, fastStartChannels, FastStartDisabled, fastStartState, gatekeeperRouted, H323Gatekeeper::AdmissionResponse::gatekeeperRouted, Q931::GetCalledPartyNumber(), H323Gatekeeper::GetEndpointIdentifier(), H323EndPoint::GetGatekeeper(), H323SignalPDU::GetQ931(), H323EndPoint::GetSignallingChannelCallTimeout(), H323Capabilities::GetSize(), gkAccessTokenData, gkAccessTokenOID, h245Tunneling, h245TunnelTxPDU, h4502handler, h450dispatcher, H323SignalPDU::InsertCryptoTokensSetup(), H323SignalPDU::InsertH460Setup(), H323Channel::IsReceiver, lastPDUWasH245inSETUP, localCapabilities, Lock(), H225_Setup_UUIE::m_conferenceGoal, H225_Setup_UUIE::m_destCallSignalAddress, H225_Setup_UUIE::m_destinationAddress, H225_Setup_UUIE::m_endpointIdentifier, H225_Setup_UUIE::m_fastStart, H225_H323_UU_PDU::m_h245Control, H225_H323_UserInformation::m_h323_uu_pdu, H225_Setup_UUIE::m_parallelH245Control, H225_Setup_UUIE::m_sourceCallSignalAddress, H225_Setup_UUIE::m_tokens, mustSendDRQ, NoConnectionActive, NumCallEndReasons, OnInsufficientDigits(), H4502Handler::onReceivedAdmissionReject(), OnSelectLogicalChannels(), OnSendSignalSetup(), OnSetLocalCapabilities(), H323Gatekeeper::AdmissionResponse::rejectReason, remoteAliasNames, remotePartyAddress, remotePartyName, remotePartyNumber, Q931::SetBearerCapabilities(), H323SignalPDU::SetQ931Fields(), H323Transport::SetRemoteAddress(), setupTime, H323Transport::SetUpTransportPDU(), signallingChannel, StartControlNegotiations(), Q931::TransferUnrestrictedDigital, H323Gatekeeper::AdmissionResponse::transportAddress, Unlock(), and WriteSignalPDU().

Referenced by H225CallThread::Main().

BOOL H323Connection::OnSendSignalSetup ( H323SignalPDU & setupPDU ) [virtual]

Adjust setup PDU being sent on initialisation of signal channel. This function is called from the SendSignalSetup() function before it sends the Setup PDU. It gives an opportunity for an application to alter the request before transmission to the other endpoint.

The default behaviour simply returns TRUE. Note that this is usually overridden by the transport dependent descendent class, eg the H323ConnectionTCP descendent fills in the destCallSignalAddress field with the TCP/IP data. Therefore if you override this in your application make sure you call the ancestor function.

Parameters:

setupPDU

Setup PDU to send

Definition at line 2592 of file h323.cxx.

Referenced by SendSignalSetup().

BOOL H323Connection::OnSendCallProceeding ( H323SignalPDU & callProceedingPDU ) [virtual]

Adjust call proceeding PDU being sent. This function is called from the OnReceivedSignalSetup() function before it sends the Call Proceeding PDU. It gives an opportunity for an application to alter the request before transmission to the other endpoint. If this function returns FALSE then the Call Proceeding PDU is not sent at all.

The default behaviour simply returns TRUE.

Parameters:

callProceedingPDU

Call Proceeding PDU to send

Definition at line 2598 of file h323.cxx.

Referenced by OnReceivedSignalSetup().

BOOL H323Connection::OnSendReleaseComplete ( H323SignalPDU & releaseCompletePDU ) [virtual]

Call back for Release Complete being sent. This allows an application to add things to the release complete before it is sent to the remote endpoint.

Returning FALSE will prevent the release complete from being sent. Note that this would be very unusual as this is called when the connection is being cleaned up. There will be no second chance to send the PDU and it must be sent.

The default behaviour simply returns TRUE.

Parameters:

releaseCompletePDU

Release Complete PDU to send

Definition at line 2604 of file h323.cxx.

Referenced by SetCallEndReason().

BOOL H323Connection::OnAlerting	(	const H323SignalPDU &	alertingPDU,
		const PString &	user
	)			`[virtual]`

Call back for remote party being alerted. This function is called from the SendSignalSetup() function after it receives the optional Alerting PDU from the remote endpoint. That is when the remote "phone" is "ringing".

If FALSE is returned the connection is aborted and a Release Complete PDU is sent.

The default behaviour calls the endpoint function of the same name.

Parameters:

alertingPDU	Received Alerting PDU
user	Username of remote endpoint

Definition at line 2610 of file h323.cxx.

References alertingPDU, endpoint, and H323EndPoint::OnAlerting().

Referenced by OnReceivedAlerting().

BOOL H323Connection::OnInsufficientDigits ( ) [virtual]

This function is called when insufficient digits have been entered. This supports overlapped dialling so that a call can begin when it is not known how many more digits are to be entered in a phone number.

It is expected that the application will override this function. It should be noted that the application should not block in the function but only indicate to whatever other thread is gathering digits that more are required and that thread should call SendMoreDigits().

If FALSE is returned the connection is aborted and a Release Complete PDU is sent.

The default behaviour simply returns FALSE.

Definition at line 2617 of file h323.cxx.

Referenced by OnReceivedSignalSetupAck(), and SendSignalSetup().

void H323Connection::SendMoreDigits ( const PString & digits ) [virtual]

This function is called when sufficient digits have been entered. This supports overlapped dialling so that a call can begin when it is not known how many more digits are to be entered in a phone number.

The digits parameter is appended to the existing remoteNumber member variable and the call is retried.

If FALSE is returned the connection is aborted and a Release Complete PDU is sent.

The default behaviour simply returns TRUE.

Parameters:

digits

Extra digits

Definition at line 2623 of file h323.cxx.

References AwaitingGatekeeperAdmission, H323SignalPDU::BuildInformation(), ClearCall(), digitsWaitFlag, EndedByTransportFail, H323SignalPDU::GetQ931(), remotePartyName, remotePartyNumber, Q931::SetCalledPartyNumber(), and WriteSignalPDU().

BOOL H323Connection::OnOutgoingCall ( const H323SignalPDU & connectPDU ) [virtual]

This function is called from the SendSignalSetup() function after it receives the Connect PDU from the remote endpoint, but before it attempts to open the control channel.

If FALSE is returned the connection is aborted and a Release Complete PDU is sent.

The default behaviour calls H323EndPoint::OnOutgoingCall

Parameters:

connectPDU

Received Connect PDU

Definition at line 2638 of file h323.cxx.

References connectPDU, endpoint, and H323EndPoint::OnOutgoingCall().

Referenced by OnReceivedSignalConnect().

BOOL H323Connection::SendFastStartAcknowledge ( H225_ArrayOf_PASN_OctetString & array ) [virtual]

Send an the acknowldege of a fast start. This function is called when the fast start channels provided to this connection by the original SETUP PDU have been selected and opened and need to be sent back to the remote endpoint.

If FALSE is returned then no fast start has been acknowledged, possibly due to no common codec in fast start request.

The default behaviour uses OnSelectLogicalChannels() to find a pair of channels and adds then to the provided PDU.

Parameters:

array

Array of H245_OpenLogicalChannel

Definition at line 2643 of file h323.cxx.

References H245NegLogicalChannels::Add(), FastStartAcknowledged, fastStartChannels, FastStartDisabled, FastStartResponse, fastStartState, H323Channel::IsTransmitter, logicalChannels, and OnSelectLogicalChannels().

Referenced by AnsweringCall().

BOOL H323Connection::HandleFastStartAcknowledge ( const H225_ArrayOf_PASN_OctetString & array ) [virtual]

Handle the acknowldege of a fast start. This function is called from one of a number of functions after it receives a PDU from the remote endpoint that has a fastStart field. It is in response to a request for a fast strart from the local endpoint.

If FALSE is returned the connection is aborted and a Release Complete PDU is sent.

The default behaviour parses the provided array and starts the channels acknowledged in it.

Parameters:

array

Array of H245_OpenLogicalChannel

Definition at line 2689 of file h323.cxx.

References H245NegLogicalChannels::Add(), H323Capabilities::Copy(), H245_OpenLogicalChannel::e_reverseLogicalChannelParameters, FastStartAcknowledged, fastStartChannels, fastStartState, H323Capabilities::FindCapability(), H323Channel::IsReceiver, localCapabilities, logicalChannels, OnCreateLogicalChannel(), remoteCapabilities, reverseMediaOpenTime, and H323Capabilities::SetCapability().

Referenced by OnReceivedAlerting(), OnReceivedCallProceeding(), OnReceivedFacility(), OnReceivedProgress(), and OnReceivedSignalConnect().

BOOL H323Connection::StartControlChannel ( ) [virtual]

Start a separate H245 channel. This function is called from one of a number of functions when it needs to create the h245 channel for the remote endpoint to connect back to.

If FALSE is returned the connection is aborted and a Release Complete PDU is sent.

Definition at line 2782 of file h323.cxx.

References ClearCall(), controlChannel, H323Transport::CreateControlChannel(), EndedByTransportFail, signallingChannel, and H323Transport::StartControlChannel().

Referenced by AnsweringCall(), OnReceivedAlerting(), OnReceivedCallProceeding(), OnReceivedFacility(), OnReceivedProgress(), OnReceivedSignalConnect(), and OnReceivedSignalSetup().

BOOL H323Connection::StartControlChannel ( const H225_TransportAddress & h245Address ) [virtual]

Start a separate H245 channel. This function is called from one of a number of functions after it receives a PDU from the remote endpoint that has a h245Address field.

If FALSE is returned the connection is aborted and a Release Complete PDU is sent.

The default behaviour checks to see if it is a known transport and creates a corresponding H323Transport decendent for the control channel.

Parameters:

h245Address

H245 address

Definition at line 2799 of file h323.cxx.

References H323Transport::Connect(), controlChannel, H225_TransportAddress::e_ip6Address, H225_TransportAddress::e_ipAddress, endpoint, H323Transport::SetRemoteAddress(), and H323Transport::StartControlChannel().

BOOL H323Connection::WriteControlPDU ( const H323ControlPDU & pdu )

Write a PDU to the control channel. If there is no control channel open then this will tunnel the PDU into the signalling channel.

Definition at line 2842 of file h323.cxx.

References H323SignalPDU::BuildFacility(), controlChannel, H225_H323_UU_PDU::e_h245Control, H323Transport::GetLocalAddress(), H323Transport::GetRemoteAddress(), h245Tunneling, h245TunnelTxPDU, H225_H323_UU_PDU::m_h245Control, H225_H323_UserInformation::m_h323_uu_pdu, H323Transport::WritePDU(), and WriteSignalPDU().

Referenced by H245NegLogicalChannel::CloseWhileLocked(), H245NegMasterSlaveDetermination::HandleAck(), H245NegLogicalChannel::HandleClose(), H245NegTerminalCapabilitySet::HandleIncoming(), H245NegMasterSlaveDetermination::HandleIncoming(), H245NegLogicalChannel::HandleOpen(), H245NegLogicalChannel::HandleOpenAck(), H245NegRoundTripDelay::HandleRequest(), H245NegRequestMode::HandleRequest(), H245NegLogicalChannel::HandleRequestClose(), H245NegRequestMode::HandleTimeout(), H245NegLogicalChannel::HandleTimeout(), H245NegTerminalCapabilitySet::HandleTimeout(), H245NegMasterSlaveDetermination::HandleTimeout(), OnUnknownControlPDU(), H245NegLogicalChannel::OpenWhileLocked(), H245NegMasterSlaveDetermination::Restart(), SendLogicalChannelMiscCommand(), SendUserInputIndication(), SendUserInputIndicationString(), SendUserInputIndicationTone(), SetCallEndReason(), H245NegTerminalCapabilitySet::Start(), H245NegRoundTripDelay::StartRequest(), and H245NegRequestMode::StartRequest().

BOOL H323Connection::StartControlNegotiations ( BOOL renegotiate = FALSE ) [virtual]

Start control channel negotiations.

Parameters:

renegotiate

Force renogotiation of TCS/MSD

Definition at line 2888 of file h323.cxx.

References capabilityExchangeProcedure, endSessionNeeded, HasExecutedSignalConnect, masterSlaveDeterminationProcedure, H245NegMasterSlaveDetermination::Start(), and H245NegTerminalCapabilitySet::Start().

Referenced by AnsweringCall(), OnReceivedSignalConnect(), SendSignalSetup(), and StartHandleControlChannel().

void H323Connection::HandleControlChannel ( ) [virtual]

Handle reading data on the control channel.

Definition at line 2940 of file h323.cxx.

References controlChannel, EndHandleControlChannel(), HandleReceivedControlPDU(), MonitorCallStatus(), H323Transport::ReadPDU(), and StartHandleControlChannel().

Referenced by H245TransportThread::Main().

BOOL H323Connection::HandleControlData ( PPER_Stream & strm ) [virtual]

Handle incoming data on the control channel. This decodes the data stream into a PDU and calls HandleControlPDU().

If FALSE is returned the connection is aborted. The default behaviour returns TRUE.

Definition at line 3017 of file h323.cxx.

References controlChannel, H323Transport::GetLocalAddress(), H323Transport::GetRemoteAddress(), HandleControlPDU(), and InternalEstablishedConnectionCheck().

Referenced by HandleReceivedControlPDU(), and HandleTunnelPDU().

BOOL H323Connection::HandleControlPDU ( const H323ControlPDU & pdu ) [virtual]

Handle incoming PDU's on the control channel. Dispatches them to the various virtuals off this class.

If FALSE is returned the connection is aborted. The default behaviour returns TRUE.

Definition at line 3047 of file h323.cxx.

References H245_MultimediaSystemControlMessage::e_command, H245_MultimediaSystemControlMessage::e_indication, H245_MultimediaSystemControlMessage::e_request, H245_MultimediaSystemControlMessage::e_response, OnH245Command(), OnH245Indication(), OnH245Request(), OnH245Response(), and OnUnknownControlPDU().

Referenced by HandleControlData().

BOOL H323Connection::OnUnknownControlPDU ( const H323ControlPDU & pdu ) [virtual]

This function is called from the HandleControlPDU() function for unhandled PDU types.

If FALSE is returned the connection is aborted and a Release Complete PDU is sent. The default behaviour returns TRUE.

The default behaviour send a FunctioNotUnderstood indication back to the sender, and returns TRUE to continue operation.

Parameters:

pdu

Received PDU

Definition at line 3067 of file h323.cxx.

References H323ControlPDU::BuildFunctionNotUnderstood(), and WriteControlPDU().

Referenced by HandleControlPDU(), OnH245Command(), OnH245Request(), and OnH245Response().

BOOL H323Connection::OnH245Request ( const H323ControlPDU & pdu ) [virtual]

Handle incoming request PDU's on the control channel. Dispatches them to the various virtuals off this class.

Parameters:

pdu

Received PDU

Definition at line 3077 of file h323.cxx.

Referenced by HandleControlPDU().

BOOL H323Connection::OnH245Response ( const H323ControlPDU & pdu ) [virtual]

Handle incoming response PDU's on the control channel. Dispatches them to the various virtuals off this class.

Parameters:

pdu

Received PDU

Definition at line 3126 of file h323.cxx.

Referenced by HandleControlPDU().

BOOL H323Connection::OnH245Command ( const H323ControlPDU & pdu ) [virtual]

Handle incoming command PDU's on the control channel. Dispatches them to the various virtuals off this class.

Parameters:

pdu

Received PDU

Definition at line 3182 of file h323.cxx.

References AwaitingLocalAnswer, ClearCall(), H245_CommandMessage::e_conferenceCommand, H245_CommandMessage::e_endSessionCommand, H245_CommandMessage::e_flowControlCommand, H245_CommandMessage::e_genericCommand, H245_CommandMessage::e_miscellaneousCommand, H245_CommandMessage::e_sendTerminalCapabilitySet, EndedByCallerAbort, EndedByRefusal, EndedByRemoteUser, endSessionNeeded, endSessionReceived, EstablishedConnection, h245command, OnH245_FlowControlCommand(), OnH245_MiscellaneousCommand(), OnH245_SendTerminalCapabilitySet(), OnHandleConferenceCommand(), OnHandleH245GenericMessage(), and OnUnknownControlPDU().

Referenced by HandleControlPDU().

BOOL H323Connection::OnH245Indication ( const H323ControlPDU & pdu ) [virtual]

Handle incoming indication PDU's on the control channel. Dispatches them to the various virtuals off this class.

Parameters:

pdu

Received PDU

Definition at line 3226 of file h323.cxx.

Referenced by HandleControlPDU().

BOOL H323Connection::OnH245_SendTerminalCapabilitySet ( const H245_SendTerminalCapabilitySet & pdu ) [virtual]

Handle H245 command to send terminal capability set.

Parameters:

pdu

Received PDU

Definition at line 3271 of file h323.cxx.

References capabilityExchangeProcedure, H245_SendTerminalCapabilitySet::e_genericRequest, and H245NegTerminalCapabilitySet::Start().

Referenced by OnH245Command().

BOOL H323Connection::OnH245_FlowControlCommand ( const H245_FlowControlCommand & pdu ) [virtual]

Handle H245 command to control flow control. This function calls OnLogicalChannelFlowControl() with the channel and bit rate restriction.

Parameters:

pdu

Received PDU

Definition at line 3282 of file h323.cxx.

References H245_FlowControlCommand_scope::e_logicalChannelNumber, H245_FlowControlCommand_restriction::e_maximumBitRate, H245_FlowControlCommand_scope::e_wholeMultiplex, H245NegLogicalChannels::FindChannel(), logicalChannels, H245_FlowControlCommand::m_restriction, H245_FlowControlCommand::m_scope, and OnLogicalChannelFlowControl().

Referenced by OnH245Command().

BOOL H323Connection::OnH245_MiscellaneousCommand ( const H245_MiscellaneousCommand & pdu ) [virtual]

Handle H245 miscellaneous command. This function passes the miscellaneous command on to the channel defined by the pdu.

Parameters:

pdu

Received PDU

Definition at line 3310 of file h323.cxx.

References H245NegLogicalChannels::FindChannel(), logicalChannels, H245_MiscellaneousCommand::m_logicalChannelNumber, H245_MiscellaneousCommand::m_type, and H323Channel::OnMiscellaneousCommand().

Referenced by OnH245Command().

BOOL H323Connection::OnH245_MiscellaneousIndication ( const H245_MiscellaneousIndication & pdu ) [virtual]

Handle H245 miscellaneous indication. This function passes the miscellaneous indication on to the channel defined by the pdu.

Parameters:

pdu

Received PDU

Definition at line 3324 of file h323.cxx.

References H245NegLogicalChannels::FindChannel(), logicalChannels, H245_MiscellaneousIndication::m_logicalChannelNumber, H245_MiscellaneousIndication::m_type, and H323Channel::OnMiscellaneousIndication().

Referenced by OnH245Indication().

BOOL H323Connection::OnH245_JitterIndication ( const H245_JitterIndication & pdu ) [virtual]

Handle H245 indication of received jitter. This function calls OnLogicalChannelJitter() with the channel and estimated jitter.

Parameters:

pdu

Received PDU

Definition at line 3338 of file h323.cxx.

Referenced by OnH245Indication().

BOOL H323Connection::OnControlProtocolError	(	ControlProtocolErrors	errorSource,
		const void *	errorData = `NULL`
	)			`[virtual]`

This function is called from the HandleControlPDU() function or any of its sub-functions for protocol errors, eg unhandled PDU types.

The errorData field may be a string or PDU or some other data depending on the value of the errorSource parameter. These are: e_UnhandledPDU &H323ControlPDU e_MasterSlaveDetermination const char *

If FALSE is returned the connection is aborted. The default behaviour returns TRUE.

Parameters:

errorSource	Source of the proptoerror
errorData	Data associated with error

Definition at line 3689 of file h323.cxx.

void H323Connection::OnSendCapabilitySet ( H245_TerminalCapabilitySet & pdu ) [virtual]

This function is called from the HandleControlPDU() function when it is about to send the Capabilities Set to the remote endpoint. This gives the application an oppurtunity to alter the PDU to be sent.

The default behaviour will make "adjustments" for compatibility with some broken remote endpoints.

Parameters:

pdu

PDU to send

Definition at line 3710 of file h323.cxx.

References callAnswered, localCapabilities, and rfc2833handler.

Referenced by H245NegTerminalCapabilitySet::Start().

BOOL H323Connection::OnReceivedCapabilitySet	(	const H323Capabilities &	remoteCaps,
		const H245_MultiplexCapability *	muxCap,
		H245_TerminalCapabilitySetReject &	reject
	)			`[virtual]`

This function is called when the remote endpoint sends its capability set. This gives the application an opportunity to determine what codecs are available and if it supports any of the combinations of codecs.

Note any codec types that are the remote system supports that are not in the codecs list member variable for the endpoint are ignored and not included in the remoteCodecs list.

The default behaviour assigns the table and set to member variables and returns TRUE if the remoteCodecs list is not empty.

Parameters:

remoteCaps	Capability combinations remote supports
muxCap	Transport capability, if present
reject	Rejection PDU (if return FALSE)

Definition at line 3718 of file h323.cxx.

References callAnswered, capabilityExchangeProcedure, H245_MultiplexCapability::e_h2250Capability, H245NegLogicalChannel::GetChannel(), H245NegLogicalChannels::GetNegLogicalChannelAt(), H323Channel::GetNumber(), H245NegLogicalChannels::GetSize(), H323Capabilities::GetSize(), HasExecutedSignalConnect, H245NegTerminalCapabilitySet::HasReceivedCapabilities(), H323ChannelNumber::IsFromRemote(), localCapabilities, logicalChannels, H245_H2250Capability::m_maximumAudioDelayJitter, H323Capabilities::Merge(), remoteCapabilities, remoteMaxAudioDelayJitter, H323Capabilities::RemoveAll(), reverseMediaOpenTime, rfc2833handler, H245NegTerminalCapabilitySet::Start(), and transmitterSidePaused.

Referenced by H245NegTerminalCapabilitySet::HandleIncoming().

void H323Connection::SendCapabilitySet ( BOOL empty ) [virtual]

Send a new capability set.

Parameters:

empty

Send an empty set.

Definition at line 3775 of file h323.cxx.

References capabilityExchangeProcedure, and H245NegTerminalCapabilitySet::Start().

void H323Connection::OnSetLocalCapabilities ( ) [virtual]

Call back to set the local capabilities. This is called just before the capabilties are required when a call is begun. It is called when a SETUP PDU is received or when one is about to be sent, so that the capabilities may be adjusted for correct fast start operation.

The default behaviour does nothing.

Definition at line 3781 of file h323.cxx.

Referenced by OnReceivedSignalSetup(), and SendSignalSetup().

BOOL H323Connection::IsH245Master ( ) const

Return if this H245 connection is a master or slave

Definition at line 3786 of file h323.cxx.

References H245NegMasterSlaveDetermination::IsMaster(), and masterSlaveDeterminationProcedure.

Referenced by H245NegLogicalChannel::HandleOpen().

void H323Connection::StartRoundTripDelay ( )

Start the round trip delay calculation over the control channel.

Definition at line 3792 of file h323.cxx.

References capabilityExchangeProcedure, ClearCall(), EndedByTransportFail, endpoint, H245NegTerminalCapabilitySet::HasSentCapabilities(), H245NegMasterSlaveDetermination::IsDetermined(), H245NegRoundTripDelay::IsRemoteOffline(), Lock(), masterSlaveDeterminationProcedure, roundTripDelayProcedure, H323EndPoint::ShouldClearCallOnRoundTripFail(), H245NegRoundTripDelay::StartRequest(), and Unlock().

Referenced by MonitorCallStatus().

PTimeInterval H323Connection::GetRoundTripDelay ( ) const

Get the round trip delay over the control channel.

Definition at line 3810 of file h323.cxx.

References H245NegRoundTripDelay::GetRoundTripDelay(), and roundTripDelayProcedure.

void H323Connection::OnSelectLogicalChannels ( ) [virtual]

Call back to select logical channels to start.

This function must be defined by the descendent class. It is used to select the logical channels to be opened between the two endpoints. There are three ways in which this may be called: when a "fast start" has been initiated by the local endpoint (via SendSignalSetup() function), when a "fast start" has been requested from the remote endpoint (via the OnReceivedSignalSetup() function) or when the H245 capability set (and master/slave) negotiations have completed (via the OnControlChannelOpen() function.

The function would typically examine several member variable to decide which mode it is being called in and what to do. If fastStartState is FastStartDisabled then non-fast start semantics should be used. The H245 capabilities in the remoteCapabilities members should be examined, and appropriate transmit channels started using OpenLogicalChannel().

If fastStartState is FastStartInitiate, then the local endpoint has initiated a call and is asking the application if fast start semantics are to be used. If so it is expected that the function call OpenLogicalChannel() for all the channels that it wishes to be able to be use. A subset (possibly none!) of these would actually be started when the remote endpoint replies.

If fastStartState is FastStartResponse, then this indicates the remote endpoint is attempting a fast start. The fastStartChannels member contains a list of possible channels from the remote that the local endpoint is to select which to accept. For each accepted channel it simply necessary to call the Start() function on that channel eg fastStartChannels[0].Start();

The default behaviour selects the first codec of each session number that is available. This is according to the order of the capabilities in the remoteCapabilities, the local capability table or of the fastStartChannels list respectively for each of the above scenarios.

Definition at line 3908 of file h323.cxx.

References H323EndPoint::CanAutoStartReceiveFax(), H323EndPoint::CanAutoStartReceiveVideo(), H323EndPoint::CanAutoStartTransmitFax(), H323EndPoint::CanAutoStartTransmitVideo(), RTP_Session::DefaultAudioSessionID, RTP_Session::DefaultFaxSessionID, RTP_Session::DefaultVideoSessionID, endpoint, FastStartInitiate, FastStartResponse, fastStartState, H323Channel::IsReceiver, H323Channel::IsTransmitter, SelectDefaultLogicalChannel(), and SelectFastStartChannels().

Referenced by InternalEstablishedConnectionCheck(), SendFastStartAcknowledge(), and SendSignalSetup().

void H323Connection::SelectDefaultLogicalChannel ( unsigned sessionID ) [virtual]

Select default logical channel for normal start.

Parameters:

sessionID

Session ID to find default logical channel.

Definition at line 3965 of file h323.cxx.

References H323Capabilities::FindCapability(), FindChannel(), H323Capabilities::GetSize(), H323Channel::IsTransmitter, localCapabilities, OpenLogicalChannel(), and remoteCapabilities.

Referenced by OnSelectLogicalChannels().

void H323Connection::SelectFastStartChannels	(	unsigned	sessionID,
		BOOL	transmitter,
		BOOL	receiver
	)			`[virtual]`

Select default logical channel for fast start. Internal function, not for normal use.

Parameters:

sessionID	Session ID to find default logical channel.
transmitter	Whether to open transmitters
receiver	Whether to open receivers

Definition at line 3993 of file h323.cxx.

References H323Capability::GetDefaultSessionID(), H323Capabilities::GetSize(), H323Channel::IsReceiver, H323Channel::IsTransmitter, localCapabilities, and OpenLogicalChannel().

Referenced by OnSelectLogicalChannels().

void H323Connection::DisableFastStart ( )

Disable FastStart on a call by call basis

Definition at line 3987 of file h323.cxx.

References FastStartDisabled, and fastStartState.

BOOL H323Connection::OpenLogicalChannel	(	const H323Capability &	capability,
		unsigned	sessionID,
		H323Channel::Directions	dir
	)			`[virtual]`

Open a new logical channel. This function will open a channel between the endpoints for the specified capability.

If this function is called while there is not yet a conenction established, eg from the OnFastStartLogicalChannels() function, then a "trial" receiver/transmitter channel is created. This channel is not started until the remote enpoint has confirmed that they are to start. Any channels not confirmed are deleted.

If this function is called later in the call sequence, eg from OnSelectLogicalChannels(), then it may only establish a transmit channel, ie fromRemote must be FALSE.

Parameters:

capability	Capability to open channel with
sessionID	Session for the channel
dir	Direction of channel

Definition at line 4016 of file h323.cxx.

References H323Capability::CreateChannel(), FastStartInitiate, FastStartResponse, fastStartState, H245NegLogicalChannels::GetNextChannelNumber(), H323Channel::IsReceiver, logicalChannels, H245NegLogicalChannels::Open(), and H323Channel::SetNumber().

Referenced by H245NegLogicalChannel::HandleRequestClose(), InternalEstablishedConnectionCheck(), OnAcceptModeChange(), OnConflictingLogicalChannel(), OnModeChanged(), SelectDefaultLogicalChannel(), and SelectFastStartChannels().

BOOL H323Connection::OnOpenLogicalChannel	(	const H245_OpenLogicalChannel &	openPDU,
		H245_OpenLogicalChannelAck &	ackPDU,
		unsigned &	errorCode
	)			`[virtual]`

This function is called when the remote endpoint want's to open a new channel.

If the return value is FALSE then the open is rejected using the errorCode as the cause, this would be a value from the enum H245_OpenLogicalChannelReject_cause::Choices.

The default behaviour simply returns TRUE.

Parameters:

openPDU	Received PDU for the channel open
ackPDU	PDU to send for acknowledgement
errorCode	Error to return if refused

Definition at line 4056 of file h323.cxx.

References FastStartDisabled, and fastStartState.

Referenced by H245NegLogicalChannel::HandleOpen().

BOOL H323Connection::OnConflictingLogicalChannel ( H323Channel & channel ) [virtual]

Callback for when a logical channel conflict has occurred. This is called when the remote endpoint, which is a master, rejects our transmitter channel due to a resource conflict. Typically an inability to do asymmetric codecs. The local (slave) endpoint must then try and open a new transmitter channel using the same codec as the receiver that is being opened.

Parameters:

channel

Channel that conflicted

Definition at line 4072 of file h323.cxx.

References H323Channel::CleanUpOnTermination(), CloseLogicalChannelNumber(), H323Capabilities::FindCapability(), FindChannel(), H323Channel::GetCapability(), H323Channel::GetNumber(), H323Channel::GetSessionID(), H323ChannelNumber::IsFromRemote(), H323Channel::IsTransmitter, logicalChannels, H245NegLogicalChannels::Open(), OpenLogicalChannel(), and remoteCapabilities.

Referenced by H245NegLogicalChannel::HandleOpen(), and H245NegLogicalChannel::HandleReject().

H323Channel * H323Connection::CreateLogicalChannel	(	const H245_OpenLogicalChannel &	open,
		BOOL	startingFast,
		unsigned &	errorCode
	)			`[virtual]`

Create a new logical channel object. This is in response to a request from the remote endpoint to open a logical channel.

Parameters:

open	Parameters for opening channel
startingFast	Flag for fast/slow starting.
errorCode	Reason for create failure

Definition at line 4129 of file h323.cxx.

Referenced by DecodeFastStartCaps(), and H245NegLogicalChannel::HandleOpen().

H323Channel * H323Connection::CreateRealTimeLogicalChannel	(	const H323Capability &	capability,
		H323Channel::Directions	dir,
		unsigned	sessionID,
		const H245_H2250LogicalChannelParameters *	param,
		RTP_QOS *	rtpqos = `NULL`
	)			`[virtual]`

Create a new real time logical channel object. This creates a logical channel for handling RTP data. It is primarily used to allow an application to redirect the RTP media streams to other hosts to the local one. In that case it would create an instance of the H323_ExternalRTPChannel class with the appropriate address. eg:

H323Channel * MyConnection::CreateRealTimeLogicalChannel( const H323Capability & capability, H323Channel::Directions dir, unsigned sessionID, const H245_H2250LogicalChannelParameters * param, RTP_QOS * rtpqos) { return new H323_ExternalRTPChannel(*this, capability, dir, sessionID, externalIpAddress, externalPort); }

An application would typically also override the OnStartLogicalChannel() function to obtain from the H323_ExternalRTPChannel instance the address of the remote endpoints media server RTP addresses to complete the setting up of the external RTP stack. eg:

BOOL OnStartLogicalChannel(H323Channel & channel) { H323_ExternalRTPChannel & external = (H323_ExternalRTPChannel &)channel; external.GetRemoteAddress(remoteIpAddress, remotePort); }

Note that the port in the above example is always the data port, the control port is assumed to be data+1.

The default behaviour assures there is an RTP session for the session ID, and if not creates one, then creates a H323_RTPChannel which will do RTP media to the local host.

Parameters:

capability	Capability creating channel
dir	Direction of channel
sessionID	Session ID for RTP channel
param	Parameters for channel
rtpqos	QoS for RTP

Definition at line 4244 of file h323.cxx.

References GetControlChannel(), H245_H2250LogicalChannelParameters::m_mediaControlChannel, H245_H2250LogicalChannelParameters::m_sessionID, H323Transport::SetUpTransportPDU(), H323Transport::UseLocalTSAP, and UseSession().

BOOL H323Connection::OnCreateLogicalChannel	(	const H323Capability &	capability,
		H323Channel::Directions	dir,
		unsigned &	errorCode
	)			`[virtual]`

This function is called when the remote endpoint want's to create a new channel.

If the return value is FALSE then the open is rejected using the errorCode as the cause, this would be a value from the enum H245_OpenLogicalChannelReject_cause::Choices.

The default behaviour checks the capability set for if this capability is allowed to be opened with other channels that may already be open.

Parameters:

capability	Capability for the channel open
dir	Direction of channel
errorCode	Error to return if refused

Definition at line 4269 of file h323.cxx.

References H245_OpenLogicalChannelReject_cause::e_dataTypeALCombinationNotSupported, H245_OpenLogicalChannelReject_cause::e_unspecified, H245NegLogicalChannels::GetChannelAt(), H245NegLogicalChannels::GetSize(), H323Capabilities::IsAllowed(), H323Channel::IsReceiver, localCapabilities, logicalChannels, remoteCapabilities, and ShuttingDownConnection.

Referenced by CreateLogicalChannel(), and HandleFastStartAcknowledge().

BOOL H323Connection::OnStartLogicalChannel ( H323Channel & channel ) [virtual]

Call back function when a logical channel thread begins.

The default behaviour does nothing and returns TRUE.

Parameters:

channel

Channel that has been started.

Definition at line 4320 of file h323.cxx.

References H323Codec::AddFilter(), OpalMediaFormat::DefaultAudioSessionID, detectInBandDTMF, endpoint, H323Channel::GetCodec(), H323Channel::GetNumber(), OpalRFC2833::GetReceiveHandler(), H323Channel::GetSessionID(), OpalRFC2833::GetTransmitHandler(), H323ChannelNumber::IsFromRemote(), H323EndPoint::OnStartLogicalChannel(), and rfc2833handler.

Referenced by H323_RTPChannel::Open(), and H323Channel::Open().

BOOL H323Connection::OpenAudioChannel	(	BOOL	isEncoding,
		unsigned	bufferSize,
		H323AudioCodec &	codec
	)			`[virtual]`

Open a channel for use by an audio codec. The H323AudioCodec class will use this function to open the channel to read/write PCM data.

The default behaviour calls the equivalent function on the endpoint.

Parameters:

isEncoding	Direction of data flow
bufferSize	Size of each sound buffer
codec	codec that is doing the opening

Definition at line 4342 of file h323.cxx.

References endpoint, H323Codec::GetMediaFormat(), OpalMediaFormat::GetTimeUnits(), and H323EndPoint::OpenAudioChannel().

Referenced by H323AudioCodec::Open().

BOOL H323Connection::OpenVideoChannel	(	BOOL	isEncoding,
		H323VideoCodec &	codec
	)			`[virtual]`

Open a channel for use by an video codec. The H323VideoCodec class will use this function to open the channel to read/write image data.

The default behaviour calls the equivalent function on the endpoint.

Parameters:

isEncoding	Direction of data flow
codec	codec doing the opening

Definition at line 4358 of file h323.cxx.

References endpoint, and H323EndPoint::OpenVideoChannel().

virtual BOOL H323Connection::OpenExtendedVideoSession	(	unsigned	role,
		H323ChannelNumber &	channelnum
	)			`[virtual]`

Open an Extended Video Session This will open an Extended Video session with a session id of DefaultExtVideoSessionID. It return the channelnumber of the just opened channel.

Parameters:

role	role 1-Presentation 2-Live
channelnum	Channel number of just opened channel

virtual void H323Connection::OnReceivedExtendedVideoSession	(	unsigned	,
		const H323ChannelNumber &
	)			const `[inline, virtual]`

On Received an Extended Video OLC This indicates the receipt of Extended Video OLC

Definition at line 1935 of file h323con.h.

Referenced by CreateLogicalChannel().

virtual void H323Connection::CloseExtendedVideoSession ( const H323ChannelNumber & num ) [virtual]

Close an Extended Video Session matching the channel number This will close the Extended Video matching the channel number (if open)

Parameters:

num

Channel number to close.

virtual BOOL H323Connection::OpenExtendedVideoChannel	(	BOOL	isEncoding,
		H323VideoCodec &	codec
	)			`[virtual]`

Open a channel for use by an extended video codec. The H323VideoCodec class will use this function to open the channel to read/write image data.

The default behaviour returns FALSE.

Parameters:

isEncoding	Direction of data flow
codec	codec doing the opening

void H323Connection::CloseLogicalChannel	(	unsigned	number,
		BOOL	fromRemote
	)			`[virtual]`

Close a logical channel.

Parameters:

number	Channel number to close.
fromRemote	Indicates close request of remote channel

Definition at line 4365 of file h323.cxx.

References H245NegLogicalChannels::Close(), logicalChannels, and ShuttingDownConnection.

Referenced by CloseLogicalChannelNumber().

void H323Connection::CloseLogicalChannelNumber ( const H323ChannelNumber & number ) [virtual]

Close a logical channel by number.

Parameters:

number

Channel number to close.

Definition at line 4372 of file h323.cxx.

References CloseLogicalChannel(), and H323ChannelNumber::IsFromRemote().

Referenced by H323_T120Channel::HandleChannel(), OnConflictingLogicalChannel(), H323_T38Channel::Receive(), H323_RTPChannel::Receive(), SetBandwidthAvailable(), H323_T38Channel::Transmit(), and H323_RTPChannel::Transmit().

void H323Connection::CloseAllLogicalChannels ( BOOL fromRemote ) [virtual]

Close a logical channel.

Parameters:

fromRemote

Indicates close request of remote channel

Definition at line 4378 of file h323.cxx.

References H245NegLogicalChannel::GetChannel(), H245NegLogicalChannels::GetNegLogicalChannelAt(), H323Channel::GetNumber(), H245NegLogicalChannels::GetSize(), H323ChannelNumber::IsFromRemote(), and logicalChannels.

Referenced by OnAcceptModeChange(), and OnModeChanged().

void H323Connection::OnClosedLogicalChannel ( const H323Channel & channel ) [virtual]

This function is called when the remote endpoint has closed down a logical channel.

The default behaviour does nothing.

Parameters:

channel

Channel that was closed

Definition at line 4395 of file h323.cxx.

References endpoint, and H323EndPoint::OnClosedLogicalChannel().

Referenced by H323Channel::CleanUpOnTermination().

BOOL H323Connection::OnClosingLogicalChannel ( H323Channel & channel ) [virtual]

This function is called when the remote endpoint request the close of a logical channel.

The application may get an opportunity to refuse to close the channel by returning FALSE from this function.

The default behaviour returns TRUE.

Parameters:

channel

Channel that is to be closed

Definition at line 4389 of file h323.cxx.

Referenced by H245NegLogicalChannel::HandleRequestClose().

void H323Connection::OnLogicalChannelFlowControl	(	H323Channel *	channel,
		long	bitRateRestriction
	)			`[virtual]`

This function is called when the remote endpoint wishes to limit the bit rate being sent on a channel.

If channel is NULL, then the bit rate limit applies to all channels.

The default behaviour does nothing if channel is NULL, otherwise calls H323Channel::OnFlowControl() on the specific channel.

Parameters:

channel	Channel that is to be limited
bitRateRestriction	Limit for channel

Definition at line 4401 of file h323.cxx.

References H323Channel::OnFlowControl().

Referenced by OnH245_FlowControlCommand().

void H323Connection::OnLogicalChannelJitter	(	H323Channel *	channel,
		DWORD	jitter,
		int	skippedFrameCount,
		int	additionalBuffer
	)			`[virtual]`

This function is called when the remote endpoint indicates the level of jitter estimated by the receiver.

If channel is NULL, then the jitter applies to all channels.

The default behaviour does nothing if channel is NULL, otherwise calls H323Channel::OnJitter() on the specific channel.

Parameters:

channel	Channel that is to be limited
jitter	Estimated received jitter in microseconds
skippedFrameCount	Frames skipped by decodec
additionalBuffer	Additional size of video decoder buffer

Definition at line 4409 of file h323.cxx.

References H323Channel::OnJitterIndication().

Referenced by OnH245_JitterIndication().

void H323Connection::SendLogicalChannelMiscCommand	(	H323Channel &	channel,
		unsigned	command
	)

Send a miscellaneous command on the associated H245 channel.

Parameters:

channel	Channel to send command for
command	Command code to send

Definition at line 5301 of file h323.cxx.

References H323ControlPDU::Build(), H245_CommandMessage::e_miscellaneousCommand, H323Channel::GetDirection(), H323Channel::GetNumber(), H323Channel::IsReceiver, H245_MiscellaneousCommand::m_logicalChannelNumber, H245_MiscellaneousCommand::m_type, and WriteControlPDU().

Referenced by H323Channel::SendMiscCommand().

H323Channel * H323Connection::GetLogicalChannel	(	unsigned	number,
		BOOL	fromRemote
	)			const

Get a logical channel. Locates the specified channel number and returns a pointer to it.

Parameters:

number	Channel number to get.
fromRemote	Indicates get a remote channel

Definition at line 3373 of file h323.cxx.

References H245NegLogicalChannels::FindChannel(), and logicalChannels.

H323Channel * H323Connection::FindChannel	(	unsigned	sessionId,
		BOOL	fromRemote
	)			const

Find a logical channel. Locates a channel give a RTP session ID. Each session would usually have two logical channels associated with it, so the fromRemote flag bay be used to distinguish which channel to return.

Parameters:

sessionId	Session ID to search for.
fromRemote	Indicates the direction of RTP data.

Definition at line 3379 of file h323.cxx.

References H245NegLogicalChannels::FindChannelBySession(), and logicalChannels.

Referenced by H323TransportTCP::AcceptControlChannel(), GetSessionCodecNames(), H323_T38Channel::H323_T38Channel(), InternalEstablishedConnectionCheck(), OnConflictingLogicalChannel(), and SelectDefaultLogicalChannel().

unsigned H323Connection::GetBandwidthUsed ( ) const

Get the bandwidth currently used. This totals the open channels and returns the total bandwidth used in 100's of bits/sec

Definition at line 4419 of file h323.cxx.

References H323Channel::GetBandwidthUsed(), H245NegLogicalChannels::GetChannelAt(), H245NegLogicalChannels::GetSize(), and logicalChannels.

Referenced by SetBandwidthAvailable().

BOOL H323Connection::UseBandwidth	(	unsigned	bandwidth,
		BOOL	removing
	)

Request use the available bandwidth in 100's of bits/sec. If there is insufficient bandwidth available, FALSE is returned. If sufficient bandwidth is available, then TRUE is returned and the amount of available bandwidth is reduced by the specified amount.

Parameters:

bandwidth	Bandwidth required
removing	Flag for adding/removing bandwidth usage

Definition at line 4435 of file h323.cxx.

References bandwidthAvailable.

Referenced by H323Channel::SetBandwidthUsed(), and H323Channel::~H323Channel().

unsigned H323Connection::GetBandwidthAvailable ( ) const [inline]

Get the available bandwidth in 100's of bits/sec.

Definition at line 2076 of file h323con.h.

References bandwidthAvailable.

Referenced by H323Gatekeeper::AdmissionRequest().

BOOL H323Connection::SetBandwidthAvailable	(	unsigned	newBandwidth,
		BOOL	force = `FALSE`
	)

Set the available bandwidth in 100's of bits/sec. Note if the force parameter is TRUE this function will close down active logical channels to meet the new bandwidth requirement.

Parameters:

newBandwidth	New bandwidth limit
force	Force bandwidth limit

Definition at line 4459 of file h323.cxx.

References bandwidthAvailable, CloseLogicalChannelNumber(), H323Channel::GetBandwidthUsed(), GetBandwidthUsed(), H245NegLogicalChannels::GetChannelAt(), H323Channel::GetNumber(), H245NegLogicalChannels::GetSize(), and logicalChannels.

Referenced by H323Gatekeeper::AdmissionRequest(), H323Gatekeeper::BandwidthRequest(), and H323Gatekeeper::OnReceiveBandwidthRequest().

void H323Connection::SetSendUserInputMode ( SendUserInputModes mode )

Set the user input indication transmission mode.

Definition at line 4482 of file h323.cxx.

References SendUserInputAsSeparateRFC2833, and sendUserInputMode.

SendUserInputModes H323Connection::GetSendUserInputMode ( ) const [inline]

Get the user input indication transmission mode.

Definition at line 2114 of file h323con.h.

References sendUserInputMode.

H323Connection::SendUserInputModes H323Connection::GetRealSendUserInputMode ( ) const

Get the real user input indication transmission mode. This will return the user input mode that will actually be used for transmissions. It will be the value of GetSendUserInputMode() provided the remote endpoint is capable of that mode.

Definition at line 4518 of file h323.cxx.

References capabilityExchangeProcedure, H245NegTerminalCapabilitySet::HasReceivedCapabilities(), remoteCapabilities, SendUserInputAsQ931, SendUserInputAsString, SendUserInputAsTone, and sendUserInputMode.

Referenced by SendUserInput(), and SendUserInputTone().

void H323Connection::SendUserInput ( const PString & value ) [virtual]

Send a user input indication to the remote endpoint. This is for sending arbitrary strings as user indications.

The user indication is sent according to the sendUserInputMode member variable. If SendUserInputAsString then this uses an H.245 "string" UserInputIndication pdu sending the entire string in one go. If SendUserInputAsTone then a separate H.245 "signal" UserInputIndication pdu is sent for each character. If SendUserInputAsInlineRFC2833 then the indication is inserted into the outgoing audio stream as an RFC2833 RTP data pdu.

SendUserInputAsSeparateRFC2833 is not yet supported.

Parameters:

value

String value of indication

Definition at line 4539 of file h323.cxx.

References GetRealSendUserInputMode(), rfc2833handler, OpalRFC2833::SendTone(), SendUserInputAsInlineRFC2833, SendUserInputAsQ931, SendUserInputAsString, SendUserInputAsTone, SendUserInputIndicationQ931(), SendUserInputIndicationString(), and SendUserInputIndicationTone().

void H323Connection::OnUserInputString ( const PString & value ) [virtual]

Call back for remote endpoint has sent user input. This will be called irrespective of the source (H.245 string, H.245 signal or RFC2833).

The default behaviour calls the endpoint function of the same name.

Parameters:

value

String value of indication

Definition at line 4571 of file h323.cxx.

References endpoint, and H323EndPoint::OnUserInputString().

Referenced by HandleSignalPDU(), OnUserInputIndication(), and H323EndPoint::OnUserInputTone().

void H323Connection::SendUserInputTone	(	char	tone,
		unsigned	duration = `0`,
		unsigned	logicalChannel = `0`,
		unsigned	rtpTimestamp = `0`
	)			`[virtual]`

Send a user input indication to the remote endpoint. This sends DTMF emulation user input. If something more sophisticated than the simple tones that can be sent using the SendUserInput() function.

A duration of zero indicates that no duration is to be indicated. A non-zero logical channel indicates that the tone is to be syncronised with the logical channel at the rtpTimestamp value specified.

The tone parameter must be one of "0123456789#*ABCD!" where '!' indicates a hook flash. If tone is a ' ' character then a signalUpdate PDU is sent that updates the last tone indication sent. See the H.245 specifcation for more details on this.

The user indication is sent according to the sendUserInputMode member variable. If SendUserInputAsString then this uses an H.245 "string" UserInputIndication pdu sending the entire string in one go. If SendUserInputAsTone then a separate H.245 "signal" UserInputIndication pdu is sent for each character. If SendUserInputAsInlineRFC2833 then the indication is inserted into the outgoing audio stream as an RFC2833 RTP data pdu.

SendUserInputAsSeparateRFC2833 is not yet supported.

Parameters:

tone	DTMF tone code
duration	Duration of tone in milliseconds
logicalChannel	Logical channel number for RTP sync.
rtpTimestamp	RTP timestamp in logical channel sync.

Definition at line 4577 of file h323.cxx.

References GetRealSendUserInputMode(), rfc2833handler, OpalRFC2833::SendTone(), SendUserInputAsInlineRFC2833, SendUserInputAsQ931, SendUserInputAsString, SendUserInputAsTone, SendUserInputIndicationQ931(), SendUserInputIndicationString(), and SendUserInputIndicationTone().

Referenced by SendUserInputHookFlash().

void H323Connection::OnUserInputTone	(	char	tone,
		unsigned	duration,
		unsigned	logicalChannel,
		unsigned	rtpTimestamp
	)			`[virtual]`

Call back for remote enpoint has sent user input.

The default behaviour calls the endpoint function of the same name.

Parameters:

tone	DTMF tone code
duration	Duration of tone in milliseconds
logicalChannel	Logical channel number for RTP sync.
rtpTimestamp	RTP timestamp in logical channel sync.

Definition at line 4613 of file h323.cxx.

References endpoint, and H323EndPoint::OnUserInputTone().

Referenced by OnUserInputIndication().

void H323Connection::SendUserInputHookFlash ( int duration = 500 ) [inline]

Send a user input indication to the remote endpoint. This sends a Hook Flash emulation user input.

Parameters:

duration

Duration of tone in milliseconds

Definition at line 2195 of file h323con.h.

References SendUserInputTone().

void H323Connection::SendUserInputIndicationQ931 ( const PString & value ) [virtual]

Send a user input indication to the remote endpoint. This is for sending arbitrary strings as user indications.

This always uses a Q.931 Keypad Information Element in a Information pdu sending the entire string in one go.

Parameters:

value

String value of indication

Definition at line 4622 of file h323.cxx.

References H323SignalPDU::BuildInformation(), ClearCall(), EndedByTransportFail, H323SignalPDU::GetQ931(), Q931::SetKeypad(), and WriteSignalPDU().

Referenced by SendUserInput(), and SendUserInputTone().

void H323Connection::SendUserInputIndicationString ( const PString & value ) [virtual]

Send a user input indication to the remote endpoint. This is for sending arbitrary strings as user indications.

This always uses an H.245 "string" UserInputIndication pdu sending the entire string in one go.

Parameters:

value

String value of indication

Definition at line 4634 of file h323.cxx.

References H323ControlPDU::BuildUserInputIndication(), and WriteControlPDU().

Referenced by SendUserInput(), and SendUserInputTone().

void H323Connection::SendUserInputIndicationTone	(	char	tone,
		unsigned	duration = `0`,
		unsigned	logicalChannel = `0`,
		unsigned	rtpTimestamp = `0`
	)			`[virtual]`

Send a user input indication to the remote endpoint. This sends DTMF emulation user input.This uses an H.245 "signal" UserInputIndication pdu.

Parameters:

tone	DTMF tone code
duration	Duration of tone in milliseconds
logicalChannel	Logical channel number for RTP sync.
rtpTimestamp	RTP timestamp in logical channel sync.

Definition at line 4648 of file h323.cxx.

References H323ControlPDU::BuildUserInputIndication(), and WriteControlPDU().

Referenced by SendUserInput(), and SendUserInputTone().

virtual void H323Connection::SendUserInputIndicationNavigate ( H323_UserInputCapability::NavigateKeyID keyID ) [virtual]

Send a user input indication to the remote endpoint. This sends a H.249 Annex A Navigation user input.

virtual void H323Connection::OnUserInputIndicationNavigate ( const H245_ArrayOf_GenericParameter & contents ) [virtual]

Send a user input indication to the remote endpoint. This Receives/Sends a H.249 Annex A Navigation user input.

Referenced by OnUserInputIndication().

virtual void H323Connection::SendUserInputIndicationSoftkey	(	unsigned	key,
		const PString &	keyName = `PString()`
	)			`[virtual]`

Send a user input indication to the remote endpoint. This Receives/Sends a H.249 Annex B Softkey user input.

virtual void H323Connection::SendUserInputIndicationPointDevice	(	unsigned	x,
		unsigned	y,
		unsigned	button = `0`,
		unsigned	buttonstate = `0`,
		unsigned	clickcount = `0`
	)			`[virtual]`

Send a user input indication to the remote endpoint. This Receives/Sends a H.249 Annex C Point Device user input.

Parameters:

x	X coord
y	Y coord
button	Mouse Button 1 = left 2 = right
buttonstate	Button state 1 = button down 2 = button up
clickcount	ClickCount 1 = sigle click 2= doubleclick

virtual void H323Connection::SendUserInputIndicationModal ( ) [virtual]

Send a user input indication to the remote endpoint. This Receives/Sends a H.249 Annex D Softkey user input.

void H323Connection::SendUserInputIndication ( const H245_UserInputIndication & pdu ) [virtual]

Send a user input indication to the remote endpoint. The two forms are for basic user input of a simple string using the SendUserInput() function or a full DTMF emulation user input using the SendUserInputTone() function.

An application could do more sophisticated usage by filling in the H245_UserInputIndication structure directly ans using this function.

Parameters:

pdu

Full user indication PDU

Definition at line 4795 of file h323.cxx.

References H323ControlPDU::Build(), H245_IndicationMessage::e_userInput, and WriteControlPDU().

void H323Connection::OnUserInputIndication ( const H245_UserInputIndication & pdu ) [virtual]

Call back for remote enpoint has sent user input. The default behaviour calls OnUserInputString() if the PDU is of the alphanumeric type, or OnUserInputTone() if of a tone type.

Parameters:

pdu

Full user indication PDU

Definition at line 4804 of file h323.cxx.

Referenced by OnH245Indication().

RTP_Session * H323Connection::GetSession ( unsigned sessionID ) const [virtual]

Get an RTP session for the specified ID. If there is no session of the specified ID, NULL is returned.

Definition at line 4898 of file h323.cxx.

References RTP_SessionManager::GetSession(), and rtpSessions.

H323_RTP_Session * H323Connection::GetSessionCallbacks ( unsigned sessionID ) const [virtual]

Get an H323 RTP session for the specified ID. If there is no session of the specified ID, NULL is returned.

Definition at line 4904 of file h323.cxx.

References RTP_SessionManager::GetSession(), RTP_Session::GetUserData(), and rtpSessions.

RTP_Session * H323Connection::UseSession	(	unsigned	sessionID,
		const H245_TransportAddress &	pdu,
		H323Channel::Directions	dir,
		RTP_QOS *	rtpqos = `NULL`
	)			`[virtual]`

Use an RTP session for the specified ID and for the given direction. If there is no session of the specified ID, a new one is created using the information provided in the H245_TransportAddress PDU. If the system does not support the specified transport, NULL is returned.

If this function is used, then the ReleaseSession() function MUST be called or the session is never deleted for the lifetime of the H323 connection.

Definition at line 4917 of file h323.cxx.

References RTP_SessionManager::AddSession(), H245_UnicastAddress::e_iP6Address, H245_UnicastAddress::e_iPAddress, H245_TransportAddress::e_unicastAddress, endpoint, H323Channel::IsReceiver, remoteIsNAT, rtpSessions, RTP_Session::SetUserData(), and RTP_SessionManager::UseSession().

Referenced by CreateRealTimeLogicalChannel().

void H323Connection::ReleaseSession ( unsigned sessionID ) [virtual]

Release the session. If the session ID is not being used any more any clients via the UseSession() function, then the session is deleted.

Definition at line 4966 of file h323.cxx.

References RTP_SessionManager::ReleaseSession(), and rtpSessions.

Referenced by H323_RTPChannel::~H323_RTPChannel().

BOOL H323Connection::OnReceiveRTPAltInformation	(	H323_RTP_UDP &	rtp,
		const H245_ArrayOf_GenericInformation &	alternate
	)			const `[virtual]`

Received RTP alternate Information. This is used to supply alternate RTP destination information in the generic information field in the OLC for the purpose of probing for an alternate route to the remote party.

Definition at line 4953 of file h323.cxx.

Referenced by H323_RTP_UDP::OnReceivedAckAltPDU(), and H323_RTP_UDP::OnReceivedAltPDU().

BOOL H323Connection::OnSendingRTPAltInformation	(	const H323_RTP_UDP &	rtp,
		H245_ArrayOf_GenericInformation &	alternate
	)			const `[virtual]`

Send RTP alternate Information. This is used to supply alternate RTP destination information in the generic information field in the OLC for the purpose of probing for an alternate route to the remote party.

Definition at line 4959 of file h323.cxx.

Referenced by H323_RTP_UDP::OnSendingAltPDU(), and H323_RTP_UDP::OnSendOpenAckAlt().

void H323Connection::OnRTPStatistics ( const RTP_Session & session ) const [virtual]

Callback from the RTP session for statistics monitoring. This is called every so many packets on the transmitter and receiver threads of the RTP session indicating that the statistics have been updated.

The default behaviour calls H323EndPoint::OnRTPStatistics().

Parameters:

session

Session with statistics

Definition at line 4972 of file h323.cxx.

References endpoint, and H323EndPoint::OnRTPStatistics().

void H323Connection::OnRTPFinalStatistics ( const RTP_Session & session ) const [virtual]

Callback from the RTP session for statistics monitoring. This is called at the end of the RTP session indicating that the statistics of the call

The default behaviour calls H323EndPoint::OnFinalRTPStatistics().

Parameters:

session

Session with statistics

Definition at line 4977 of file h323.cxx.

References endpoint, and H323EndPoint::OnRTPFinalStatistics().

PString H323Connection::GetSessionCodecNames ( unsigned sessionID ) const [virtual]

Get the names of the codecs in use for the RTP session. If there is no session of the specified ID, an empty string is returned.

Definition at line 5002 of file h323.cxx.

References FindChannel().

BOOL H323Connection::IsBehindNAT ( ) const [inline]

Return TRUE if the remote appears to be behind a NAT firewall

Definition at line 2390 of file h323con.h.

References remoteIsNAT.

void H323Connection::SetRemoteNAT ( ) [inline]

Set Remote is behind NAT

Definition at line 2395 of file h323con.h.

References remoteIsNAT.

BOOL H323Connection::HasNATSupport ( ) const [inline]

Is NAT Support Available

Definition at line 2400 of file h323con.h.

References NATsupport.

Referenced by H323_RTP_UDP::H323_RTP_UDP(), and H323EndPoint::InternalTranslateTCPAddress().

void H323Connection::DisableNATSupport ( ) [inline]

Disable NAT Support for allocation of RTP sockets

Definition at line 2405 of file h323con.h.

References NATsupport, and remoteIsNAT.

void H323Connection::SetSameNAT ( ) [inline]

Set the information that the call parties are behind the same NAT device

Definition at line 2411 of file h323con.h.

References sameNAT.

BOOL H323Connection::isSameNAT ( ) [inline]

Determine if the two parties are behind the same NAT

Definition at line 2415 of file h323con.h.

References sameNAT.

Referenced by H323_RealTimeChannel::OnSendingPDU(), and H323_RealTimeChannel::OnSendOpenAck().

void H323Connection::SetEndpointTypeInfo ( H225_EndpointType & info ) const [virtual]

Set Endpoint Type Information Override this to advertise the Endpoint type on a Call by Call basis

The default behaviour calls H323EndPoint::SetEndpointTypeInfo().

Definition at line 2586 of file h323.cxx.

References endpoint, and H323EndPoint::SetEndpointTypeInfo().

Referenced by H323SignalPDU::BuildAlerting(), H323SignalPDU::BuildCallProceeding(), H323SignalPDU::BuildConnect(), H323SignalPDU::BuildProgress(), and H323SignalPDU::BuildSetup().

BOOL H323Connection::RequestModeChange ( const PString & newModes ) [virtual]

Make a request to mode change to remote. This asks the remote system to stop it transmitters and start sending one of the combinations specifed.

The modes are separated in the string by
characters, and all of the channels (capabilities) are strings separated by characters. Thus a very simple mode change would be "T.38" which requests that the remote start sending T.38 data and nothing else. A more complicated example would be "G.723\tH.261\nG.729\tH.261\nG.728" which indicates that the remote should either start sending G.723 and H.261, G.729 and H.261 or just G.728 on its own.

Returns FALSE if a mode change is currently in progress, only one mode change may be done at a time.

Parameters:

newModes

New modes to select

Definition at line 5013 of file h323.cxx.

References requestModeProcedure, and H245NegRequestMode::StartRequest().

BOOL H323Connection::RequestModeChange ( const H245_ArrayOf_ModeDescription & newModes ) [virtual]

Make a request to mode change to remote. This asks the remote system to stop it transmitters and start sending one of the combinations specifed.

Returns FALSE if a mode change is currently in progress, only one mode change may be done at a time.

Parameters:

newModes

New modes to select

Definition at line 5019 of file h323.cxx.

References requestModeProcedure, and H245NegRequestMode::StartRequest().

BOOL H323Connection::OnRequestModeChange	(	const H245_RequestMode &	pdu,
		H245_RequestModeAck &	ack,
		H245_RequestModeReject &	reject,
		PINDEX &	selectedMode
	)			`[virtual]`

Received request for mode change from remote.

Parameters:

pdu	Received PDU
ack	Ack PDU to send
reject	Reject PDU to send
selectedMode	Which mode was selected

Definition at line 5025 of file h323.cxx.

References H323Capabilities::FindCapability(), localCapabilities, and H245_RequestMode::m_requestedModes.

Referenced by H245NegRequestMode::HandleRequest().

void H323Connection::OnModeChanged ( const H245_ModeDescription & newMode ) [virtual]

Completed request for mode change from remote. This is a call back that accurs after the ack has been sent to the remote as indicated by the OnRequestModeChange() return result. This function is intended to actually implement the mode change after it had been accepted.

Definition at line 5047 of file h323.cxx.

References CloseAllLogicalChannels(), H323Capabilities::FindCapability(), H323Capability::GetDefaultSessionID(), H323Channel::IsTransmitter, localCapabilities, and OpenLogicalChannel().

Referenced by H245NegRequestMode::HandleRequest().

void H323Connection::OnAcceptModeChange ( const H245_RequestModeAck & pdu ) [virtual]

Received acceptance of last mode change request. This callback indicates that the RequestModeChange() was accepted by the remote endpoint.

Parameters:

pdu

Received PDU

Definition at line 5065 of file h323.cxx.

References CloseAllLogicalChannels(), H245_RequestModeAck_response::e_willTransmitMostPreferredMode, H323Capabilities::FindCapability(), H323Capability::GetDefaultSessionID(), H323Channel::IsTransmitter, localCapabilities, H245_RequestModeAck::m_response, OpenLogicalChannel(), and t38ModeChangeCapabilities.

Referenced by H245NegRequestMode::HandleAck().

void H323Connection::OnRefusedModeChange ( const H245_RequestModeReject * pdu ) [virtual]

Received reject of last mode change request. This callback indicates that the RequestModeChange() was accepted by the remote endpoint.

Parameters:

pdu

Received PDU, if NULL is a timeout

Definition at line 5108 of file h323.cxx.

References t38ModeChangeCapabilities.

Referenced by H245NegRequestMode::HandleReject(), and H245NegRequestMode::HandleTimeout().

virtual OpalT120Protocol* H323Connection::CreateT120ProtocolHandler ( ) [virtual]

Create an instance of the T.120 protocol handler. This is called when the OpenLogicalChannel subsystem requires that a T.120 channel be established.

Note that if the application overrides this and returns a pointer to a heap variable (using new) then it is the responsibility of the creator to subsequently delete the object. The user of this function (the H323_T120Channel class) will not do so.

The default behavour returns H323Endpoint::CreateT120ProtocolHandler() while keeping track of that variable for autmatic deletion.

Referenced by H323_T120Channel::OnReceivedAckPDU(), and H323_T120Channel::OnReceivedPDU().

virtual OpalT38Protocol* H323Connection::CreateT38ProtocolHandler ( ) [virtual]

Create an instance of the T.38 protocol handler. This is called when the OpenLogicalChannel subsystem requires that a T.38 fax channel be established.

Note that if the application overrides this and returns a pointer to a heap variable (using new) then it is the responsibility of the creator to subsequently delete the object. The user of this function (the H323_T38Channel class) will not do so.

The default behavour returns H323Endpoint::CreateT38ProtocolHandler() while keeping track of that variable for autmatic deletion.

Referenced by H323_T38Channel::H323_T38Channel().

virtual BOOL H323Connection::RequestModeChangeT38 ( const char * capabilityNames = "T.38\nT38FaxUDP" ) [virtual]

Request a mode change to T.38 data.

virtual OpalH224Handler* H323Connection::CreateH224ProtocolHandler ( unsigned sessionID ) [virtual]

Create an instance of the H.224 protocol handler. This is called when the subsystem requires that a H.224 channel be established.

Note that if the application overrides this it should return a pointer to a heap variable (using new) as it will be automatically deleted when the OpalConnection is deleted.

The default behaviour calls the OpalEndpoint function of the same name if there is not already a H.224 handler associated with this connection. If there is already such a H.224 handler associated, this instance is returned instead.

virtual OpalH281Handler* H323Connection::CreateH281ProtocolHandler ( OpalH224Handler & h224Handler ) [virtual]

Create an instance of the H.281 protocol handler. This is called when the subsystem requires that a H.224 channel be established.

Note that if the application overrides this it should return a pointer to a heap variable (using new) as it will be automatically deleted when the associated H.224 handler is deleted.

The default behavour returns H323Endpoint::CreateH224ProtocolHandler()

BOOL H323Connection::GetAdmissionRequestAuthentication	(	const H225_AdmissionRequest &	arq,
		H235Authenticators &	authenticators
	)			`[virtual]`

Get separate H.235 authentication for the connection. This allows an individual ARQ to override the authentical credentials used in H.235 based RAS for this particular connection.

A return value of FALSE indicates to use the default credentials of the endpoint, while TRUE indicates that new credentials are to be used.

The default behavour does nothing and returns FALSE.

Parameters:

arq	ARQ being constructed
authenticators	New authenticators for ARQ

Definition at line 5274 of file h323.cxx.

Referenced by H323Gatekeeper::AdmissionRequest().

H323EndPoint& H323Connection::GetEndPoint ( ) const [inline]

Get the owner endpoint for this connection.

Definition at line 2580 of file h323con.h.

References endpoint.

Referenced by H45011Handler::AttachToSetup(), H4502Handler::AwaitSetupResponse(), H323SignalPDU::BuildSetup(), H323DataChannel::CreateListener(), H323_T38Channel::CreateTransport(), H323DataChannel::CreateTransport(), H45011Handler::GetRemoteCallIntrusionProtectionLevel(), H323_RTP_UDP::H323_RTP_UDP(), H323_T120Channel::OnReceivedPDU(), OnReceivedSignalSetup(), H45011Handler::SetForcedReleaseAccepted(), and H4502Handler::TransferCall().

BOOL H323Connection::HadAnsweredCall ( ) const [inline]

Get the call direction for this connection.

Definition at line 2584 of file h323con.h.

References callAnswered.

Referenced by H323Gatekeeper::AdmissionRequest(), H323SignalPDU::BuildFacility(), H323SignalPDU::BuildInformation(), H323SignalPDU::BuildNotify(), H323SignalPDU::BuildProgress(), H323SignalPDU::BuildReleaseComplete(), H323SignalPDU::BuildStatus(), H323SignalPDU::BuildStatusInquiry(), H323Gatekeeper::DisengageRequest(), H323_T120Channel::OnReceivedPDU(), and H323SignalPDU::SetQ931Fields().

BOOL H323Connection::IsGatekeeperRouted ( ) const [inline]

Determined if connection is gatekeeper routed.

Definition at line 2588 of file h323con.h.

References gatekeeperRouted.

unsigned H323Connection::GetQ931Cause ( ) const [inline]

Get the Q.931 cause code (Q.850) that terminated this call. See Q931::CauseValues for common values.

Definition at line 2593 of file h323con.h.

References q931Cause.

Referenced by H323SignalPDU::BuildReleaseComplete().

void H323Connection::SetQ931Cause ( unsigned v ) [inline]

Set the outgoing Q.931 cause code (Q.850) that is sent for this call See Q931::CauseValues for common values.

Definition at line 2598 of file h323con.h.

References q931Cause.

unsigned H323Connection::GetDistinctiveRing ( ) const [inline]

Get the distinctive ring code for incoming call. This returns an integer from 0 to 7 that may indicate to an application that different ring cadences are to be used.

Definition at line 2604 of file h323con.h.

References distinctiveRing.

Referenced by H323SignalPDU::SetQ931Fields().

void H323Connection::SetDistinctiveRing ( unsigned pattern ) [inline]

Set the distinctive ring code for outgoing call. This sets the integer from 0 to 7 that will be used in the outgoing Setup PDU. Note this must be called either immediately after construction or during the OnSendSignalSetup() callback function so the member variable is set befor ethe PDU is sent.

Definition at line 2612 of file h323con.h.

References distinctiveRing.

const PString& H323Connection::GetCallToken ( ) const [inline]

Get the internal OpenH323 call token for this connection.

Definition at line 2616 of file h323con.h.

References callToken.

Referenced by H323EndPoint::ClearAllCalls(), H323EndPoint::ClearCallSynchronous(), H323EndPoint::ForwardConnection(), H4502Handler::HandleConsultationTransfer(), H45011Handler::OnReceivedCallIntrusionForcedRelease(), H4502Handler::OnReceivedCallTransferInitiate(), H4502Handler::OnReceivedIdentifyReturnResult(), and H4502Handler::OnReceivedSetupReturnError().

unsigned H323Connection::GetCallReference ( ) const [inline]

Get the call reference for this connection.

Definition at line 2620 of file h323con.h.

References callReference.

const OpalGloballyUniqueID& H323Connection::GetCallIdentifier ( ) const [inline]

Get the call identifier for this connection.

Definition at line 2624 of file h323con.h.

References callIdentifier.

const OpalGloballyUniqueID& H323Connection::GetConferenceIdentifier ( ) const [inline]

Get the conference identifier for this connection.

Definition at line 2628 of file h323con.h.

References conferenceIdentifier.

Referenced by H323Gatekeeper::AdmissionRequest(), H323Gatekeeper::BandwidthRequest(), H323SignalPDU::BuildConnect(), H323SignalPDU::BuildSetup(), and H323Gatekeeper::DisengageRequest().

const PString& H323Connection::GetLocalPartyName ( ) const [inline]

Get the local name/alias.

Definition at line 2632 of file h323con.h.

References localPartyName.

Referenced by H323Gatekeeper::AdmissionRequest(), H4502Handler::OnReceivedCallTransferIdentify(), and H323SignalPDU::SetQ931Fields().

void H323Connection::SetLocalPartyName ( const PString & name )

Set the local name/alias from information in the PDU.

Definition at line 1678 of file h323.cxx.

References localAliasNames, and localPartyName.

void H323Connection::SetDisplayName ( const PString & name ) [inline]

Set the local Q.931 display name

Definition at line 2640 of file h323con.h.

References localDisplayName.

const PString H323Connection::GetDisplayName ( ) const [inline]

Get the local Q.931 display name

Definition at line 2644 of file h323con.h.

References localDisplayName.

Referenced by H323SignalPDU::SetQ931Fields().

virtual const PString& H323Connection::GetRemotePartyName ( ) const [inline, virtual]

Get the remote party name. This returns a string indicating the remote parties names and aliases. This can be a complicated string containing all the aliases and the remote host name. For example: "Fred Nurk (fred, 5551234) [fred.nurk.com]"

Definition at line 2654 of file h323con.h.

References remotePartyName.

Referenced by H323Gatekeeper::AdmissionRequest(), H323SignalPDU::BuildSetup(), and H323SignalPDU::SetQ931Fields().

const PString& H323Connection::GetRemotePartyNumber ( ) const [inline]

Get the remote party number, if there was one one. If the remote party has indicated an e164 number as one of its aliases or as a field in the Q.931 PDU, then this function will return it.

Definition at line 2660 of file h323con.h.

References remotePartyNumber.

Referenced by H323SignalPDU::SetQ931Fields().

const PString& H323Connection::GetRemotePartyAddress ( ) const [inline]

Get the remote party address. This will return the "best guess" at an address to use in a H323EndPoint::MakeCall() function to call the remote party back again. Note that due to the presence of gatekeepers/proxies etc this may not always be accurate.

Definition at line 2668 of file h323con.h.

References remotePartyAddress.

const PStringArray& H323Connection::GetRemotePartyAliases ( ) const [inline]

Get the remote party Alias List, if there was one.

Definition at line 2672 of file h323con.h.

References remoteAliasNames.

void H323Connection::SetRemotePartyInfo ( const H323SignalPDU & pdu )

Set the name/alias of remote end from information in the PDU.

Parameters:

pdu

PDU from which to extract party info.

Definition at line 1689 of file h323.cxx.

References Q931::GetCalledPartyNumber(), Q931::GetDisplayName(), H323TransportAddress::GetHostName(), H323SignalPDU::GetQ931(), H323Transport::GetRemoteAddress(), remotePartyName, remotePartyNumber, and signallingChannel.

Referenced by OnReceivedAlerting(), OnReceivedCallProceeding(), OnReceivedProgress(), and OnReceivedSignalConnect().

const PString& H323Connection::GetRemoteApplication ( ) const [inline]

Get the remote application name and version. This information is obtained from the sourceInfo field of the H.225 Setup PDU or the destinationInfo of the call proceeding or alerting PDU's. The general format of the string will be information extracted from the VendorIdentifier field of the EndpointType. In particular:

productId <tab> versionId <tab> t35CountryCode/manufacturerCode

for example "Equivalence OpenPhone\t1.4.2\t9/61"

Definition at line 2691 of file h323con.h.

References remoteApplication.

Referenced by H245NegLogicalChannel::HandleOpen(), and H323_UserInputCapability::IsUsable().

void H323Connection::SetRemoteApplication ( const H225_EndpointType & pdu )

Set the name/alias of remote end from information in the PDU.

Parameters:

pdu

PDU from which to extract application info.

Definition at line 1707 of file h323.cxx.

References H225_EndpointType::e_vendor, H225_EndpointType::m_vendor, and remoteApplication.

Referenced by OnReceivedAlerting(), OnReceivedCallProceeding(), OnReceivedProgress(), OnReceivedSignalConnect(), and OnReceivedSignalSetup().

const H323Capabilities& H323Connection::GetLocalCapabilities ( ) const [inline]

Get the remotes capability table for this connection.

Definition at line 2701 of file h323con.h.

References localCapabilities.

Referenced by H323ControlPDU::BuildTerminalCapabilitySet(), H323Capabilities::H323Capabilities(), and H245NegRequestMode::StartRequest().

const H323Capabilities& H323Connection::GetRemoteCapabilities ( ) const [inline]

Get the remotes capability table for this connection.

Definition at line 2705 of file h323con.h.

References remoteCapabilities.

unsigned H323Connection::GetRemoteMaxAudioDelayJitter ( ) const [inline]

Get the maximum audio jitter delay.

Definition at line 2709 of file h323con.h.

References remoteMaxAudioDelayJitter.

const H323Transport* H323Connection::GetSignallingChannel ( ) const [inline]

Get the signalling channel being used.

Definition at line 2713 of file h323con.h.

References signallingChannel.

Referenced by H323Gatekeeper::AdmissionRequest(), and H4502Handler::OnReceivedCallTransferIdentify().

unsigned H323Connection::GetSignallingVersion ( ) const [inline]

Get the signalling channel protocol version number.

Definition at line 2717 of file h323con.h.

References h225version.

const H323Transport & H323Connection::GetControlChannel ( ) const

Get the control channel being used (may return signalling channel).

Definition at line 5281 of file h323.cxx.

References controlChannel, and signallingChannel.

Referenced by H323DataChannel::CreateListener(), CreateRealTimeLogicalChannel(), H323_T38Channel::CreateTransport(), H323DataChannel::CreateTransport(), H323_RTP_UDP::H323_RTP_UDP(), H323_T120Channel::OnReceivedPDU(), H323_T120Channel::OnSendingPDU(), H323_T120Channel::OnSendOpenAck(), H323DataChannel::OnSendOpenAck(), and H323_RTP_UDP::OnSendRasInfo().

unsigned H323Connection::GetControlVersion ( ) const [inline]

Get the control channel protocol version number.

Definition at line 2725 of file h323con.h.

References h245version.

Referenced by H323_UserInputCapability::IsUsable().

PTime H323Connection::GetSetupUpTime ( ) const [inline]

Get the time at which the connection was begun

Definition at line 2729 of file h323con.h.

References setupTime.

PTime H323Connection::GetAlertingTime ( ) const [inline]

Get the time at which the ALERTING was received

Definition at line 2733 of file h323con.h.

References alertingTime.

PTime H323Connection::GetConnectionStartTime ( ) const [inline]

Get the time at which the connection was connected. That is the point at which charging is likely to have begun.

Definition at line 2738 of file h323con.h.

References connectedTime.

PTime H323Connection::GetConnectionEndTime ( ) const [inline]

Get the time at which the connection was cleared

Definition at line 2742 of file h323con.h.

References callEndTime.

PTime H323Connection::GetReverseMediaOpenTime ( ) const [inline]

Get the time at which the remote opened a media channel

Definition at line 2746 of file h323con.h.

References reverseMediaOpenTime.

unsigned H323Connection::GetMinAudioJitterDelay ( ) const [inline]

Get the default maximum audio jitter delay parameter. Defaults to 50ms

Definition at line 2751 of file h323con.h.

References minAudioJitterDelay.

Referenced by H323_RTPChannel::Receive().

unsigned H323Connection::GetMaxAudioJitterDelay ( ) const [inline]

Get the default maximum audio delay jitter parameter. Defaults to 250ms.

Definition at line 2756 of file h323con.h.

References maxAudioJitterDelay.

Referenced by H323ControlPDU::BuildTerminalCapabilitySet(), and H323_RTPChannel::Receive().

void H323Connection::SetAudioJitterDelay	(	unsigned	minDelay,
		unsigned	maxDelay
	)

Set the maximum audio delay jitter parameter.

Parameters:

minDelay	New minimum jitter buffer delay in milliseconds
maxDelay	New maximum jitter buffer delay in milliseconds

Definition at line 5287 of file h323.cxx.

References maxAudioJitterDelay, and minAudioJitterDelay.

unsigned H323Connection::GetUUIEsRequested ( ) const [inline]

Get the UUIE PDU monitor bit mask.

Definition at line 2767 of file h323con.h.

References uuiesRequested.

Referenced by H323Gatekeeper::InfoRequestResponse().

void H323Connection::SetUUIEsRequested ( unsigned mask ) [inline]

Set the UUIE PDU monitor bit mask.

Definition at line 2771 of file h323con.h.

References uuiesRequested.

Referenced by H323Gatekeeper::AdmissionRequest(), and H323Gatekeeper::OnReceiveInfoRequest().

const PString H323Connection::GetGkAccessTokenOID ( ) const [inline]

Get the iNow Gatekeeper Access Token OID.

Definition at line 2775 of file h323con.h.

References gkAccessTokenOID.

Referenced by H323Gatekeeper::AdmissionRequest().

void H323Connection::SetGkAccessTokenOID ( const PString & oid ) [inline]

Set the iNow Gatekeeper Access Token OID.

Definition at line 2779 of file h323con.h.

References gkAccessTokenOID.

const PBYTEArray& H323Connection::GetGkAccessTokenData ( ) const [inline]

Get the iNow Gatekeeper Access Token data.

Definition at line 2783 of file h323con.h.

References gkAccessTokenData.

void H323Connection::SetDestExtraCallInfo ( const PString & info ) [inline]

Set the Destionation Extra Call Info memeber.

Definition at line 2787 of file h323con.h.

References destExtraCallInfo.

void H323Connection::SetRemoteCallWaiting ( const unsigned value ) [inline]

Set the remote call waiting flag

Definition at line 2793 of file h323con.h.

References remoteCallWaiting.

Referenced by H4506Handler::OnReceivedCallWaitingIndication().

const int H323Connection::GetRemoteCallWaiting ( ) const [inline]

How many caller's are waiting on the remote endpoint? -1 - None 0 - Just this connection n - n plus this connection

Definition at line 2800 of file h323con.h.

References remoteCallWaiting.

void H323Connection::SetEnforcedDurationLimit ( unsigned seconds )

Set the enforced duration limit for the call. This starts a timer that will automatically shut down the call when it expires.

Parameters:

seconds

max duration of call in seconds

Definition at line 5315 of file h323.cxx.

References enforcedDurationLimit.

Referenced by H323CallCreditServiceControl::OnChange().

void H323Connection::DisableFeatures ( )

Disable Feautures on a call by call basis

const H235Authenticators & H323Connection::GetEPAuthenticators ( ) const

Get Endpoint Authenticator mothods

Definition at line 5395 of file h323.cxx.

References EPAuthenticators.

void H323Connection::SetAuthenticationConnection ( ) [virtual]

Set Authentication to support Validation CallBack OnCallAuthentication is called when a EPAuthentication CryptoToken is Validated.

Definition at line 5388 of file h323.cxx.

References EPAuthenticators.

Referenced by AttachSignalChannel().

BOOL H323Connection::OnCallAuthentication	(	const PString &	username,
		PString &	password
	)			`[virtual]`

EP Authentication CallBack to check username and get Password for Call Authentication. By Default it calls the corresponding Endpoint Function.

Definition at line 5400 of file h323.cxx.

References endpoint, and H323EndPoint::OnCallAuthentication().

Referenced by H235AuthSimpleMD5::ValidateCryptoToken().

BOOL H323Connection::OnEPAuthenticationFailed ( H235Authenticator::ValidationResult result ) const [virtual]

EP Authentication CallBack to allow the connection to approve the authentication even if it has failed. Use this to override authentication on a call by call basis Return TRUE to Authenticate.

Definition at line 5406 of file h323.cxx.

void H323Connection::OnAuthenticationFinalise	(	unsigned	pdu,
		PBYTEArray &	rawData
	)			`[virtual]`

EP Authentication Finalise Callback. After the PDU has been built this Callback allows the Authentication mechanisms to finalise the PDU.

Definition at line 5411 of file h323.cxx.

References EPAuthenticators.

Referenced by H323SignalPDU::Write().

BOOL H323Connection::HasAuthentication ( ) const [inline]

Whether the Call has Authentication

Definition at line 2855 of file h323con.h.

References hasAuthentication.

BOOL H323Connection::HasAuthenticationFailed ( ) [inline]

Whether the Authentication has Failed

Definition at line 2860 of file h323con.h.

References AuthenticationFailed.

BOOL H323Connection::OnSendServiceControlSessions	(	H225_ArrayOf_ServiceControlSession &	serviceControl,
		H225_ServiceControlSession_reason	reason
	)			const

On Send Service Control Session

Parameters:

serviceControl	Service control PDU
reason	Reason for Service Control

void H323Connection::OnReceiveServiceControlSessions ( const H225_ArrayOf_ServiceControlSession & serviceControl )

On Receive Service Control Session

Parameters:

serviceControl

Service control PDU

Referenced by OnReceivedAlerting(), and OnReceivedFacility().

virtual void H323Connection::OnReceiveServiceControl	(	const PString &	amount,
		BOOL	credit,
		const unsigned &	timelimit,
		const PString &	url,
		const PString &	ldapURL,
		const PString &	baseDN
	)			`[virtual]`

On Send Call Credit

Parameters:

amount	Current Balance
credit	Debit or Credit
timelimit	Time Remaining
url	url for TopUp
ldapURL	LDAP URL
baseDN	LDAP base DN

virtual BOOL H323Connection::OnSendServiceControl	(	PString &	amount,
		BOOL	credit,
		unsigned &	timelimit,
		PString &	url
	)			const `[virtual]`

On Receive Call Credit

Parameters:

amount	Current Balance
credit	Debit or Credit
timelimit	Time Remaining
url	url for TopUp

void H323Connection::DisableH245inSETUP ( ) [virtual]

Disable H245 in Setup

Definition at line 5687 of file h323.cxx.

References doH245inSETUP.

void H323Connection::SetNonCallConnection ( ) [virtual]

Set the connection as a non Standard Call

Definition at line 5692 of file h323.cxx.

References IsNonCallConnection.

virtual H460_FeatureSet* H323Connection::GetFeatureSet ( ) [virtual]

Get the connection FeatureSet

BOOL H323Connection::OpenConferenceControlSession	(	BOOL &	chairControl,
		BOOL &	extControls
	)

Open Conference Controls

void H323Connection::InternalEstablishedConnectionCheck ( ) [protected, virtual]

Internal function to check if call established. This checks all the criteria for establishing a call an initiating the starting of media channels, if they have not already been started via the fast start algorithm.

Definition at line 3816 of file h323.cxx.

References AwaitingSignalConnect, capabilityExchangeProcedure, H323Capability::CreateChannel(), RTP_Session::DefaultAudioSessionID, OpalMediaFormat::DefaultH224SessionID, earlyStart, endSessionNeeded, EstablishedConnection, FastStartAcknowledged, fastStartChannels, fastStartState, H323Capabilities::FindCapability(), FindChannel(), H245NegLogicalChannels::GetNextChannelNumber(), HasExecutedSignalConnect, H245NegTerminalCapabilitySet::HasReceivedCapabilities(), H245NegTerminalCapabilitySet::HasSentCapabilities(), H323Channel::IsBidirectional, H245NegMasterSlaveDetermination::IsDetermined(), H323Channel::IsTransmitter, localCapabilities, logicalChannels, masterSlaveDeterminationProcedure, mediaWaitForConnect, OnEstablished(), OnSelectLogicalChannels(), H245NegLogicalChannels::Open(), OpenLogicalChannel(), remoteCapabilities, H323Channel::SetNumber(), startH224, and startT120.