Fix table miss flow push
[openflowplugin.git] / openflowplugin-api / src / main / java / org / opendaylight / openflowplugin / api / openflow / md / queue / QueueProcessor.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.api.openflow.md.queue;
9
10 import java.util.Collection;
11 import java.util.List;
12 import java.util.Map;
13 import org.opendaylight.openflowplugin.api.openflow.md.core.IMDMessageTranslator;
14 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
15
16 /**
17  * This processing mechanism based on queue. Processing consists of 2 steps: translate and publish.
18  * Proposed workflow (might slightly deviate in implementations):
19  * <ol>
20  * <li>messages of input type are pushed in (via {@link QueueKeeper#push(Object, org.opendaylight.openflowplugin.api.openflow.md.core.ConnectionConductor, org.opendaylight.openflowplugin.api.openflow.md.queue.QueueKeeper.QueueType)} and similar)</li>
21  * <li>ticket (executable task) is build upon each pushed message and enqueued</li>
22  * <li>ticket is translated using appropriate translator</li>
23  * <li>ticket is dequeued and result is published by appropriate popListener</li>
24  * </ol>
25  * Message order might be not important, e.g. when speed is of the essence
26  * @param <I> source type (IN)
27  * @param <O> result type (OUT)
28  */
29 public interface QueueProcessor<I, O> extends MessageSourcePollRegistrator<QueueKeeper<I>>, Enqueuer<QueueItem<I>> {
30
31     /**
32      * @param translatorMapping translators for message processing
33      */
34     void setTranslatorMapping(Map<TranslatorKey, Collection<IMDMessageTranslator<I, List<O>>>> translatorMapping);
35
36     /**
37      * @param popListenersMapping listeners invoked when processing done
38      */
39     void setPopListenersMapping(Map<Class<? extends O>, Collection<PopListener<O>>> popListenersMapping);
40 }