openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/queue/MessageSourcePollRegistrator.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.openflowplugin.openflow.md.queue;
   9
  10 import java.util.Collection;
  11
  12 /**
  13  * @param <IN> message wrapping type
  14  *
  15  */
  16 public interface MessageSourcePollRegistrator<IN> {
  17
  18     /**
  19      * @param messageSource to read from during processing
  20      * @return closeable registration
  21      */
  22     AutoCloseable registerMessageSource(IN messageSource);
  23
  24     /**
  25      * @param messageSource to be unregistered
  26      * @return true if successfully unregistered
  27      */
  28     boolean unregisterMessageSource(IN messageSource);
  29
  30     /**
  31      * @return collection of registered message sources
  32      */
  33     Collection<IN> getMessageSources();
  34
  35     /**
  36      * @return the harvest handle
  37      */
  38     HarvesterHandle getHarvesterHandle();
  39 }