javax.telephony.media.async
Interface Async.MediaService

All Known Implementing Classes:

Base_MediaService, BasicMediaService

Enclosing class:

Async

public static interface Async.MediaService

Asynchronous methods for a MediaService.

Async.MediaService defines a method corresponding to each synchronous MediaService method. For each synchronous methodName(arglist), the corresponding asynchronous methods is named: async_methodName, and has exactly the same arglist as the synchronous methodName.

The return values are always some Async.Event. The asynchronous methods throw the subset of Exceptions that are detected before attempting the operation of the method. The other Exceptions are delivered in the returned Async.Event when that event is done.

Method Summary

Async.BindToCallEvent	async_bindAndConnect(ConfigSpec cs, java.lang.String s1, java.lang.String s2) Async version of bindAndConnect.
Async.BindToCallEvent	async_bindToCall(ConfigSpec cs, Call call) Async version of bindToCall.
Async.BindEvent	async_bindToServiceName(ConfigSpec cs, java.lang.String serviceName) Async version of bindToServiceName.
Async.BindEvent	async_bindToTerminal(ConfigSpec cs, Terminal t1) Async version of bindToTerminal.
Async.BindEvent	async_bindToTerminalName(ConfigSpec cs, java.lang.String s1) Async version of bindToTerminalName.
Async.Event	async_cancelBindRequest() Initiate a cancelBindRequest().
Async.MediaGroupEvent	async_configure(ConfigSpec cs) Async version of MediaService.configure().
Async.MediaGroupEvent	async_getConfiguration() Async version of MediaService.getConfiguration().
Async.MediaGroupEvent	async_getParameters(Symbol[] keys) Async version of MediaService.getParameters().
Async.MediaGroupEvent	async_getTerminal() Async version of MediaService.getTerminal().
Async.MediaGroupEvent	async_getTerminalName() Async version of MediaService.getTerminalName().
Async.MediaGroupEvent	async_getUserValues(Symbol[] keys) Async version of MediaService.getUserValues().
Async.ReleaseEvent	async_release() Async version of release().
Async.ReleaseEvent	async_releaseToDestroy() Async version of releaseToDestroy().
Async.ReleaseEvent	async_releaseToService(java.lang.String serviceName, int timeout) Async version of releaseToService().
Async.ReleaseEvent	async_releaseToTag(java.lang.String returnTag) Async version of releaseToTag().
Async.MediaGroupEvent	async_setParameters(java.util.Dictionary dict) Async version of MediaService.setParameters().
Async.MediaGroupEvent	async_setUserDictionary(java.util.Dictionary dict) Async version of MediaService.setUserDictionary().
Async.MediaGroupEvent	async_setUserValues(java.util.Dictionary dict) Async version of MediaService.setUserValues().
Async.MediaGroupEvent	async_stop() Async version of MediaService.stop().
Async.MediaGroupEvent	async_triggerRTC(Symbol rtca) Deprecated. "use transactional Resource commands".

Method Detail

async_bindAndConnect

public Async.BindToCallEvent async_bindAndConnect(ConfigSpec cs,
                                                  java.lang.String s1,
                                                  java.lang.String s2)
                                           throws MediaBindException

Async version of bindAndConnect.

Parameters:

cs - a ConfigSpec object

s1 - a String specifing the origAddr

s2 - a String specifing the dialDigits

Returns:

an Async.BindToCallEvent for onBindDone();

Throws:

MediaBindException - for preconditions; AlreadyBoundException or BindInProgressException

See Also:

MediaService.bindAndConnect(javax.telephony.media.ConfigSpec, java.lang.String, java.lang.String)

async_bindToCall

public Async.BindToCallEvent async_bindToCall(ConfigSpec cs,
                                              Call call)
                                       throws MediaBindException

Async version of bindToCall.

Parameters:

cs - a ConfigSpec object

call - a Call object

Returns:

an Async.BindToCallEvent for onBindDone();

Throws:

MediaBindException - for preconditions; AlreadyBoundException or BindInProgressException

See Also:

MediaService.bindToCall(javax.telephony.media.ConfigSpec, javax.telephony.Call)

async_bindToServiceName

public Async.BindEvent async_bindToServiceName(ConfigSpec cs,
                                               java.lang.String serviceName)
                                        throws MediaBindException

Async version of bindToServiceName.

Parameters:

cs - a ConfigSpec object

serviceName - a String

Returns:

an Async.BindEvent for onBindDone();

Throws:

MediaBindException - for preconditions; AlreadyBoundException or BindInProgressException

See Also:

MediaService.bindToServiceName(javax.telephony.media.ConfigSpec, java.lang.String)

async_bindToTerminalName

public Async.BindEvent async_bindToTerminalName(ConfigSpec cs,
                                                java.lang.String s1)
                                         throws MediaBindException

Async version of bindToTerminalName.

Parameters:

cs - a ConfigSpec object

s1 - a terminal name String

Returns:

an Async.BindEvent for onBindDone();

Throws:

MediaBindException - for preconditions; AlreadyBoundException or BindInProgressException

See Also:

MediaService.bindToTerminalName(javax.telephony.media.ConfigSpec, java.lang.String)

async_bindToTerminal

public Async.BindEvent async_bindToTerminal(ConfigSpec cs,
                                            Terminal t1)
                                     throws MediaBindException

