JSR-043: JTAPI-1.4

javax.telephony.media.async
Interface Async_Delegation

All Superinterfaces:
DelegationConstants, MediaConstants, MediaServiceConstants
All Known Implementing Classes:
Base_MediaService

public interface Async_Delegation
extends DelegationConstants

Asynchronous versions of the Delegation transaction methods. These methods return Async.Events that notify when the transaction is complete, and are delivered to some MediaListener callback.

Since:
JTAPI-1.4

Fields inherited from interface javax.telephony.media.DelegationConstants
ev_Delegated, q_Released, q_Removed, q_Retrieved, q_Returned, tag_CatchAll, tag_CatchNone, tag_DestroyRequest, tag_NeverReturn, tag_NormalReturn, tag_RemoveSession, tag_SessionDeath, v_Released
 
Fields inherited from interface javax.telephony.media.MediaServiceConstants
ev_BindAndConnect, ev_BindToCall, ev_BindToServiceName, ev_BindToTerminal, ev_BindToTerminalName, ev_Configure, ev_Connected, ev_DelegateToService, ev_Disconnected, ev_GetConfigSpec, ev_GetConfiguration, ev_GetParameters, ev_GetTerminal, ev_GetTerminalName, ev_GetUserValues, ev_GroupStop, ev_Release, ev_ReleaseDelegated, ev_ReleaseToDestroy, ev_ReleaseToService, ev_ReleaseToTag, ev_Retrieve, ev_Retrieved, ev_SetParameters, ev_SetUserDictionary, ev_SetUserValues, ev_TerminalIdle, ev_TriggerRTC
 
Fields inherited from interface javax.telephony.media.MediaConstants
e_OK, q_Duration, q_Standard, q_Stop
 
Method Summary
 Async.DelegationEvent async_delegateToService(java.lang.String serviceName, int timeout, java.lang.String catchTags)
          Async version of delegateToService.
 Async.DelegationEvent async_releaseDelegated()
          Cancel the delegation that is in progress on this MediaService.
 Async.DelegationEvent async_retrieve(Symbol cause)
          Cancel the delegation that is in progress on this MediaService.
 

Method Detail

async_delegateToService

public Async.DelegationEvent async_delegateToService(java.lang.String serviceName,
                                                     int timeout,
                                                     java.lang.String catchTags)
                                              throws NotBoundException,
                                                     MediaBindException,
                                                     NotOwnerException
Async version of delegateToService.

Transfer ownership of the bound MediaGroup to another MediaService, and stay on the owner stack until the MediaGroup is returned.

Invokes onDelegateToServiceDone when complete.

Parameters:
serviceName - a String naming the service
timeout - an int specifying the timeout in milliseconds
catchTags - a String of tags to match a possible releaseTag
Returns:
an Async.DelegationEvent for onDelegateDone();
Throws:
NotBoundException - if not currently bound to a MediaGroup.
MediaBindException - a BindInProgressException if bind or release already in progress
NotOwnerException - if MediaGroup is already delegated.
See Also:
Delegation.delegateToService(java.lang.String, int, java.lang.String)

async_retrieve

public Async.DelegationEvent async_retrieve(Symbol cause)
                                     throws NotBoundException,
                                            MediaBindException,
                                            NotDelegatedException
Cancel the delegation that is in progress on this MediaService.

Async version of Delegation.retrieve(Symbol).

Invokes onRetrieveDone when complete.

Parameters:
cause - a Symbol that becomes the return value for getRetrieveCause().
Returns:
an Async.DelegationEvent for onRetrieveDone()
Throws:
NotBoundException - if not currently bound to a MediaGroup.
MediaBindException - a BindInProgressException if bind or release is already in progress
NotDelegatedException - if delegateToService is not active.
See Also:
Delegation.retrieve(javax.telephony.media.Symbol)

async_releaseDelegated

public Async.DelegationEvent async_releaseDelegated()
                                             throws NotBoundException,
                                                    MediaBindException,
                                                    NotDelegatedException
Cancel the delegation that is in progress on this MediaService. When delegateToService completes, this MediaService is not bound.

Async version of Delegation.releaseDelegated().

Invokes onRetrieveDone when complete.

Returns:
an Async.DelegationEvent for onRetrieveDone()
Throws:
NotBoundException - if not currently bound to a MediaGroup.
MediaBindException - a BindInProgressException if bind or release is already in progress
NotDelegatedException - if delegateToService is not active.
See Also:
Delegation.releaseDelegated()

JSR-043: JTAPI-1.4

Send comments to: JSR-43@ectf.org