org.asteriskjava.live.AsteriskServerListener Maven / Gradle / Ivy

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.

There is a newer version: 3.40.1

package org.asteriskjava.live;

import org.asteriskjava.live.internal.AsteriskAgentImpl;

/**
 * You can register an AsteriskServerListener with an
 * {@link org.asteriskjava.live.AsteriskServer} to be notified about new
 * channels and MeetMe users.
 * 
 * Usually it is better to extend {@link AbstractAsteriskServerListener} than to
 * implement this interface directly as additonal methods will probably be added
 * in future versions of Asterisk-Java.
 * 
 * @author srt
 * @version $Id: AsteriskServerListener.java 958 2008-02-02 23:19:43Z srt $
 * @since 0.3
 */
public interface AsteriskServerListener
{
    /**
     * Called whenever a new channel appears on the Asterisk server.
     * 
     * @param channel the new channel.
     */
    void onNewAsteriskChannel(AsteriskChannel channel);

    /**
     * Called whenever a user joins a {@link MeetMeRoom}.
     * 
     * @param user the user that joined.
     */
    void onNewMeetMeUser(MeetMeUser user);

    /**
     * Called whenever a new agent will be registered at Asterisk server.
     * 
     * @param agent
     */
    void onNewAgent(AsteriskAgentImpl agent);
    
    /**
     * Called whenever a queue entry ( ~ wapper over channel) joins a {@link AstriskQueue}.
     * 
     * @param entry the queue entry that joined.
     */
    void onNewQueueEntry(AsteriskQueueEntry entry);
}