openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/device/RequestContext.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 package org.opendaylight.openflowplugin.api.openflow.device;
   9
  10 import javax.annotation.Nullable;
  11
  12 /**
  13  * Request context handles all requests on device. Number of requests is limited by request quota. When this quota is
  14  * exceeded all rpc's will end up with exception.
  15  * <p>
  16  * Created by Martin Bobak &lt;mbobak@cisco.com&gt; on 25.2.2015.
  17  */
  18 public interface RequestContext<T> extends RequestFutureContext<T>, AutoCloseable {
  19     /**
  20      * Returns XID generated for this request.
  21      *
  22      * @return Allocated XID, or null if the device has disconnected.
  23      */
  24     @Nullable Xid getXid();
  25
  26     @Override
  27     void close();
  28
  29     /**
  30      * Returns request timeout value.
  31      *
  32      * @return
  33      */
  34     long getWaitTimeout();
  35
  36     /**
  37      * Sets request timeout value.
  38      */
  39     void setWaitTimeout(long waitTimeout);
  40 }