/*
* TeleStax, Open Source Cloud Communications
* Copyright 2011-2016, TeleStax Inc. and individual contributors
* by the @authors tag.
*
* This program is free software: you can redistribute it and/or modify
* under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation; either version 3 of
* the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* JBoss, Home of Professional Open Source
* Copyright 2007-2011, Red Hat, Inc. and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jdiameter.client.api.io;
import java.util.List;
import org.jdiameter.client.api.IMessage;
/**
* <P>
* An object that registers to be notified of events generated by a
* <code>IConnection</code> object.
* <P>
* The <code>ConnectionListener</code> interface is implemented by a
* PCB component.
*
* @author erick.svenson@yahoo.com
* @author <a href="mailto:brainslog@gmail.com"> Alexandre Mendonca </a>
* @author <a href="mailto:baranowb@gmail.com"> Bartosz Baranowski </a>
*/
public interface IConnectionListener {
/**
* Notifies that connection is created
* @param connKey identifier of created connection
*/
void connectionOpened(String connKey);
/**
* Notifies that connection is closed
* @param connKey identifier of closed connection
* @param notSended array of not sended messages
*/
void connectionClosed(String connKey, List notSended);
/**
* Notifies that connection is received incoming message
* @param connKey identifier of connection
* @param message received incoming message
*/
void messageReceived(String connKey, IMessage message);
/**
* Notifies that connection is generated excpetion
* @param connKey identifier of connection
* @param message the message from that failed
* @param cause generated exceptions
*/
void internalError(String connKey, IMessage message, TransportException cause);
}