org.asteriskjava.manager.SendEventGeneratingActionCallback Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of asterisk-java Show documentation

The free Java library for Asterisk PBX integration.

The newest version!

package org.asteriskjava.manager;

import org.asteriskjava.manager.response.ManagerError;
import org.asteriskjava.manager.response.ManagerResponse;

/**
 * Callback interface to send
 * {@link org.asteriskjava.manager.action.EventGeneratingAction} asynchronously.
 *
 * @see org.asteriskjava.manager.ManagerConnection#sendEventGeneratingAction(org.asteriskjava.manager.action.EventGeneratingAction, SendEventGeneratingActionCallback)
 * 
 * Initial response is passed to one of {@link #onResponse(ManagerResponse)} or
 * {@link #onErrorResponse(ManagerResponse)}. but not both.
 */
public interface SendEventGeneratingActionCallback {
    /**
     * Called to notify that
     * {@link ManagerConnection#sendEventGeneratingAction(org.asteriskjava.manager.action.EventGeneratingAction, SendEventGeneratingActionCallback)}
     * is done.
     * 
     * If connection is lost before action is completed then
     * {@link ResponseEvents#getResponse()} can be null or list of events might
     * be lacking some events including end event. The
     * {@link ResponseEvents#getResponse()} can also be {@link ManagerError}
     *
     * @param responseEvents the response at whatever state it was when action ended.
     */
    public void onResponse(ResponseEvents responseEvents);
}