opendaylight/commons/protocol-framework/src/main/java/org/opendaylight/protocol/framework/SessionNegotiatorFactory.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 io.netty.channel.Channel;
  11 import io.netty.util.concurrent.Promise;
  12
  13 /**
  14  * A factory class creating SessionNegotiators.
  15  *
  16  * @param <S> session type
  17  */
  18 public interface SessionNegotiatorFactory<M, S extends ProtocolSession<?>, L extends SessionListener<?, ?, ?>> {
  19     /**
  20      * Create a new negotiator attached to a channel, which will notify
  21      * a promise once the negotiation completes.
  22      *
  23      * @param channel Underlying channel
  24      * @param promise Promise to be notified
  25      * @return new negotiator instance
  26      */
  27     SessionNegotiator<S> getSessionNegotiator(SessionListenerFactory<L> factory, Channel channel, Promise<S> promise);
  28 }