openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/core/connection/MessageListenerWrapper.java

   1 /*
   2  * Copyright (c) 2014 Pantheon Technologies s.r.o. 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
   9 package org.opendaylight.openflowjava.protocol.impl.core.connection;
  10
  11 import io.netty.util.concurrent.Future;
  12 import io.netty.util.concurrent.GenericFutureListener;
  13
  14 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  15
  16 /**
  17  * Wraps outgoing message and includes listener attached to this message. This object
  18  * is sent to OFEncoder. When OFEncoder fails to serialize the message,
  19  * listener is filled with exception. The exception is then delegated to upper ODL layers.
  20  * @author michal.polkorab
  21  */
  22 public class MessageListenerWrapper {
  23
  24     private OfHeader msg;
  25     private GenericFutureListener<Future<Void>> listener;
  26
  27     /**
  28      * @param msg outgoing message
  29      * @param listener listener attached to channel.write(msg) Future
  30      */
  31     public MessageListenerWrapper(Object msg, GenericFutureListener<Future<Void>> listener) {
  32         this.msg = (OfHeader) msg;
  33         this.listener = listener;
  34     }
  35
  36     /**
  37      * @return outgoing message (downstream)
  38      */
  39     public OfHeader getMsg() {
  40         return msg;
  41     }
  42
  43
  44     /**
  45      * @return listener listening on message sending success / failure
  46      */
  47     public GenericFutureListener<Future<Void>> getListener() {
  48         return listener;
  49     }
  50 }