#include <h323con.h>
Inheritance diagram for H323Connection:
|
|
|
Error discriminator for the OnControlProtocolError() function. |
|
|
|
|
|
|
Create a new connection.
|
|
Destroy the connection |
|
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.
|
|
Attach a transport to this connection as the signalling channel.
|
|
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. |
|
Close a logical channel.
|
|
Close a logical channel.
|
|
Close a logical channel by number.
|
|
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).
|
|
Start a separate control channel. This function is called from one of a number of functions when it needs to listen for an incoming H.245 connection. 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 OpalTransport decendent for the control channel.
|
|
Create a new logical channel object. This is in response to a request from the remote endpoint to open a logical channel.
|
|
Open a new media stream. This will create a media stream of an appropriate subclass as required by the underlying connection protocol. For instance H.323 would create an OpalRTPStream. The sessionID parameter may not be needed by a particular media stream and may be ignored. In the case of an OpalRTPStream it us used. Note that media streams may be created internally to the underlying protocol. This function is not the only way a stream can come into existance. The default behaviour is pure.
Reimplemented from OpalConnection. |
|
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.
|
|
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) { 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.
|
|
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.
|
|
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.
Reimplemented from OpalConnection. |
|
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.
|
|
Get the bandwidth currently used. This totals the open channels and returns the total bandwidth used in 100's of bits/sec Reimplemented from OpalConnection. |
|
Get the call identifier for this connection. preserved for backwards compatibility with OpenH323 only |
|
Get the call reference for this connection. |
|
Get the internal OpenH323 call token for this connection. Deprecated, only used for backward compatibility. |
|
Get transfer invoke ID dureing trasfer. This is an internal function and it is not expected the user will call it directly. |
|
Get the conference identifier for this connection. |
|
Get the control channel being used (may return signalling channel). |
|
Get the control channel protocol version number. |
|
Get the destination address of an incoming connection. This will, for example, collect a phone number from a POTS line, or get the fields from the H.225 SETUP pdu in a H.323 connection. Reimplemented from OpalConnection. |
|
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. |
|
Get the owner endpoint for this connection. Reimplemented from OpalConnection. |
|
Get the iNow Gatekeeper Access Token data. |
|
Get the iNow Gatekeeper Access Token OID. |
|
Get the list of all alias names this connection is using. |
|
Get Call Intrusion Protection Level of the local endpoint. |
|
Get the remotes capability table for this connection. |
|
Get a logical channel. Locates the specified channel number and returns a pointer to it.
|
|
Get the data formats this connection is capable of operating. This provides a list of media data format names that an OpalMediaStream may be created in within this connection. The default behaviour returns media data format names contained in the remote capability table. Implements OpalConnection. |
|
Get information on the media channel for the connection. The default behaviour returns TRUE and fills the info structure if there is a media channel active for the sessionID.
|
|
Get the Q.931 cause code (Q.850) that terminated this call. See Q931::CauseValues for common values. |
|
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. |
|
Get Call Intrusion Protection Level of other endpoints that we are in connection with. |
|
How many caller's are waiting on the remote endpoint? -1 - None 0 - Just this connection n - n plus this connection |
|
Get the remotes capability table for this connection. |
|
Get the maximum audio jitter delay. |
|
Get the remote party address. This will return the "best guess" at an address to use in a to call the user again later. Reimplemented from OpalConnection. |
|
Get the round trip delay over the control channel. |
|
Get the user input indication transmission mode. |
|
Get an RTP session for the specified ID. If there is no session of the specified ID, NULL is returned. Reimplemented from OpalConnection. |
|
Get an H323 RTP session for the specified ID. If there is no session of the specified ID, NULL is returned. |
|
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. |
|
Get the signalling channel being used. |
|
Get the signalling channel protocol version number. |
|
Get the control channel being used (may return signalling channel). Reimplemented from OpalConnection. |
|
Get the UUIE PDU monitor bit mask. |
|
Get the call direction for this connection. |
|
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.
|
|
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.
|
|
Handle reading data on the control channel. |
|
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. |
|
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. |
|
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.
|
|
Handle an incoming call instrusion request. Calls h45011handler->AwaitSetupResponse where we set Handler state to CI-Wait-Ack |
|
Handle reading PDU's from the signalling channel. This is an internal function and is unlikely to be used by applications. |
|
Handle PDU from the signalling channel. This is an internal function and is unlikely to be used by applications.
|
|
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. |
|
Handle Control PDU tunnelled in the signalling channel. This is an internal function and is unlikely to be used by applications.
|
|
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.
|
|
Put the current connection on hold, suspending all media streams. Simply calls HoldCall() which is kept for backward compatibility. Reimplemented from OpalConnection. |
|
|
|
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. |
|
Begin a call intrusion request. Calls h45011handler->IntrudeCall where SS pdu is added to Call Setup message. |
|
Return TRUE if the remote appears to be behind a NAT firewall |
|
|
|
Determine if the current call is held or in the process of being held. |
|
Return TRUE if the current connection is on hold. Simply calls IsCallOnHold() which is kept for backward compatibility. Reimplemented from OpalConnection. |
|
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. |
|
Determined if connection is gatekeeper routed. |
|
Return if this H245 connection is a master or slave |
|
Determine if held. |
|
See if the media can bypass the local host. The default behaviour returns TRUE if the session is audio or video.
Reimplemented from OpalConnection. |
|
Determine if Meadia On Hold is enabled. |
|
Determine if held. |
|
Determine whether this connection is the result of a transferred call. |
|
Determine whether this connection is being transferred. |
|
|
|
Received acceptance of last mode change request. This callback indicates that the RequestModeChange() was accepted by the remote endpoint.
|
|
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.
|
|
Call back for answering an incoming call. This function is called after the connection has been acknowledged but before the connection is established This gives the application time to wait for some event before signalling to the endpoint that the connection is to proceed. For example the user pressing an "Answer call" button. If AnswerCallDenied is returned the connection is aborted and the connetion specific end call PDU is sent. If AnswerCallNow is returned then the connection proceeding, Finally if AnswerCallPending is returned then the protocol negotiations are paused until the AnsweringCall() function is called. The default behaviour simply returns AnswerNow.
Reimplemented from OpalConnection. |
|
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.
|
|
Called when a connection is cleared, just after CleanUpOnCallEnd() Default behaviour is to call H323Connection::OnConnectionCleared |
|
This function is called when the remote endpoint has closed down a logical channel. The default behaviour does nothing.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
Called when a connection is established. Default behaviour is to call H323EndPoint::OnConnectionEstablished Reimplemented from OpalConnection. |
|
Handle H245 command to control flow control. This function calls OnLogicalChannelFlowControl() with the channel and bit rate restriction.
|
|
Handle H245 indication of received jitter. This function calls OnLogicalChannelJitter() with the channel and estimated jitter.
|
|
Handle H245 miscellaneous command. This function passes the miscellaneous command on to the channel defined by the pdu.
|
|
Handle H245 miscellaneous indication. This function passes the miscellaneous indication on to the channel defined by the pdu.
|
|
Handle H245 command to send terminal capability set.
|
|
Handle incoming command PDU's on the control channel. Dispatches them to the various virtuals off this class.
|
|
Handle incoming indication PDU's on the control channel. Dispatches them to the various virtuals off this class.
|
|
Handle incoming request PDU's on the control channel. Dispatches them to the various virtuals off this class.
|
|
Handle incoming response PDU's on the control channel. Dispatches them to the various virtuals off this class.
|
|
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.
|
|
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. |
|
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.
|
|
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.
|
|
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. |
|
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.
|
|
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
|
|
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().
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
Received reject of last mode change request. This callback indicates that the RequestModeChange() was accepted by the remote endpoint.
|
|
Clean up the termination of the connection. This function can do any internal cleaning up and waiting on background threads that may be using the connection object. Note that there is not a one to one relationship with the OnEstablishedConnection() function. This function may be called without that function being called. For example if SetUpConnection() was used but the call never completed. Classes that override this function should make sure they call the ancestor version for correct operation. An application will not typically call this function as it is used by the OpalManager during a release of the connection. The default behaviour calls CleanUpOnCallEnd() then calls the ancestor. Reimplemented from OpalConnection. |
|
Received request for mode change from remote.
|
|
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().
|
|
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. |
|
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 |
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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 adds all media formats. |
|
Call back function when a logical channel thread begins. The default behaviour does nothing and returns TRUE.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
Open source transmitter media stream for session.
Reimplemented from OpalConnection. |
|
|
|
|
|
|
|
Release the session. If the session ID is not being used any more any clients via the UseSession() function, then the session is deleted. Reimplemented from OpalConnection. |
|
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.
|
|
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 Returns FALSE if a mode change is currently in progress, only one mode change may be done at a time.
|
|
Request a mode change to T.38 data. |
|
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. |
|
Retrieve the current connection from hold, activating all media streams. Simply calls RetrieveCall() which is kept for backward compatibility. Reimplemented from OpalConnection. |
|
Select default logical channel for normal start.
|
|
Select default logical channel for fast start. Internal function, not for normal use.
|
|
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.
|
|
Send a new capability set.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
Send a user input indication to the remote endpoint. This sends DTMF emulation user input.This uses an H.245 "signal" UserInputIndication pdu.
|
|
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.
Reimplemented from OpalConnection. |
|
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.
Reimplemented from OpalConnection. |
|
Indicate to remote endpoint an alert is in progress. If this is an incoming connection and it is in the Alerting phase, then this function is used to indicate to that endpoint that an alert is in progress. This is usually due to another connection which is in the call (the B party) has received an OnAlerting() indicating that its remote endpoint is "ringing". The default behaviour sends an ALERTING pdu.
Implements OpalConnection. |
|
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.
|
|
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.
Reimplemented from OpalConnection. |
|
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. |
|
Indicate to remote endpoint we are connected. The default behaviour sends a CONNECT pdu. Implements OpalConnection. |
|
Set the Destionation Extra Call Info memeber. |
|
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. |
|
Set the enforced duration limit for the call. This starts a timer that will automatically shut down the call when it expires.
|
|
|
|
Set the iNow Gatekeeper Access Token OID. |
|
Set the alternative 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 media on hold will be provided for the held endpoint. |
|
|
|
|
|
Set the local name/alias from information in the PDU. Reimplemented from OpalConnection. |
|
Set the outgoing Q.931 cause code (Q.850) that is sent for this call See Q931::CauseValues for common values. |
|
Set the remote call waiting flag |
|
Set the name/alias of remote end from information in the PDU.
|
|
Set the name/alias of remote end from information in the PDU.
|
|
|
|
Set the user input indication transmission mode. |
|
Start an outgoing connection. This function will initiate the connection to the remote entity, for example in H.323 it sends a SETUP, in SIP it sends an INVITE etc. The default behaviour is to send SETUP packet. Implements OpalConnection. |
|
Set the UUIE PDU monitor bit mask. |
|
Start control channel negotiations. |
|
Start a logical channel for fast start. Internal function, not for normal use.
|
|
Start the round trip delay calculation over the control channel. |
|
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).
|
|
Transfer the current connection to a new destination. Simply calls TransferCall() which is kept for backward compatibility. Reimplemented from OpalConnection. |
|
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 tranport parameter. 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. Reimplemented from OpalConnection. |
|
Write a PDU to the control channel. If there is no control channel open then this will tunnel the PDU into the signalling channel. |
|
Write a PDU to the signalling channel.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Reimplemented from OpalConnection. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Call Intrusion flag and parameters |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|