class H225_RAS: public PObject

This class embodies the H2250 RAS protocol to/from gatekeepers

Inheritance:


Public Classes

[more]enum State
Sub-state for call transfer
[more]enum State
Sub-state for call hold

Public Methods

[more]void SendReturnError (int returnError)
Send a return error in response to an invoke operation
[more]void AddOpCode ( unsigned opcode, H450xHandler * handler )
Add a handler for the op code
[more]virtual void HandlePDU ( const H323SignalPDU & pdu )
Handle the H450x Supplementary Service PDU if present in the H225_H323_UU_PDU
[more]virtual void OnReceivedInvoke (X880_Invoke& invoke)
Handle an incoming X880 Invoke PDU.
[more]virtual void OnReceivedReturnResult (X880_ReturnResult& returnResult)
Handle an incoming X880 Return Result PDU.
[more]virtual void OnReceivedReturnError (X880_ReturnError& returnError)
Handle an incoming X880 Return Error PDU.
[more]virtual void OnReceivedReject (X880_Reject& reject)
Handle an incoming X880 Reject PDU.
[more]void SendReturnError (int invokeId, int returnError)
Send a return error in response to an invoke operation
[more]int GetNextInvokeId () const
Get the next available invoke Id for H450 operations
[more]virtual void OnReceivedCallTransferIdentify ( int linkedId )
Handle an incoming Call Transfer Identify operation.
[more]virtual void OnReceivedCallTransferAbandon ( int linkedId )
Handle an incoming Call Transfer Abandon operation.
[more]virtual void OnReceivedCallTransferInitiate ( int linkedId, PASN_OctetString * argument )
Handle an incoming Call Transfer Initiate operation.
[more]virtual void OnReceivedCallTransferSetup ( int linkedId, PASN_OctetString * argument )
Handle an incoming Call Transfer Setup operation.
[more]virtual void OnReceivedCallTransferUpdate ( int linkedId, PASN_OctetString * argument )
Handle an incoming Call Transfer Update operation.
[more]virtual void OnReceivedSubaddressTransfer ( int linkedId, PASN_OctetString * argument )
Handle an incoming Subaddress Transfer operation.
[more]virtual void OnReceivedCallTransferComplete ( int linkedId, PASN_OctetString * argument )
Handle an incoming Call Transfer Complete operation.
[more]virtual void OnReceivedCallTransferActive ( int linkedId, PASN_OctetString * argument )
Handle an incoming Call Transfer Active operation.
[more]void TransferCall ( const PString & remoteParty )
Initiate the transfer of an existing call (connection) to a new remote party using H4502.
[more]State GetState () const
Get the current call transfer state
[more]virtual void OnReceivedLocalCallHold ( int linkedId )
Handle an incoming Near-End Call Hold operation
[more]virtual void OnReceivedLocalCallRetrieve ( int linkedId )
Handle an incoming Near-End Call Retrieve operation
[more]virtual void OnReceivedRemoteCallHold ( int linkedId )
Handle an incoming Remote Call Hold operation TBD: Remote hold operations not yet implemented -- dcassel 4/01
[more]virtual void OnReceivedRemoteCallRetrieve ( int linkedId )
Handle an incoming Remote Call Retrieve operation TBD: Remote hold operations not yet implemented -- dcassel 4/01
[more]void HoldCall ( BOOL localHold )
Place the call on hold, suspending all media channels (H4504) NOTE: Only Local Hold is implemented so far.
[more]void RetrieveCall ( bool localHold )
Retrieve the call from hold, activating all media channels (H4504) NOTE: Only Local Hold is implemented so far.

Public

[more] Construction
[more] Operations
[more] Protocol callbacks
[more] Member variable access


Documentation

This class embodies the H2250 RAS protocol to/from gatekeepers
ovoid SendReturnError(int returnError)
Send a return error in response to an invoke operation

ovoid AddOpCode( unsigned opcode, H450xHandler * handler )
Add a handler for the op code

ovirtual void HandlePDU( const H323SignalPDU & pdu )
Handle the H450x Supplementary Service PDU if present in the H225_H323_UU_PDU

ovirtual void OnReceivedInvoke(X880_Invoke& invoke)
Handle an incoming X880 Invoke PDU. The default behaviour is to attempt to decode the invoke operation and call the corresponding OnReceived<Operation> method on the EndPoint.

ovirtual void OnReceivedReturnResult(X880_ReturnResult& returnResult)
Handle an incoming X880 Return Result PDU. The default behaviour is to attempt to match the return result to a previous invoke operation and call the corresponding OnReceived<Operation>Success method on the EndPoint.

ovirtual void OnReceivedReturnError(X880_ReturnError& returnError)
Handle an incoming X880 Return Error PDU. The default behaviour is to attempt to match the return error to a previous invoke operation and call the corresponding OnReceived<Operation>Error method on the EndPoint.

ovirtual void OnReceivedReject(X880_Reject& reject)
Handle an incoming X880 Reject PDU. The default behaviour is to attempt to match the reject to a previous invoke, return result or return error operation and call OnReceived<Operation>Reject method on the EndPoint.

ovoid SendReturnError(int invokeId, int returnError)
Send a return error in response to an invoke operation

