framework/src/main/java/org/opendaylight/protocol/framework/ProtocolSession.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.framework;
   9
  10 import java.io.Closeable;
  11
  12 /**
  13  * Protocol Session represents the finite state machine in underlying protocol, including timers and its purpose is to
  14  * create a connection between server and client. Session is automatically started, when TCP connection is created, but
  15  * can be stopped manually. If the session is up, it has to redirect messages to/from user. Handles also malformed
  16  * messages and unknown requests.
  17  *
  18  * This interface should be implemented by a final class representing a protocol specific session.
  19  */
  20 public interface ProtocolSession extends Closeable {
  21
  22         /**
  23          * Starts the session. This method should be used only internally by the Dispatcher.
  24          */
  25         public void startSession();
  26
  27         /**
  28          * Handles incoming message (parsing, reacting if necessary).
  29          *
  30          * @param msg incoming message
  31          */
  32         public void handleMessage(final ProtocolMessage msg);
  33
  34         /**
  35          * Handles malformed message when a deserializer exception occurred. The handling might be different from when a
  36          * documented exception is thrown.
  37          *
  38          * @param e deserializer exception that occurred
  39          */
  40         public void handleMalformedMessage(final DeserializerException e);
  41
  42         /**
  43          * Handles malformed message when a documented exception occurred. The handling might be different from when a
  44          * deserializer exception is thrown.
  45          *
  46          * @param e documented exception that occurred
  47          */
  48         public void handleMalformedMessage(final DocumentedException e);
  49
  50         /**
  51          * Called when reached the end of input stream while reading.
  52          */
  53         public void endOfInput();
  54
  55         /**
  56          * Getter for message factory
  57          *
  58          * @return protocol specific message factory
  59          */
  60         public ProtocolMessageFactory getMessageFactory();
  61
  62         /**
  63          * Returns the maximum message size (in bytes) for purposes of dispatcher buffering -- the dispatcher allocates a
  64          * buffer this big, and if it gets full without making decoding progress, the dispatcher terminates the session.
  65          *
  66          * @return maximum message size
  67          */
  68         public int maximumMessageSize();
  69 }