pcep/api/src/main/java/org/opendaylight/protocol/pcep/PCEPSession.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 org.opendaylight.protocol.framework.ProtocolSession;
  11 import org.opendaylight.protocol.pcep.object.PCEPCloseObject;
  12 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Message;
  13
  14 /**
  15  * PCEP Session represents the finite state machine in PCEP, including timers and its purpose is to create a PCEP
  16  * connection between PCE/PCC. Session is automatically started, when TCP connection is created, but can be stopped
  17  * manually. If the session is up, it has to redirect messages to/from user. Handles also malformed messages and unknown
  18  * requests.
  19  */
  20 public interface PCEPSession extends ProtocolSession<Message> {
  21
  22         /**
  23          * Sends message from user to PCE/PCC. If the user sends an Open Message, the session returns an error (open message
  24          * is only allowed, when a PCEP handshake is in progress). Close message will close the session and free all the
  25          * resources.
  26          *
  27          * @param message message to be sent
  28          */
  29         public void sendMessage(Message message);
  30
  31         public void close(PCEPCloseObject.Reason reason);
  32 }