#include <h323ep.h>
Member variable access | |
enum | TerminalTypes { e_TerminalOnly = 50, e_TerminalAndMC = 70, e_GatewayOnly = 60, e_GatewayAndMC = 80, e_GatewayAndMCWithDataMP = 90, e_GatewayAndMCWithAudioMP = 100, e_GatewayAndMCWithAVMP = 110, e_GatekeeperOnly = 120, e_GatekeeperWithDataMP = 130, e_GatekeeperWithAudioMP = 140, e_GatekeeperWithAVMP = 150, e_MCUOnly = 160, e_MCUWithDataMP = 170, e_MCUWithAudioMP = 180, e_MCUWithAVMP = 190 } |
virtual void | SetLocalUserName (const PString &name) |
virtual const PString & | GetLocalUserName () const |
BOOL | AddAliasName (const PString &name) |
BOOL | RemoveAliasName (const PString &name) |
const PStringList & | GetAliasNames () const |
BOOL | IsFastStartDisabled () const |
void | DisableFastStart (BOOL mode) |
BOOL | IsH245TunnelingDisabled () const |
void | DisableH245Tunneling (BOOL mode) |
BOOL | IsH245inSetupDisabled () const |
void | DisableH245inSetup (BOOL mode) |
BOOL | DetectInBandDTMFDisabled () const |
void | DisableDetectInBandDTMF (BOOL mode) |
BOOL | CanDisplayAmountString () const |
void | SetCanDisplayAmountString (BOOL mode) |
BOOL | CanEnforceDurationLimit () const |
void | SetCanEnforceDurationLimit (BOOL mode) |
unsigned | GetCallIntrusionProtectionLevel () const |
void | SetCallIntrusionProtectionLevel (unsigned level) |
virtual void | OnReceivedInitiateReturnError () |
H323AudioCodec::SilenceDetectionMode | GetSilenceDetectionMode () const |
void | SetSilenceDetectionMode (H323AudioCodec::SilenceDetectionMode mode) |
H323Connection::SendUserInputModes | GetSendUserInputMode () const |
void | SetSendUserInputMode (H323Connection::SendUserInputModes mode) |
BOOL | CanAutoStartReceiveVideo () const |
BOOL | CanAutoStartTransmitVideo () const |
BOOL | CanAutoStartReceiveFax () const |
BOOL | CanAutoStartTransmitFax () const |
BOOL | CanAutoCallForward () const |
const H323ListenerList & | GetListeners () const |
const H323Capabilities & | GetCapabilities () const |
TerminalTypes | GetTerminalType () const |
BOOL | IsTerminal () const |
BOOL | IsGateway () const |
BOOL | IsGatekeeper () const |
BOOL | IsMCU () const |
unsigned | GetMinAudioJitterDelay () const |
unsigned | GetMaxAudioJitterDelay () const |
void | SetAudioJitterDelay (unsigned minDelay, unsigned maxDelay) |
unsigned | GetInitialBandwidth () const |
void | SetInitialBandwidth (unsigned bandwidth) |
virtual BOOL | OnSendFeatureSet (unsigned, H225_FeatureSet &) |
virtual void | OnReceiveFeatureSet (unsigned, const H225_FeatureSet &) |
virtual BOOL | IsLocalAddress (const PIPSocket::Address &remoteAddress) const |
virtual void | TranslateTCPAddress (PIPSocket::Address &, const PIPSocket::Address &) |
void | InternalTranslateTCPAddress (PIPSocket::Address &, const PIPSocket::Address &) |
WORD | GetTCPPortBase () const |
WORD | GetTCPPortMax () const |
void | SetTCPPorts (unsigned tcpBase, unsigned tcpMax) |
WORD | GetNextTCPPort () |
WORD | GetUDPPortBase () const |
WORD | GetUDPPortMax () const |
void | SetUDPPorts (unsigned udpBase, unsigned udpMax) |
WORD | GetNextUDPPort () |
WORD | GetRtpIpPortBase () const |
WORD | GetRtpIpPortMax () const |
void | SetRtpIpPorts (unsigned udpBase, unsigned udpMax) |
WORD | GetRtpIpPortPair () |
BYTE | GetRtpIpTypeofService () const |
void | SetRtpIpTypeofService (unsigned tos) |
BYTE | GetTcpIpTypeofService () const |
void | SetTcpIpTypeofService (unsigned tos) |
const PTimeInterval & | GetSignallingChannelConnectTimeout () const |
const PTimeInterval & | GetSignallingChannelCallTimeout () const |
const PTimeInterval & | GetControlChannelStartTimeout () const |
const PTimeInterval & | GetEndSessionTimeout () const |
const PTimeInterval & | GetMasterSlaveDeterminationTimeout () const |
unsigned | GetMasterSlaveDeterminationRetries () const |
const PTimeInterval & | GetCapabilityExchangeTimeout () const |
const PTimeInterval & | GetLogicalChannelTimeout () const |
const PTimeInterval & | GetRequestModeTimeout () const |
const PTimeInterval & | GetRoundTripDelayTimeout () const |
const PTimeInterval & | GetRoundTripDelayRate () const |
BOOL | ShouldClearCallOnRoundTripFail () const |
const PTimeInterval & | GetNoMediaTimeout () const |
BOOL | SetNoMediaTimeout (PTimeInterval newInterval) |
const PTimeInterval & | GetGatekeeperRequestTimeout () const |
unsigned | GetGatekeeperRequestRetries () const |
const PTimeInterval & | GetRasRequestTimeout () const |
unsigned | GetRasRequestRetries () const |
const PTimeInterval & | GetGatekeeperTimeToLive () const |
const PString & | GetGkAccessTokenOID () const |
void | SetGkAccessTokenOID (const PString &token) |
const PTimeInterval & | GetCallTransferT1 () const |
const PTimeInterval & | GetCallTransferT2 () const |
const PTimeInterval & | GetCallTransferT3 () const |
const PTimeInterval & | GetCallTransferT4 () const |
const PTimeInterval & | GetCallIntrusionT1 () const |
const PTimeInterval & | GetCallIntrusionT2 () const |
const PTimeInterval & | GetCallIntrusionT3 () const |
const PTimeInterval & | GetCallIntrusionT4 () const |
const PTimeInterval & | GetCallIntrusionT5 () const |
const PTimeInterval & | GetCallIntrusionT6 () const |
H323CallIdentityDict & | GetCallIdentityDictionary () |
unsigned | GetNextH450CallIdentityValue () const |
PINDEX | GetCleanerThreadStackSize () const |
PINDEX | GetListenerThreadStackSize () const |
PINDEX | GetSignallingThreadStackSize () const |
PINDEX | GetControlThreadStackSize () const |
PINDEX | GetChannelThreadStackSize () const |
PINDEX | GetRasThreadStackSize () const |
PINDEX | GetJitterThreadStackSize () const |
PThread::Priority | GetChannelThreadPriority () const |
Connection management | |
BOOL | StartListener (H323Listener *listener) |
BOOL | StartListener (const H323TransportAddress &iface) |
BOOL | StartListeners (const H323TransportAddressArray &ifaces) |
BOOL | RemoveListener (H323Listener *listener) |
H323TransportAddressArray | GetInterfaceAddresses (BOOL excludeLocalHost=TRUE, H323Transport *associatedTransport=NULL) |
H323Connection * | MakeCall (const PString &remoteParty, PString &token, void *userData=NULL) |
H323Connection * | MakeCall (const PString &remoteParty, H323Transport *transport, PString &token, void *userData=NULL) |
H323Connection * | MakeCallLocked (const PString &remoteParty, PString &token, void *userData=NULL, H323Transport *transport=NULL) |
virtual H323Connection * | SetupTransfer (const PString &token, const PString &callIdentity, const PString &remoteParty, PString &newToken, void *userData=NULL) |
void | TransferCall (const PString &token, const PString &remoteParty, const PString &callIdentity=PString::Empty()) |
void | ConsultationTransfer (const PString &primaryCallToken, const PString &secondaryCallToken) |
void | HoldCall (const PString &token, BOOL localHold) |
H323Connection * | IntrudeCall (const PString &remoteParty, PString &token, unsigned capabilityLevel, void *userData=NULL) |
H323Connection * | IntrudeCall (const PString &remoteParty, H323Transport *transport, PString &token, unsigned capabilityLevel, void *userData=NULL) |
BOOL | ParsePartyName (const PString &party, PString &alias, H323TransportAddress &address) |
virtual BOOL | ClearCall (const PString &token, H323Connection::CallEndReason reason=H323Connection::EndedByLocalUser) |
virtual BOOL | ClearCallSynchronous (const PString &token, H323Connection::CallEndReason reason=H323Connection::EndedByLocalUser) |
virtual BOOL | ClearCallSynchronous (const PString &token, H323Connection::CallEndReason reason, PSyncPoint *sync) |
virtual void | ClearAllCalls (H323Connection::CallEndReason reason=H323Connection::EndedByLocalUser, BOOL wait=TRUE) |
virtual BOOL | HasConnection (const PString &token) |
H323Connection * | FindConnectionWithLock (const PString &token) |
PStringList | GetAllConnections () |
virtual BOOL | OnIncomingCall (H323Connection &connection, const H323SignalPDU &setupPDU, H323SignalPDU &alertingPDU) |
virtual BOOL | OnIncomingCall (H323Connection &connection, const H323SignalPDU &setupPDU, H323SignalPDU &alertingPDU, H323Connection::CallEndReason &reason) |
virtual BOOL | OnCallTransferInitiate (H323Connection &connection, const PString &remoteParty) |
virtual BOOL | OnCallTransferIdentify (H323Connection &connection) |
virtual void | OnSendARQ (H323Connection &conn, H225_AdmissionRequest &arq) |
virtual H323Connection::AnswerCallResponse | OnAnswerCall (H323Connection &connection, const PString &callerName, const H323SignalPDU &setupPDU, H323SignalPDU &connectPDU) |
virtual BOOL | OnAlerting (H323Connection &connection, const H323SignalPDU &alertingPDU, const PString &user) |
virtual BOOL | OnConnectionForwarded (H323Connection &connection, const PString &forwardParty, const H323SignalPDU &pdu) |
virtual BOOL | ForwardConnection (H323Connection &connection, const PString &forwardParty, const H323SignalPDU &pdu) |
virtual void | OnConnectionEstablished (H323Connection &connection, const PString &token) |
virtual BOOL | IsConnectionEstablished (const PString &token) |
virtual void | OnConnectionCleared (H323Connection &connection, const PString &token) |
virtual H323Connection * | OnIncomingConnection (H323Transport *transport, H323SignalPDU &setupPDU) |
virtual BOOL | OnOutgoingCall (H323Connection &conn, const H323SignalPDU &connectPDU) |
virtual H323Connection * | CreateConnection (unsigned callReference, void *userData, H323Transport *transport, H323SignalPDU *setupPDU) |
virtual H323Connection * | CreateConnection (unsigned callReference, void *userData) |
virtual H323Connection * | CreateConnection (unsigned callReference) |
virtual void | CleanUpConnections () |
static PString | BuildConnectionToken (const H323Transport &transport, unsigned callReference, BOOL fromRemote) |
Public Types | |
enum | { DefaultTcpPort = 1720 } |
Public Member Functions | |
Construction | |
H323EndPoint () | |
~H323EndPoint () | |
virtual void | SetEndpointTypeInfo (H225_EndpointType &info) const |
virtual void | SetVendorIdentifierInfo (H225_VendorIdentifier &info) const |
virtual void | SetH221NonStandardInfo (H225_H221NonStandard &info) const |
Capabilities | |
void | AddCapability (H323Capability *capability) |
PINDEX | SetCapability (PINDEX descriptorNum, PINDEX simultaneous, H323Capability *cap) |
PINDEX | AddAllCapabilities (PINDEX descriptorNum, PINDEX simultaneous, const PString &name) |
void | AddAllUserInputCapabilities (PINDEX descriptorNum, PINDEX simultaneous) |
void | RemoveCapabilities (const PStringArray &codecNames) |
void | ReorderCapabilities (const PStringArray &preferenceOrder) |
H323Capability * | FindCapability (const H245_Capability &cap) const |
H323Capability * | FindCapability (const H245_DataType &dataType) const |
H323Capability * | FindCapability (H323Capability::MainTypes mainType, unsigned subType) const |
Gatekeeper management | |
BOOL | UseGatekeeper (const PString &address=PString::Empty(), const PString &identifier=PString::Empty(), const PString &localAddress=PString::Empty()) |
BOOL | SetGatekeeper (const PString &address, H323Transport *transport=NULL) |
BOOL | SetGatekeeperZone (const PString &address, const PString &identifier, H323Transport *transport=NULL) |
BOOL | LocateGatekeeper (const PString &identifier, H323Transport *transport=NULL) |
BOOL | DiscoverGatekeeper (H323Transport *transport=NULL) |
virtual H323Gatekeeper * | CreateGatekeeper (H323Transport *transport) |
H323Gatekeeper * | GetGatekeeper () const |
BOOL | IsRegisteredWithGatekeeper () const |
BOOL | RemoveGatekeeper (int reason=-1) |
virtual void | SetGatekeeperPassword (const PString &password) |
virtual const PString & | GetGatekeeperPassword () const |
virtual H235Authenticators | CreateAuthenticators () |
virtual void | OnGatekeeperConfirm () |
virtual void | OnGatekeeperReject () |
virtual void | OnRegistrationConfirm () |
virtual void | OnRegistrationReject () |
Logical Channels management | |
virtual BOOL | OnStartLogicalChannel (H323Connection &connection, H323Channel &channel) |
virtual void | OnClosedLogicalChannel (H323Connection &connection, const H323Channel &channel) |
virtual BOOL | OpenAudioChannel (H323Connection &connection, BOOL isEncoding, unsigned bufferSize, H323AudioCodec &codec) |
virtual BOOL | OpenVideoChannel (H323Connection &connection, BOOL isEncoding, H323VideoCodec &codec) |
virtual void | OnRTPStatistics (const H323Connection &connection, const RTP_Session &session) const |
Indications | |
virtual void | OnUserInputString (H323Connection &connection, const PString &value) |
virtual void | OnUserInputTone (H323Connection &connection, char tone, unsigned duration, unsigned logicalChannel, unsigned rtpTimestamp) |
virtual void | OnGatekeeperNATDetect (PIPSocket::Address publicAddr, PString &gkIdentifier, H323TransportAddress &gkRouteAddress) |
Service Control | |
virtual void | OnHTTPServiceControl (unsigned operation, unsigned sessionId, const PString &url) |
virtual void | OnCallCreditServiceControl (const PString &amount, BOOL mode) |
virtual void | OnServiceControlSession (unsigned type, unsigned sessionid, const H323ServiceControlSession &session, H323Connection *connection) |
virtual H323ServiceControlSession * | CreateServiceControlSession (const H225_ServiceControlDescriptor &contents) |
Other services | |
virtual OpalT120Protocol * | CreateT120ProtocolHandler (const H323Connection &connection) const |
virtual OpalT38Protocol * | CreateT38ProtocolHandler (const H323Connection &connection) const |
Additional call services | |
virtual BOOL | OnConferenceInvite (const H323SignalPDU &setupPDU) |
virtual BOOL | OnCallIndependentSupplementaryService (const H323SignalPDU &setupPDU) |
virtual BOOL | OnNegotiateConferenceCapabilities (const H323SignalPDU &setupPDU) |
Static Public Attributes | |
static BYTE | defaultT35CountryCode |
static BYTE | defaultT35Extension |
static WORD | defaultManufacturerCode |
Protected Member Functions | |
H323Gatekeeper * | InternalCreateGatekeeper (H323Transport *transport) |
BOOL | InternalRegisterGatekeeper (H323Gatekeeper *gk, BOOL discovered) |
H323Connection * | FindConnectionWithoutLocks (const PString &token) |
virtual H323Connection * | InternalMakeCall (const PString &existingToken, const PString &callIdentity, unsigned capabilityLevel, const PString &remoteParty, H323Transport *transport, PString &token, void *userData) |
Protected Attributes | |
PStringList | localAliasNames |
H323AudioCodec::SilenceDetectionMode | defaultSilenceDetection |
unsigned | minAudioJitterDelay |
unsigned | maxAudioJitterDelay |
PString | videoChannelPlayDevice |
PString | videoChannelRecordDevice |
BOOL | autoStartReceiveVideo |
BOOL | autoStartTransmitVideo |
BOOL | autoStartReceiveFax |
BOOL | autoStartTransmitFax |
BOOL | autoCallForward |
BOOL | disableFastStart |
BOOL | disableH245Tunneling |
BOOL | disableH245inSetup |
BOOL | disableDetectInBandDTMF |
BOOL | canDisplayAmountString |
BOOL | canEnforceDurationLimit |
unsigned | callIntrusionProtectionLevel |
H323Connection::SendUserInputModes | defaultSendUserInputMode |
BYTE | rtpIpTypeofService |
BYTE | tcpIpTypeofService |
PTimeInterval | signallingChannelConnectTimeout |
PTimeInterval | signallingChannelCallTimeout |
PTimeInterval | controlChannelStartTimeout |
PTimeInterval | endSessionTimeout |
PTimeInterval | masterSlaveDeterminationTimeout |
unsigned | masterSlaveDeterminationRetries |
PTimeInterval | capabilityExchangeTimeout |
PTimeInterval | logicalChannelTimeout |
PTimeInterval | requestModeTimeout |
PTimeInterval | roundTripDelayTimeout |
PTimeInterval | roundTripDelayRate |
PTimeInterval | noMediaTimeout |
PTimeInterval | gatekeeperRequestTimeout |
unsigned | gatekeeperRequestRetries |
PTimeInterval | rasRequestTimeout |
unsigned | rasRequestRetries |
PTimeInterval | registrationTimeToLive |
PString | gkAccessTokenOID |
unsigned | initialBandwidth |
BOOL | clearCallOnRoundTripFail |
H323EndPoint::PortInfo | tcpPorts |
H323EndPoint::PortInfo | udpPorts |
H323EndPoint::PortInfo | rtpIpPorts |
BYTE | t35CountryCode |
BYTE | t35Extension |
WORD | manufacturerCode |
TerminalTypes | terminalType |
PTimeInterval | callTransferT1 |
PTimeInterval | callTransferT2 |
PTimeInterval | callTransferT3 |
PTimeInterval | callTransferT4 |
PTimeInterval | callIntrusionT1 |
PTimeInterval | callIntrusionT2 |
PTimeInterval | callIntrusionT3 |
PTimeInterval | callIntrusionT4 |
PTimeInterval | callIntrusionT5 |
PTimeInterval | callIntrusionT6 |
H323CallIdentityDict | secondaryConnectionsActive |
PAtomicInteger | nextH450CallIdentity |
PINDEX | cleanerThreadStackSize |
Next available callIdentity for H450 Transfer operations via consultation. | |
PINDEX | listenerThreadStackSize |
PINDEX | signallingThreadStackSize |
PINDEX | controlThreadStackSize |
PINDEX | logicalThreadStackSize |
PINDEX | rasThreadStackSize |
PINDEX | jitterThreadStackSize |
PThread::Priority | channelThreadPriority |
H323ListenerList | listeners |
H323Capabilities | capabilities |
H323Gatekeeper * | gatekeeper |
PString | gatekeeperPassword |
H323ConnectionDict | connectionsActive |
PMutex | connectionsMutex |
PMutex | noMediaMutex |
PStringSet | connectionsToBeCleaned |
H323ConnectionsCleaner * | connectionsCleaner |
PSyncPoint | connectionsAreCleaned |
Classes | |
struct | PortInfo |
The main thing this class embodies is the capabilities of the application, that is the codecs and protocols it is capable of.
An application may create a descendent off this class and overide the CreateConnection() function, if they require a descendent of H323Connection to be created. This would be quite likely in most applications.
|
|
|
Endpoint types. |
|
Create a new endpoint. |
|
Destroy endpoint. |
|
Add an alias name to be used for the local end of any connections. If the alias name already exists in the list then is is not added again. The list defaults to the value set in the SetLocalUserName() function. Note that calling SetLocalUserName() will clear the alias list.
|
|
Add all matching capabilities in list. All capabilities that match the specified name are added. See the capabilities code for details on the matching algorithm.
|
|
Add all user input capabilities to this endpoints capability table.
|
|
Add a codec to the capabilities table. This will assure that the assignedCapabilityNumber field in the codec is unique for all codecs installed on this endpoint. If the specific instnace of the capability is already in the table, it is not added again. Ther can be multiple instances of the same capability class however.
|
|
Build a unique token for the connection. This identifies the call using the Q931 transport host name and the Q931 call reference number.
|
|
See if should automatically do call forward of connection. |
|
See if should auto-start receive fax channels on connection. |
|
See if should auto-start receive video channels on connection. |
|
See if should auto-start transmit fax channels on connection. |
|
See if should auto-start transmit video channels on connection. |
|
Get the flag indicating the endpoint can display an amount string. |
|
Get the flag indicating the call will automatically clear after a time. |
|
Clean up connections. This function is called from a background thread and checks for closed connections to clean up. This would not normally be called by an application. |
|
Clear all current connections. This hangs up all the connections to remote endpoints. The wait parameter is used to wait for all the calls to be cleared and their memory usage cleaned up before returning. This is typically used in the destructor for your descendant of H323EndPoint.
|
|
Clear a current connection. This hangs up the connection to a remote endpoint. Note that this function is asynchronous
|
|
|
|
Clear a current connection. This hangs up the connection to a remote endpoint. Note that these functions are synchronous
|
|
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).
|
|
Create a list of authenticators for gatekeeper. |
|
|
|
|
|
Create a connection that uses the specified call reference.
|
|
Create a gatekeeper. This allows the application writer to have the gatekeeper as a descendent of the H323Gatekeeper in order to add functionality to the base capabilities in the library. The default creates an instance of the H323Gatekeeper class.
|
|
Create the service control session object. |
|
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 it should return a pointer to a heap variable (using new) as it will be automatically deleted when the H323Connection is deleted. The default behavour returns NULL.
|
|
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 it should return a pointer to a heap variable (using new) as it will be automatically deleted when the H323Connection is deleted. The default behavour returns NULL.
|
|
Get the detect in-band DTMF flag. |
|
Set the detect in-band DTMF flag.
|
|
Set the default fast start mode.
|
|
Set the default H.245 tunneling mode.
|
|
Set the default H.245 tunneling mode.
|
|
Discover and select gatekeeper. This function will use the automatic gatekeeper discovery methods to locate the first gatekeeper on a particular transport. Note the transport being passed in will be deleted becomes owned by the H323Gatekeeper created by this function and will be deleted by it. Also if transport is NULL then a H323TransportUDP is created.
|
|
Find a capability that has been registered.
|
|
Find a capability that has been registered.
|
|
Find a capability that has been registered.
|
|
Find a connection that uses the specified token. This searches the endpoint for the connection that contains the token as provided by functions such as MakeCall() (as built by the BuildConnectionToken() function). if not found it will then search for the string representation of the CallIdentifier for the connection, and finally try for the string representation of the ConferenceIdentifier. Note the caller of this function MUSt call the H323Connection::Unlock() function if this function returns a non-NULL pointer. If it does not then a deadlock can occur.
|
|
|
|
Forward the call using the same token as the specified connection. Return TRUE if the call is being redirected. The default behaviour will replace the current call in the endpoints call list using the same token as the call being redirected. Not that even though the same token is being used the actual object is completely mad anew.
|
|
Get the user name to be used for the local end of any connections. This defaults to the logged in user as obtained from the PProcess::GetUserName() function. |
|
Get all calls current on the endpoint. |
|
Get the dictionary of <callIdentities, connections> |
|
Get Call Intrusion Protection Level of the end point. |
|
Get Call Intrusion timers timeout |
|
|
|
|
|
|
|
|
|
|
|
Get the default timeout for Call Transfer Timer CT-T1. |
|
Get the default timeout for Call Transfer Timer CT-T2. |
|
Get the default timeout for Call Transfer Timer CT-T3. |
|
Get the default timeout for Call Transfer Timer CT-T4. |
|
Get the current capability table for this endpoint. |
|
Get the default timeout for H245 capability exchange negotiations. |
|
Get the priority at which channel threads run |
|
Get the default stack size of logical channel threads. |
|
Get the default stack size of cleaner threads. |
|
Get the default timeout for incoming H.245 connection. |
|
Get the default stack size of control channel threads. |
|
Get the default timeout for waiting on an end session. |
|
Get the gatekeeper we are registered with. |
|
Get the H.235 password for the gatekeeper. |
|
Get the default retries for GatekeeperRequest and Gatekeeper discovery. |
|
Get the default timeout for GatekeeperRequest and Gatekeeper discovery. |
|
Get the default time for gatekeeper to reregister. A value of zero disables the keep alive facility. |
|
Get the iNow Gatekeeper Access Token OID. |
|
Get the initial bandwidth parameter. |
|
Return a list of the transport addresses for all listeners on this endpoint
|
|
Get the default stack size of jitter buffer threads. |
|
Get the set of listeners (incoming call transports) for this endpoint. |
|
Get the default stack size of listener threads. |
|
Get the user name to be used for the local end of any connections. This defaults to the logged in user as obtained from the PProcess::GetUserName() function. |
|
Get the default timeout for H245 logical channel negotiations. |
|
Get the default retries for H245 master slave negotiations. |
|
Get the default timeout for master slave negotiations. |
|
Get the default maximum audio delay jitter parameter. Defaults to 250ms. |
|
Get the default maximum audio jitter delay parameter. Defaults to 50ms |
|
Get the next available invoke Id for H450 operations |
|
Get the next TCP port number for H.245 channels |
|
Get the next UDP port number for RAS channels |
|
Get the amount of time with no media that should cause call to clear |
|
Get the default retries for RAS protocol transations. |
|
Get the default timeout for RAS protocol transactions. |
|
Get the default stack size of RAS channel threads. |
|
Get the default timeout for H245 request mode negotiations. |
|
Get the default rate H245 round trip delay is calculated by connection. |
|
Get the default timeout for H245 round trip delay negotiations. |
|
Get the UDP port number base for RTP channels. |
|
Get the max UDP port number for RTP channels. |
|
Get the UDP port number pair for RTP channels. |
|
Get the IP Type Of Service byte for RTP channels. |
|
Get the default mode for sending User Input Indications. |
|
Get the default timeout for calling another endpoint. |
|
Get the default timeout for connecting via TCP |
|
Get the default stack size of signalling channel threads. |
|
Get the default silence detection mode. |
|
Get the IP Type Of Service byte for TCP channels. |
|
Get the TCP port number base for H.245 channels |
|
Get the TCP port number base for H.245 channels. |
|
Get the endpoint terminal type. |
|
Get the UDP port number base for RAS channels |
|
Get the UDP port number base for RAS channels. |
|
Determine if a connection is active.
|
|
Place the call on hold, suspending all media channels (H.450.4) NOTE: Only Local Hold is implemented so far.
|
|
|
|
|
|
|
|
|
|
|
|
Initiate Call intrusion Designed similar to MakeCall function
|
|
Determine if a connection is established.
|
|
Get the default fast start mode. |
|
Determine if endpoint is gatekeeper type. |
|
Determine if endpoint is gateway type. |
|
Get the default H.245 tunneling mode. |
|
Get the default H.245 tunneling mode. |
|
Determine if the address is "local", ie does not need STUN |
|
Determine if endpoint is gatekeeper type. |
|
Return if endpoint is registered with gatekeeper. |
|
Determine if endpoint is terminal type. |
|
Locate and select gatekeeper. This function will use the automatic gatekeeper discovery methods to locate the gatekeeper on the particular transport that has the specified gatekeeper identifier name. This is often the "Zone" for the gatekeeper. Note the transport being passed in will be deleted becomes owned by the H323Gatekeeper created by this function and will be deleted by it. Also if transport is NULL then a H323TransportUDP is created.
|
|
Make a call to a remote party using the specified transport. The remoteParty may be a hostname, alias or other user name that is to be passed to the transport, if present. If the transport parameter is NULL the transport is determined from the remoteParty description. This function returns almost immediately with the call occurring in a new background thread. Note that the call could be created and cleared ie OnConnectionCleared is called BEFORE this function returns. It is guaranteed that the token variable is set before OnConnectionCleared called. Note, the returned pointer to the connection is not locked and may be deleted at any time. This is extremely unlikely immediately after the function is called, but you should not keep this pointer beyond that brief time. The the FindConnectionWithLock() function for future references to the connection object. It is recommended that MakeCallLocked() be usedin instead.
|
|
Make a call to a remote party. An appropriate transport is determined from the remoteParty parameter. The general form for this parameter is [alias@][transport$]host[:port] where the default alias is the same as the host, the default transport is "ip" and the default port is 1720. This function returns almost immediately with the call occurring in a new background thread. Note that the call could be created and cleared ie OnConnectionCleared is called BEFORE this function returns. It is guaranteed that the token variable is set before OnConnectionCleared called. Note, the returned pointer to the connection is not locked and may be deleted at any time. This is extremely unlikely immediately after the function is called, but you should not keep this pointer beyond that brief time. The the FindConnectionWithLock() function for future references to the connection object. It is recommended that MakeCallLocked() be usedin instead.
|
|
Make a call to a remote party using the specified transport. The remoteParty may be a hostname, alias or other user name that is to be passed to the transport, if present. If the transport parameter is NULL the transport is determined from the remoteParty description. This function returns almost immediately with the call occurring in a new background thread. However the call will not progress very far
|
|
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 simply returns TRUE.
|
|
Call back for answering an incoming call. This function is called from the OnReceivedSignalSetup() function before it sends the Connect PDU. It gives an opportunity for an application to alter the reply before transmission to the other endpoint. It also gives an 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 a Release Complete PDU is sent. If AnswerCallNow is returned then the H.323 protocol proceeds. Finally if AnswerCallPending is returned then the protocol negotiations are paused until the AnsweringCall() function is called. The default behaviour simply returns AnswerNow.
|
|
Call back for call credit information. An application may override this to display call credit information on registration, or when a call is started. The canDisplayAmountString member variable must also be set to TRUE for this to operate. The default behaviour does nothing.
|
|
Called when an endpoint receives a SETUP PDU with a conference goal of "callIndependentSupplementaryService" The default behaviour is to return FALSE, which will close the connection |
|
Handle a transfer via consultation. This gives the transferred-to user an opportunity to abort the transfer. The default behaviour just returns TRUE.
|
|
Handle a connection transfer. This gives the application an opportunity to abort the transfer. The default behaviour just returns TRUE.
|
|
Call back for closed a logical channel. The default behaviour does nothing.
|
|
Called when an endpoint receives a SETUP PDU with a conference goal of "invite" The default behaviour is to return FALSE, which will close the connection |
|
A call back function whenever a connection is broken. This indicates that a connection to a remote endpoint is no longer available. The default behaviour does nothing.
|
|
A call back function whenever a connection is established. This indicates that a connection to a remote endpoint was established with a control channel and zero or more logical channels. The default behaviour does nothing.
|
|
A call back function when a connection indicates it is to be forwarded. An H323 application may handle this call back so it can make complicated decisions on if the call forward ius to take place. If it decides to do so it must call MakeCall() and return TRUE. The default behaviour simply returns FALSE and that the automatic call forwarding should take place. See ForwardConnection()
|
|
Called when the gatekeeper sends a GatekeeperConfirm |
|
Call back from GK admission confirm to notify the Endpoint it is behind a NAT (GNUGK Gatekeeper) The default does nothing. Override this to notify the user they are behind a NAT.
|
|
Called when the gatekeeper sends a GatekeeperReject |
|
Call back for HTTP based Service Control. An application may override this to use an HTTP based channel using a resource designated by the session ID. For example the session ID can correspond to a browser window and the The default behaviour does nothing.
|
|
|
|
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 simply returns TRUE.
|
|
Handle a new incoming connection. This will examine the setup PDU and either attach the signalling transport to an existing connection that has the same Q.931 call reference, or creates a new connection using CreateConnection().
|
|
Called when an endpoint receives a SETUP PDU with a conference goal of "capability_negotiation" The default behaviour is to return FALSE, which will close the connection |
|
Called when an outgoing call connects If FALSE is returned the connection is aborted and a Release Complete PDU is sent. The default behaviour simply returns TRUE. |
|
Called from H.450 OnReceivedInitiateReturnError |
|
Called when an incoming PDU contains a feature set |
|
Called when the gatekeeper sends a RegistrationConfirm |
|
Called when the gatekeeper sends a RegistrationReject |
|
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 does nothing.
|
|
Callback for ARQ send to a gatekeeper. This allows the endpoint to change or check fields in the ARQ before it is sent. |
|
Called when an outgoing PDU requires a feature set |
|
Handle incoming service control session information. Default behaviour calls session.OnChange() |
|
Call back for opening a logical channel. The default behaviour simply returns TRUE.
|
|
Call back for remote enpoint has sent user input as a string. The default behaviour does nothing.
|
|
Call back for remote enpoint has sent user input. The default behaviour calls H323Connection::OnUserInputTone().
|
|
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 function creates a PSoundChannel using the member variables soundChannelPlayDevice or soundChannelRecordDevice.
|
|
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 (which is one frame in a video stream - YUV411 format). The default function creates a PVideoChannel using the member variables.
|
|
Parse a party address into alias and transport components. An appropriate transport is determined from the remoteParty parameter. The general form for this parameter is [alias@][transport$]host[:port] where the default alias is the same as the host, the default transport is "ip" and the default port is 1720.
|
|
Remove an alias name used for the local end of any connections. defaults to an empty list.
|
|
Remove capabilites in table. |
|
Unregister and delete the gatekeeper we are registered with. The return value indicates FALSE if there was an error during the unregistration. However the gatekeeper is still removed and its instance deleted regardless of this error.
|
|
Remove a listener from the endpoint. If the listener parameter is NULL then all listeners are removed.
|
|
Reorder capabilites in table. |
|
Set the maximum audio delay jitter parameter.
|
|
Set Call Intrusion Protection Level of the end point.
|
|
Set the flag indicating the endpoint can display an amount string.
|
|
Set the flag indicating the call will automatically clear after a time.
|
|
Set the capability descriptor lists. This is three tier set of codecs. The top most level is a list of particular capabilities. Each of these consists of a list of alternatives that can operate simultaneously. The lowest level is a list of codecs that cannot operate together. See H323 section 6.2.8.1 and H245 section 7.2 for details. If descriptorNum is P_MAX_INDEX, the the next available index in the array of descriptors is used. Similarly if simultaneous is P_MAX_INDEX the the next available SimultaneousCapabilitySet is used. The return value is the index used for the new entry. Note if both are P_MAX_INDEX then the return value is the descriptor index as the simultaneous index must be zero. Note that the capability specified here is automatically added to the capability table using the AddCapability() function. A specific instance of a capability is only ever added once, so multiple SetCapability() calls with the same H323Capability pointer will only add that capability once.
|
|
Set the endpoint information in H225 PDU's. |
|
Select and register with an explicit gatekeeper. This will use the specified transport and a string giving a transport dependent address to locate a specific gatekeeper. The endpoint will register with that gatekeeper and, if successful, set it as the current gatekeeper used by this endpoint. Note the transport being passed in will be deleted by this function or the H323Gatekeeper object it becomes associated with. Also if transport is NULL then a H323TransportUDP is created.
|
|
Set the H.235 password for the gatekeeper. |
|
Select and register with an explicit gatekeeper and zone. This will use the specified transport and a string giving a transport dependent address to locate a specific gatekeeper. The endpoint will register with that gatekeeper and, if successful, set it as the current gatekeeper used by this endpoint. The gatekeeper identifier is set to the spplied parameter to allow the gatekeeper to either allocate a zone or sub-zone, or refuse to register if the zones do not match. Note the transport being passed in will be deleted by this function or the H323Gatekeeper object it becomes associated with. Also if transport is NULL then a H323TransportUDP is created.
|
|
Set the iNow Gatekeeper Access Token OID. |
|
Set the H221NonStandard information in H225 PDU's. |
|
Get the initial bandwidth parameter. |
|
Set the user name to be used for the local end of any connections. This defaults to the logged in user as obtained from the PProcess::GetUserName() function. Note that this name is technically the first alias for the endpoint. Additional aliases may be added by the use of the AddAliasName() function, however that list will be cleared when this function is used.
|
|
Set the amount of time with no media that should cause call to clear |
|
Set the UDP port number base and max for RTP channels. |
|
Set the IP Type Of Service byte for RTP channels. |
|
Set the default mode for sending User Input Indications. |
|
Set the default silence detection mode.
|
|
Set the IP Type Of Service byte for TCP channels. |
|
Set the TCP port number base and max for H.245 channels. |
|
Set the TCP port number base and max for H.245 channels. |
|
Setup the transfer of an existing call (connection) to a new remote party using H.450.2. This sends a Call Transfer Setup Invoke message from the B-Party (transferred endpoint) to the C-Party (transferred-to endpoint). If the transport parameter is NULL the transport is determined from the remoteParty description. The general form for this parameter is [alias@][transport$]host[:port] where the default alias is the same as the host, the default transport is "ip" and the default port is 1720. This function returns almost immediately with the transfer occurring in a new background thread. Note, the returned pointer to the connection is not locked and may be deleted at any time. This is extremely unlikely immediately after the function is called, but you should not keep this pointer beyond that brief time. The the FindConnectionWithLock() function for future references to the connection object. This function is declared virtual to allow an application to override the function and get the new call token of the forwarded call.
|
|
Set the vendor information in H225 PDU's. |
|
Get the flag for clearing a call if the round trip delay calculation fails. |
|
Add a listener to the endpoint. This allows for the automatic creating of incoming call connections. An application should use OnConnectionEstablished() to monitor when calls have arrived and been successfully negotiated. If a listener already exists on the same address then it is ignored, but TRUE is still returned. If the iface string is empty then "*" is assumed which will listen on the standard TCP port on INADDR_ANY.
|
|
Add a listener to the endpoint. This allows for the automatic creating of incoming call connections. An application should use OnConnectionEstablished() to monitor when calls have arrived and been successfully negotiated. Note if this returns TRUE, then the endpoint is responsible for deleting the H323Listener listener object. If FALSE is returned then the object is not deleted and it is up to the caller to release the memory allocated for the object. If a listener already exists on the same transport address then it is ignored, but TRUE is still returned. The caller does not need to delete the object.
|
|
Add listeners to the endpoint. Set the collection of listeners which will allow the automatic creating of incoming call connections. An application should use OnConnectionEstablished() to monitor when calls have arrived and been successfully negotiated. If a listener already exists on the interface specified in the list then it is ignored. If a listener does not yet exist a new one is created and if a listener is running that is not in the list then it is stopped and removed. If the array is empty then the string "*" is assumed which will listen on the standard TCP port on INADDR_ANY. Returns TRUE if at least one interface was successfully started.
|
|
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).
|
|
Provide TCP address translation hook |
|
Use and register with an explicit gatekeeper. This will call other functions according to the following table: address identifier function empty empty DiscoverGatekeeper() non-empty empty SetGatekeeper() empty non-empty LocateGatekeeper() non-empty non-empty SetGatekeeperZone() The localAddress field, if non-empty, indicates the interface on which to look for the gatekeeper. An empty string is equivalent to "ip$*:*" which is any interface or port. If the endpoint is already registered with a gatekeeper that meets the same criteria then the gatekeeper is not changed, otherwise it is deleted (with unregistration) and new one created and registered to.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Call Intrusion Timers |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Next available callIdentity for H450 Transfer operations via consultation.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
default settings H.221 settings |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|