Async version of bindToTerminal.

Parameters:

cs - a ConfigSpec object

t1 - a JTAPI Terminal object

Returns:

an Async.BindEvent for onBindDone();

Throws:

MediaBindException - for preconditions; AlreadyBoundException or BindInProgressException

See Also:

MediaService.bindToTerminal(javax.telephony.media.ConfigSpec, javax.telephony.Terminal)

async_release

public Async.ReleaseEvent async_release()
                                 throws MediaBindException

Async version of release().

Returns:

an Async.ReleaseEvent for onReleaseDone();

Throws:

MediaBindException - a BindInProgressException

See Also:

MediaService.release()

async_releaseToService

public Async.ReleaseEvent async_releaseToService(java.lang.String serviceName,
                                                 int timeout)
                                          throws MediaBindException

Async version of releaseToService().

Parameters:

serviceName - a String

timeout - an int specifying timeout in milliseconds

Returns:

an Async.ReleaseEvent for onReleaseDone();

Throws:

MediaBindException - a BindInProgressException

See Also:

MediaService.releaseToService(java.lang.String, int)

async_releaseToTag

public Async.ReleaseEvent async_releaseToTag(java.lang.String returnTag)
                                      throws NotBoundException,
                                             MediaBindException

Async version of releaseToTag().

Parameters:

returnTag - a String of tags to match delegated catchTags

Returns:

an Async.ReleaseEvent for onReleaseDone();

Throws:

NotBoundException - if not currently bound to a MediaGroup.

MediaBindException - a BindInProgressException

See Also:

MediaService.releaseToTag(java.lang.String)

async_releaseToDestroy

public Async.ReleaseEvent async_releaseToDestroy()
                                          throws MediaBindException

Async version of releaseToDestroy().

Returns:

an Async.ReleaseEvent for onReleaseDone();

Throws:

MediaBindException - a BindInProgressException

See Also:

MediaService.releaseToDestroy()

async_cancelBindRequest

public Async.Event async_cancelBindRequest()

Initiate a cancelBindRequest(). This method is defined to complete immediately, there is no Listener for the completion of the Event.

Operationally identical to cancelBindRequest(), but returns an event.

Returns:

an Async.Event that is already done().

See Also:

MediaService.cancelBindRequest()

async_configure

public Async.MediaGroupEvent async_configure(ConfigSpec cs)

Async version of MediaService.configure().

Parameters:

cs - a ConfigSpec object

Returns:

a MediaGroupEvent object

See Also:

MediaService.configure(javax.telephony.media.ConfigSpec)

async_getConfiguration

public Async.MediaGroupEvent async_getConfiguration()

Async version of MediaService.getConfiguration().

Returns:

a MediaGroupEvent object

See Also:

MediaService.getConfiguration()

async_getTerminalName

public Async.MediaGroupEvent async_getTerminalName()

Async version of MediaService.getTerminalName().

Returns:

a MediaGroupEvent object

See Also:

MediaService.getTerminalName()

async_getTerminal

public Async.MediaGroupEvent async_getTerminal()

Async version of MediaService.getTerminal().

Returns:

a MediaGroupEvent object

See Also:

MediaService.getTerminal()

async_triggerRTC

public Async.MediaGroupEvent async_triggerRTC(Symbol rtca)

Deprecated. "use transactional Resource commands".

Trigger an RTC action from the application.

Parameters:

rtca - an RTC action Symbol

Returns:

a MediaGroupEvent object

See Also:

MediaService.triggerRTC(javax.telephony.media.Symbol)

async_stop

public Async.MediaGroupEvent async_stop()

Async version of MediaService.stop().

Returns:

a MediaGroupEvent object

See Also:

MediaService.stop()

async_getUserValues

public Async.MediaGroupEvent async_getUserValues(Symbol[] keys)

Async version of MediaService.getUserValues().

Parameters:

keys - an array of Symbols indicating parameters to get

Returns:

a MediaGroupEvent object

See Also:

MediaService.getUserValues(javax.telephony.media.Symbol[])

async_setUserValues

public Async.MediaGroupEvent async_setUserValues(java.util.Dictionary dict)

Async version of MediaService.setUserValues().

Parameters:

dict - a Dictionary of user values

Returns:

a MediaGroupEvent object

See Also:

MediaService.setUserValues(java.util.Dictionary)

async_setUserDictionary

public Async.MediaGroupEvent async_setUserDictionary(java.util.Dictionary dict)

Async version of MediaService.setUserDictionary().

Parameters:

dict - a Dictionary of user values

Returns:

a MediaGroupEvent object

See Also:

MediaService.setUserDictionary(java.util.Dictionary)

async_getParameters

public Async.MediaGroupEvent async_getParameters(Symbol[] keys)

Async version of MediaService.getParameters().

Parameters:

keys - an array of Symbols indicating parameters to get

Returns:

a MediaGroupEvent object

See Also:

MediaService.getParameters(javax.telephony.media.Symbol[])

async_setParameters

public Async.MediaGroupEvent async_setParameters(java.util.Dictionary dict)

Async version of MediaService.setParameters().

Parameters:

dict - a Dictionary of parameters to set

Returns:

a MediaGroupEvent object

See Also:

MediaService.setParameters(java.util.Dictionary)