Enforce checkstyle and findbug under PCE Api
[bgpcep.git] / pcep / api / src / main / java / org / opendaylight / protocol / pcep / PCEPSessionListener.java
1 /*
2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.protocol.pcep;
9
10 import java.util.EventListener;
11 import javax.annotation.Nonnull;
12 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Message;
13
14 /**
15  * Listener that receives session informations from the session.
16  */
17 public interface PCEPSessionListener extends EventListener {
18     /**
19      * Fired when the session was established successfully.
20      *
21      * @param session Peer address families which we accepted
22      */
23     void onSessionUp(@Nonnull PCEPSession session);
24
25     /**
26      * Fired when the session went down because of an IO error. Implementation should take care of closing underlying
27      * session.
28      *
29      * @param session   that went down
30      * @param exception Exception that was thrown as the cause of session being down
31      */
32     void onSessionDown(@Nonnull PCEPSession session, @Nonnull Exception exception);
33
34     /**
35      * Fired when the session is terminated locally. The session has already been closed and transitioned to IDLE state.
36      * Any outstanding queued messages were not sent. The user should not attempt to make any use of the session.
37      *
38      * @param reason the cause why the session went down
39      */
40     void onSessionTerminated(@Nonnull PCEPSession session, @Nonnull PCEPTerminationReason reason);
41
42     /**
43      * Fired when a normal protocol message is received.
44      *
45      * @param message Protocol message
46      */
47     void onMessage(@Nonnull PCEPSession session, @Nonnull Message message);
48 }