oint GetNextInvokeId() const
Get the next available invoke Id for H450 operations

ovirtual void OnReceivedCallTransferIdentify( int linkedId )
Handle an incoming Call Transfer Identify operation.
Parameters:
linkedId - InvokeId of associated operation (if any)

ovirtual void OnReceivedCallTransferAbandon( int linkedId )
Handle an incoming Call Transfer Abandon operation.
Parameters:
linkedId - InvokeId of associated operation (if any)

ovirtual void OnReceivedCallTransferInitiate( int linkedId, PASN_OctetString * argument )
Handle an incoming Call Transfer Initiate operation.
Parameters:
linkedId - InvokeId of associated operation (if any)
argument - Parameters for the initiate operation

ovirtual void OnReceivedCallTransferSetup( int linkedId, PASN_OctetString * argument )
Handle an incoming Call Transfer Setup operation.
Parameters:
linkedId - InvokeId of associated operation (if any)
argument - Parameters for the setup operation

ovirtual void OnReceivedCallTransferUpdate( int linkedId, PASN_OctetString * argument )
Handle an incoming Call Transfer Update operation.
Parameters:
linkedId - InvokeId of associated operation (if any)
argument - Parameters for the update operation

ovirtual void OnReceivedSubaddressTransfer( int linkedId, PASN_OctetString * argument )
Handle an incoming Subaddress Transfer operation.
Parameters:
linkedId - InvokeId of associated operation (if any)
argument - Parameters for the subaddress transfer operation

ovirtual void OnReceivedCallTransferComplete( int linkedId, PASN_OctetString * argument )
Handle an incoming Call Transfer Complete operation.
Parameters:
linkedId - InvokeId of associated operation (if any)
argument - Parameters for the complete operation

ovirtual void OnReceivedCallTransferActive( int linkedId, PASN_OctetString * argument )
Handle an incoming Call Transfer Active operation.
Parameters:
linkedId - InvokeId of associated operation (if any)
argument - Parameters for the active operation

ovoid TransferCall( const PString & remoteParty )
Initiate the transfer of an existing call (connection) to a new remote party using H4502. 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

oenum State
Sub-state for call transfer

oState GetState() const
Get the current call transfer state

ovirtual void OnReceivedLocalCallHold( int linkedId )
Handle an incoming Near-End Call Hold operation
Parameters:
linkedId - InvokeId of associated operation (if any)

ovirtual void OnReceivedLocalCallRetrieve( int linkedId )
Handle an incoming Near-End Call Retrieve operation
Parameters:
linkedId - InvokeId of associated operation (if any)

ovirtual void OnReceivedRemoteCallHold( int linkedId )
Handle an incoming Remote Call Hold operation TBD: Remote hold operations not yet implemented -- dcassel 4/01
Parameters:
linkedId - InvokeId of associated operation (if any)

ovirtual void OnReceivedRemoteCallRetrieve( int linkedId )
Handle an incoming Remote Call Retrieve operation TBD: Remote hold operations not yet implemented -- dcassel 4/01
Parameters:
linkedId - InvokeId of associated operation (if any)

ovoid HoldCall( BOOL localHold )
Place the call on hold, suspending all media channels (H4504) NOTE: Only Local Hold is implemented so far.
Parameters:
localHold - true for Local Hold, false for Remote Hold

ovoid RetrieveCall( bool localHold )
Retrieve the call from hold, activating all media channels (H4504) NOTE: Only Local Hold is implemented so far.
Parameters:
localHold - true for Local Hold, false for Remote Hold

oenum State
Sub-state for call hold

o Construction

o H225_RAS( H323EndPoint & endpoint, H323Transport * transport )
Create a new protocol handler.
Parameters:
endpoint - Endpoint gatekeeper is associated with.
transport - Transport over which gatekeepers communicates.

o ~H225_RAS()
Destroy protocol handler

o Operations

oBOOL StartRasChannel()
Start the background thread

ovirtual BOOL HandleRasPDU( const H323RasPDU & response )
Handle and dispatch a RAS PDU

ovirtual BOOL WritePDU( H323RasPDU & pdu )
Write PDU to transport after executing callback

o Protocol callbacks

ovirtual BOOL OnReceiveUnkown( const H323RasPDU & pdu )
Handle unknown PDU type.
Parameters:
pdu - PDU that was not handled.

ovirtual H235Authenticators GetAuthenticators() const
Get the security context for this RAS connection

o Member variable access

oH323Transport& GetTransport() const
Get the gatekeepers transport channel

oconst PString& GetIdentifier() const
Get the gatekeeper identifer. For clients at least one successful registration must have been achieved for this field to be filling in.

ovoid SetIdentifier(const PString & id)
Set the gatekeeper identifer. For servers this allows the identifier to be set and provided to all remote clients.

ovoid SetCheckResponseCryptoTokens( BOOL value )
Set flag to check all crypto tokens on responses.
Parameters:
value - New value for checking crypto tokens.

oBOOL GetCheckResponseCryptoTokens()
Get flag to check all crypto tokens on responses


Direct child classes:
H323GatekeeperListener
H323Gatekeeper

Alphabetic index HTML hierarchy of classes or Java



This page was generated with the help of DOC++.