Merge changes from topic 'BUG-4117'
[openflowplugin.git] / openflowplugin-api / src / main / java / org / opendaylight / openflowplugin / api / openflow / device / XidSequencer.java
1 /*
2  * Copyright (c) 2015 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
9 package org.opendaylight.openflowplugin.api.openflow.device;
10
11 /**
12  * Reserves unique XID for Device Messages.
13  */
14 public interface XidSequencer {
15
16     /**
17      * Method reserve unique XID for Device Message.
18      * Attention: OFJava expect the message, otherwise OutboundQueue could stop working.
19      * @return Reserved XID
20      */
21     Long reserveXidForDeviceMessage();
22 }